[gnutls-dev] Manpages

[Ivo Timmermans]

Hi,

I created four simple manpages for the command line utilities that are
distributed alongside gnutls: gnutls-cli, gnutls-cli-debug,
gnutls-serv and gnutls-srpcrypt.  It would be nice if they were
distributed together with these utilities.


	Ivo

-- 
Deja moo: the feeling you've heard this bullshit before.
-------------- next part --------------
.TH gnutls\-cli 1 "October 26th 2003"
.SH NAME
gnutls\-cli \- GNU TLS test client
.SH SYNOPSIS
gnutls\-cli [\fIoptions\fR] \fIhostname\fI
.SH DESCRIPTION
Simple client program to set up a TLS connection to some other
computer.
.SH OPTIONS
.IP "\-r, \-\-resume"
Connect, establish a session.  Connect again and resume this session.
.IP "\-s, \-\-starttls"
Connect, establish a plain session and start TLS when EOF is sent from
the keyboard.
.IP "\-\-crlf"
Send CR LF instead of LF.
.IP "\-\-x509fmtder"
Use DER format for certificates
.IP "\-f, \-\-fingerprint"
Send the openpgp fingerprint, instead of the key.
.IP "\-\-xml"
Print the certificate information in XML format.
.IP "\-p, \-\-port \fIinteger\fR"
The port to connect to.
.IP "\-\-recordsize \fIinteger\fR"
The maximum record size to advertize.
.IP "\-\-ciphers \fIcipher1 cipher2...\fR"
Ciphers to enable.
.IP "\-\-protocols \fIprotocol1 protocol2...\fR"
Protocols to enable.
.IP "\-\-comp \fIcomp1 comp2...\fR"
Compression methods to enable.
.IP "\-\-macs \fImac1 mac2...\fR"
MACs to enable.
.IP "\-\-kx \fIkx1 kx2...\fR"
Key exchange methods to enable.
.IP "\-\-ctypes \fIcertType1 certType2...\fR"
Certificate types to enable.
.IP "\-\-x509cafile \fIFILE\fR"
Certificate file to use.
.IP "\-\-pgpkeyfile \fIFILE\fR"
PGP Key file to use.
.IP "\-\-pgpkeyring \fIFILE\fR"
PGP Key ring file to use.
.IP "\-\-pgptrustdb \fIFILE\fR"
PGP trustdb file to use.
.IP "\-\-pgpcertfile \fIFILE\fR"
PGP Public Key (certificate) file to use.
.IP "\-\-x509keyfile \fIFILE\fR"
X.509 key file to use.
.IP "\-\-x509certfile \fIFILE\fR"
X.509 Certificate file to use.
.IP "\-\-srpusername \fINAME\fR"
SRP username to use.
.IP "\-\-srppasswd \fIPASSWD\fR"
SRP password to use.
.IP "\-l, \-\-list"
Print a list of the supported algorithms and modes.
.IP "\-h, \-\-help"
Prints a short reminder of the command line options.
.IP "\-v, \-\-version"
Prints the program's version number.
.IP "\-\-copyright"
Prints the program's license.
.SH "SEE ALSO"
.BR gnutls\-cli\-debug (1),
.BR gnutls\-serv (1)
.SH AUTHOR
.PP
Nikos Mavroyanopoulos <nmav at gnutls.org> and others; see
/usr/share/doc/gnutls\-bin/AUTHORS for a complete list.
.PP
This manual page was written by Ivo Timmermans <ivo at debian.org>, for
the Debian GNU/Linux system (but may be used by others).
-------------- next part --------------
.TH gnutls\-cli\-debug 1 "October 26th 2003"
.SH NAME
gnutls\-cli\-debug \- GNU TLS test client, with verbose output
.SH SYNOPSIS
gnutls\-cli\-debug [\fIoptions\fR] \fIhostname\fI
.SH DESCRIPTION
Simple client program to set up a TLS connection to some other
computer.  Like
.BR gnutls\-cli (1),
it sets up a TLS connection and forwards data from the standard input
to the socket.  Any information about the TLS control connection is
printed to standard error.
.SH OPTIONS
.IP "\-p, \-\-port \fIinteger\fR"
The port to connect to.
.IP "\-v, \-\-verbose"
Even more verbose output.
.IP "\-h, \-\-help"
Prints a short reminder of the command line options.
.SH "SEE ALSO"
.BR gnutls\-cli (1),
.BR gnutls\-serv (1)
.SH AUTHOR
.PP
Nikos Mavroyanopoulos <nmav at gnutls.org> and others; see
/usr/share/doc/gnutls-bin/AUTHORS for a complete list.
.PP
This manual page was written by Ivo Timmermans <ivo at debian.org>, for
the Debian GNU/Linux system (but may be used by others).
-------------- next part --------------
.TH gnutls\-serv 1 "October 26th 2003"
.SH NAME
gnutls\-serv \- GNU TLS test server
.SH SYNOPSIS
gnutls\-serv [\fIoptions\fR]
.SH DESCRIPTION
Simple server program that listens to incoming TLS connections.
.SH OPTIONS
.IP "\-g, \-\-generate"
Generate Diffie Hellman Parameters.
.IP "\-p, \-\-port \fIinteger\fR"
The port to connect to.
.IP "\-q, \-\-quiet"
Suppress some messages.
.IP "\-\-nodb"
Does not use the resume database.
.IP "\-\-http"
Act as an HTTP Server.
.IP "\-\-echo"
Act as an Echo Server.
.IP "\-\-x509fmtder"
Use DER format for certificates
.IP "\-\-x509cafile \fIFILE\fR"
Certificate file to use.
.IP "\-\-pgpkeyring \fIFILE\fR"
PGP Key ring file to use.
.IP "\-\-pgptrustdb \fIFILE\fR"
PGP trustdb file to use.
.IP "\-\-pgpkeyfile \fIFILE\fR"
PGP Key file to use.
.IP "\-\-pgpcertfile \fIFILE\fR"
PGP Public Key (certificate) file to use.
.IP "\-\-x509keyfile \fIFILE\fR"
X.509 key file to use.
.IP "\-\-x509certfile \fIFILE\fR"
X.509 Certificate file to use.
.IP "\-\-srppasswd \fIFILE\fR"
SRP password file to use.
.IP "\-\-srppasswdconf \fIFILE\fR"
SRP password configuration file to use.
.IP "\-\-ciphers \fIcipher1 cipher2...\fR"
Ciphers to enable.
.IP "\-\-protocols \fIprotocol1 protocol2...\fR"
Protocols to enable.
.IP "\-\-comp \fIcomp1 comp2...\fR"
Compression methods to enable.
.IP "\-\-macs \fImac1 mac2...\fR"
MACs to enable.
.IP "\-\-kx \fIkx1 kx2...\fR"
Key exchange methods to enable.
.IP "\-\-ctypes \fIcertType1 certType2...\fR"
Certificate types to enable.
.IP "\-l, \-\-list"
Print a list of the supported algorithms and modes.
.IP "\-h, \-\-help"
prints this help
.IP "\-v, \-\-version"
prints the program's version number
.IP "\-\-copyright"
prints the program's license
.SH "SEE ALSO"
.BR gnutls\-cli (1),
.BR gnutls\-cli\-debug (1)
.SH AUTHOR
.PP
Nikos Mavroyanopoulos <nmav at gnutls.org> and others; see
/usr/share/doc/gnutls\-bin/AUTHORS for a complete list.
.PP
This manual page was written by Ivo Timmermans <ivo at debian.org>, for
the Debian GNU/Linux system (but may be used by others).
-------------- next part --------------
.TH gnutls\-srpcrypt 1 "October 26th 2003"
.SH NAME
gnutls\-srpcrypt \- Simple SRP password tool
.SH SYNOPSIS
gnutls\-srpcrypt [\fIoptions\fR]
.SH DESCRIPTION
SRP (Secure Remote Password) utility using GNU TLS.
.SH OPTIONS
.IP "\-u, \-\-username \fIusername\fR"
Specify username.
.IP "\-p, \-\-passwd \fIFILE\fR"
Specify a password file.
.IP "\-i, \-\-index \fIINDEX\fR"
Specify the index of the parameters in tpasswd.conf to use.
.IP "\-s, \-\-salt \fISALT\fR"
Specify salt/cost size for crypt algorithm.
.IP "\-\-verify"
Just verify password.
.IP "\-\-passwd\-conf \fIFILE\fR"
Specify a password configuration file.
.IP "\-\-create\-conf \fIFILE\fR"
Generate a tpasswd.conf file.
.IP "\-\-bits \fIBITS\fR"
specify the number of bits for prime numbers (used only when the
\fB\-\-create\-conf\fR option is used).
.IP "\-h, \-\-help"
Prints a short reminder of the command line options.
.SH AUTHOR
.PP
Nikos Mavroyanopoulos <nmav at gnutls.org> and others; see
/usr/share/doc/gnutls\-bin/AUTHORS for a complete list.
.PP
This manual page was written by Ivo Timmermans <ivo at debian.org>, for
the Debian GNU/Linux system (but may be used by others).