.TH "chirp" 1 "" "CCTools 7.1.2 FINAL" "Cooperative Computing Tools"

.SH NAME
.LP
\fBchirp\fP - command line tool providing explicit control of a Chirp server.

.SH SYNOPSIS
.LP
\FC\fBchirp [options] [hostname] [command]\fP\FT

.SH DESCRIPTION
.LP

\fBchirp\fP is a tool to connect and manage a Chirp server in a similar way to an FTP client.  \fBchirp\fP allows connecting to a Chirp server, copying files, and managing directories, auditing node etc...
.PP
Here are some important  \fBchirp\fP commands:


.IP \(bu 4
\fBopen\fP <host> Connect to a Chirp server.
.IP \(bu 4
\fBclose\fP Close connection to current Chirp server.  
.IP \(bu 4
\fBget\fP <remotefile> [localfile] Copy a remote file to local storage.
.IP \(bu 4
\fBput\fP <localfile> [remotefile] Copy a local file to Chirp server.
.IP \(bu 4
\fBthirdput\fP <file> <3rdhost> <3rdfile> Copy a remote file to another Chirp server.
.IP \(bu 4
\fBgetacl\fP <remotepath> Get acl of a remote file/directory.
.IP \(bu 4
\fBsetacl\fP <remotepath> <user> <rwldax> Set acl for a remote file/directory.
.IP \(bu 4
\fBls\fP [-la] [remotepath] List contents of a remote directory.
.IP \(bu 4
\fBmv\fP <oldname> <newname> Change name of a remote file.
.IP \(bu 4
\fBrm\fP <file> Delete a remote file.
.IP \(bu 4
\fBaudit\fP	[-r] Audit current Chirp server.
.IP \(bu 4
\fBexit\fP Close connection and exit \fBChirp\fP.


\fBchirp\fP also manages Chirp tickets for authentication purpose.


.IP \(bu 4
\fBticket_create\fP [-o[utput] <ticket filename>] [-s[ubject] <subject/user>] [-d[uration] <duration>] [-b[its] <bits>] [[<directory> <acl>] ...] Creat a ticket
.IP \(bu 4
\fBticket_register\fP <name> [<subject>] <duration> Manually register a ticket with multiple Chirp severs.
.IP \(bu 4
\fBticket_delete\fP <name> Remove a ticket.
.IP \(bu 4
\fBticket_list\fP <name> List registered tickets on a Chirp server.
.IP \(bu 4
\fBticket_get\fP <name> Check status of a ticket.
.IP \(bu 4
\fBticket_modify\fP <name> <directory> <aclmask> Modify a ticket.


.SH OPTIONS
.LP
.LP
.TP
\fB-a\fP, \fB-\-auth\fP=\fI<flag>\fP
.
Require this authentication mode.
.TP
\fB-d\fP, \fB-\-debug\fP=\fI<flag>\fP
.
Enable debugging for this subsystem.
.TP
\fB-i\fP, \fB-\-tickets\fP=\fI<files>\fP
.
Comma-delimited list of tickets to use for authentication.
.TP
.B \ -l, --verbose
.
Long transfer information.
.TP
\fB-t\fP, \fB-\-timeout\fP=\fI<time>\fP
.
Set remote operation timeout.
.TP
.B \ -v, --version
.
Show program version.
.TP
.B \ -h, --help
.
Show help text.


.SH ENVIRONMENT VARIABLES
.LP


.IP \(bu 4
\FC\fBCHIRP_CLIENT_TICKETS\fP\FT Comma delimited list of tickets to authenticate with (same as \FC-i\FT).


.SH EXIT STATUS
.LP
On success, returns zero.  On failure, returns non-zero.

.SH EXAMPLES
.LP

To conenct to a Chirp server using \fBchirp\fP:

.fam C
.nf
.nh
.IP "" 8
% chirp server1.somewhere.edu
chirp> (enter more commands here)
.fi
.hy
.fam
.P

To copy a single local file using \fBchirp\fP:

.fam C
.nf
.nh
.IP "" 8
% chirp server1.somewhere.edu put /tmp/mydata.dat /mydata/mydata.dat
.fi
.hy
.fam
.P

To get a single remote file using \fBchirp\fP:

.fam C
.nf
.nh
.IP "" 8
% chirp server1.somewhere.edu get /mydata/mydata.dat /tmp/mydata.dat
.fi
.hy
.fam
.P

To create a ticket using:

.fam C
.nf
.nh
.IP "" 8
% chirp server1.somewhere.edu get ticket_create -output myticket.ticket -subject unix:user -bits 1024 -duration 86400 / rl /foo rwl
.fi
.hy
.fam
.P

To register a ticket with other Chirp servers:

.fam C
.nf
.nh
.IP "" 8
% chirp server2.somewhere.edu ticket_register myticket.ticket unix:user 86400
.fi
.hy
.fam
.P

To delete a ticket:

.fam C
.nf
.nh
.IP "" 8
% chirp server1.somewhere.edu ticket_delete myticket.ticket
.fi
.hy
.fam
.P


.SH COPYRIGHT
.LP

The Cooperative Computing Tools are Copyright (C) 2005-2019 The University of Notre Dame.  This software is distributed under the GNU General Public License.  See the file COPYING for details.

.SH SEE ALSO
.LP


.IP \(bu 4
\fBCooperative Computing Tools Documentation\fP
.IP \(bu 4
\fBChirp User Manual\fP
.IP \(bu 4
\fBchirp(1)\fP  \fBchirp_status(1)\fP  \fBchirp_fuse(1)\fP  \fBchirp_get(1)\fP  \fBchirp_put(1)\fP  \fBchirp_stream_files(1)\fP  \fBchirp_distribute(1)\fP  \fBchirp_benchmark(1)\fP  \fBchirp_server(1)\fP