Extended manpage

This commit is contained in:
Sebastian Lohff 2012-04-27 04:30:53 +02:00
parent 4bfb5b92f8
commit 1ebd3f0eea
1 changed files with 19 additions and 0 deletions

View File

@ -32,6 +32,12 @@ For SSL support python-openssl (pyssl) needs to be installed. If no key and
cert is given, servefile will generate a keypair for you and display its cert is given, servefile will generate a keypair for you and display its
fingerprint. fingerprint.
In \fB--tar\fR mode the given file or directory will be on the fly and on
request packed and, through the HTTP connection, piped to the client. Tar files
will be created only containing the top directory given to servefile, so using
path/to/dir/ as \fIfile/directory\fR argument will create a tar file starting
with the dir/ directory. Symlinks will not be dereferenced.
.SH COMMAND SUMMARY .SH COMMAND SUMMARY
.SS "positional arguments:" .SS "positional arguments:"
.TP .TP
@ -72,6 +78,15 @@ Certfile to use for SSL
.TP .TP
\fB\-a\fR user:password, \fB\-\-auth\fR user:password \fB\-a\fR user:password, \fB\-\-auth\fR user:password
Set user and password for HTTP basic authentication Set user and password for HTTP basic authentication
.TP
\fB\-t\fR, \fB\-\-tar\fR
Enable on the fly tar creation for given file or
directory. Note: Download continuation will not be
available.
.TP
\fB\-c\fR method, \fB\-\-compression\fR method
Set compression method, only in combination with
\fB\-\-tar\fR. Can be one of none, gzip, bzip2.
.SH EXAMPLES .SH EXAMPLES
Serving a single file with SSL and HTTP Basic auth: Serving a single file with SSL and HTTP Basic auth:
.IP .IP
@ -87,5 +102,9 @@ Uploading file foo as bar to servefile via command line:
curl \-X POST http://ip:port/bar \-d @foo curl \-X POST http://ip:port/bar \-d @foo
wget http://ip:port/bar \-\-post-file=foo wget http://ip:port/bar \-\-post-file=foo
.PP .PP
serving a on the fly generated tar.gz file of a directory:
.IP
servefile --tar -c gzip path/to/dir
.PP
.SH AUTHOR .SH AUTHOR
servefile is developed by Sebastian Lohff <seba@someserver.de> servefile is developed by Sebastian Lohff <seba@someserver.de>