pandorafms/pandora_agents/unix/man/man1/tentacle_client.1

210 lines
7.1 KiB
Groff

.\" Automatically generated by Pod::Man 2.1801 (Pod::Simple 3.05)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings. \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote. \*(C+ will
.\" give a nicer C++. Capital omega is used to do unbreakable dashes and
.\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
. ds -- \(*W-
. ds PI pi
. if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
. if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch
. ds L" ""
. ds R" ""
. ds C` ""
. ds C' ""
'br\}
.el\{\
. ds -- \|\(em\|
. ds PI \(*p
. ds L" ``
. ds R" ''
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el .ds Aq '
.\"
.\" If the F register is turned on, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD. Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.ie \nF \{\
. de IX
. tm Index:\\$1\t\\n%\t"\\$2"
..
. nr % 0
. rr F
.\}
.el \{\
. de IX
..
.\}
.\"
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear. Run. Save yourself. No user-serviceable parts.
. \" fudge factors for nroff and troff
.if n \{\
. ds #H 0
. ds #V .8m
. ds #F .3m
. ds #[ \f1
. ds #] \fP
.\}
.if t \{\
. ds #H ((1u-(\\\\n(.fu%2u))*.13m)
. ds #V .6m
. ds #F 0
. ds #[ \&
. ds #] \&
.\}
. \" simple accents for nroff and troff
.if n \{\
. ds ' \&
. ds ` \&
. ds ^ \&
. ds , \&
. ds ~ ~
. ds /
.\}
.if t \{\
. ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
. ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
. ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
. ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
. ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
. ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
.\}
. \" troff and (daisy-wheel) nroff accents
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
.ds ae a\h'-(\w'a'u*4/10)'e
.ds Ae A\h'-(\w'A'u*4/10)'E
. \" corrections for vroff
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
. \" for low resolution devices (crt and lpr)
.if \n(.H>23 .if \n(.V>19 \
\{\
. ds : e
. ds 8 ss
. ds o a
. ds d- d\h'-1'\(ga
. ds D- D\h'-1'\(hy
. ds th \o'bp'
. ds Th \o'LP'
. ds ae ae
. ds Ae AE
.\}
.rm #[ #] #H #V #F C
.\" ========================================================================
.\"
.IX Title "TENTACLE_CLIENT 1"
.TH TENTACLE_CLIENT 1 "2010-02-16" "perl v5.10.0" "User Contributed Perl Documentation"
.\" For nroff, turn off justification. Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
tentacle_client \- Tentacle Client
.SH "VERSION"
.IX Header "VERSION"
Version 0.2.0
.SH "USAGE"
.IX Header "USAGE"
tentacle_client [options] [file] [file] ...
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
\&\fB\f(BItentacle_client\fB\|(1)\fR is a client for \fBtentacle\fR, a \fBclient/server\fR file transfer protocol that aims to be:
.IP "\(bu" 4
Secure by design.
.IP "\(bu" 4
Easy to use.
.IP "\(bu" 4
Versatile and cross-platform.
.PP
Tentacle was created to replace more complex tools like \s-1SCP\s0 and \s-1FTP\s0 for simple file transfer/retrieval, and switch from authentication mechanisms like .netrc, interactive logins and \s-1SSH\s0 keys to X.509 certificates. Simple password authentication over a \s-1SSL\s0 secured connection is supported too.
.PP
The client and server (\fB\s-1TCP\s0 port 41121\fR) are designed to be run from the command line or called from a shell script, and \fBno configuration files are needed\fR.
.SH "OPTIONS"
.IX Header "OPTIONS"
.IP "\fI\-a address\fR \fBServer address\fR (default 127.0.0.1)." 4
.IX Item "-a address Server address (default 127.0.0.1)."
.PD 0
.IP "\fI\-c\fR Enable \fB\s-1SSL\s0\fR without a client certificate." 4
.IX Item "-c Enable SSL without a client certificate."
.IP "\fI\-e cert\fR \fBOpenSSL certificate\fR file. Enables \s-1SSL\s0." 4
.IX Item "-e cert OpenSSL certificate file. Enables SSL."
.IP "\fI\-f ca\fR Verify that the peer certificate is signed by a \fB\s-1CA\s0\fR (Certificate Authority)." 4
.IX Item "-f ca Verify that the peer certificate is signed by a CA (Certificate Authority)."
.IP "\fI\-g\fR \fBGet\fR files from the server." 4
.IX Item "-g Get files from the server."
.IP "\fI\-h\fR Show \fBhelp\fR." 4
.IX Item "-h Show help."
.IP "\fI\-k key\fR \fBOpenSSL private key\fR file." 4
.IX Item "-k key OpenSSL private key file."
.IP "\fI\-p port\fR \fBServer port\fR (default \fI41121\fR)." 4
.IX Item "-p port Server port (default 41121)."
.IP "\fI\-q\fR \fBQuiet\fR. Do now print error messages." 4
.IX Item "-q Quiet. Do now print error messages."
.IP "\fI\-r number\fR \fBNumber of retries\fR for network operations (default \fI3\fR)." 4
.IX Item "-r number Number of retries for network operations (default 3)."
.IP "\fI\-t time\fR \fBTime-out\fR for network operations in seconds (default \fI1s\fR)." 4
.IX Item "-t time Time-out for network operations in seconds (default 1s)."
.IP "\fI\-v\fR Be \fBverbose\fR." 4
.IX Item "-v Be verbose."
.IP "\fI\-w\fR Prompt for \fBOpenSSL private key password\fR." 4
.IX Item "-w Prompt for OpenSSL private key password."
.IP "\fI\-x pwd\fR \fBServer password\fR." 4
.IX Item "-x pwd Server password."
.PD
.SH "EXIT STATUS"
.IX Header "EXIT STATUS"
.IP "0 on Success" 4
.IX Item "0 on Success"
.PD 0
.IP "1 on Error" 4
.IX Item "1 on Error"
.PD
.SH "CONFIGURATION"
.IX Header "CONFIGURATION"
Tentacle doesn't use any configurationf files, all the configuration is done by the options passed when it's started.
.SH "DEPENDENCIES"
.IX Header "DEPENDENCIES"
Getopt::Std, IO::Select, IO::Socket::INET, File::Basename
.SH "LICENSE"
.IX Header "LICENSE"
This is released under the \s-1GNU\s0 Lesser General Public License.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
Getopt::Std, IO::Select, IO::Socket::INET, File::Basename
.PP
Protocol description and more info at: <http://openideas.info/wiki/index.php?title=Tentacle>
.SH "COPYRIGHT"
.IX Header "COPYRIGHT"
Copyright (c) 2005\-2010 Artica Soluciones Tecnologicas S.L