Check-in [f1c59a3a0d]
Overview
Comment:Updated man page
Downloads: Tarball | ZIP archive | SQL archive
Timelines: family | ancestors | descendants | both | trunk
Files: files | file ages | folders
SHA1:f1c59a3a0d89b2f8ba91854d915d7d0bf0da73ff
User & Date: rkeene on 2014-02-07 20:43:52
Other Links: manifest | tags
Context
2014-02-07
21:06
Added install target check-in: 13b69230ce user: rkeene tags: trunk
20:43
Updated man page check-in: f1c59a3a0d user: rkeene tags: trunk
2014-02-06
23:35
Added usage information check-in: a67c46369b user: rkeene tags: trunk
Changes

Modified filed.1 from [957f2aad04] to [fae93fba37].

     1      1   .PU
     2      2   .TH FILED 1 "06 Feb 14" "filed 1.0"
     3      3   .SH NAME
     4      4   filed \- serve files over HTTP
     5      5   .SH SYNOPSIS
     6      6   .ll +10
     7      7   .B filed
     8         -.RB [ "\-h" ]
     9         -.RB [ \-p\ port ]
    10         -.RB [ \-t\ counts ]
    11         -.RB [ \-c\ entries ]
            8  +.RB [{ \-h | \-\-help }]
            9  +.RB [{ \-b | \-\-bind }
           10  +.IR address ]
           11  +.RB [{ \-p | \-\-port }
           12  +.IR port ]
           13  +.RB [{ \-t | \-\-threads }
           14  +.IR count ]
           15  +.RB [{ \-c | \-\-cache }
           16  +.IR entries ]
           17  +.RB [{ \-u | \-\-user }
           18  +.IR user ]
           19  +.RB [{ \-r | \-\-root }
           20  +.IR directory ]
           21  +
    12     22   .ll -10
    13     23   .SH DESCRIPTION
    14     24   .I FILED
    15     25   serves files over HTTP as minimally as possible.  Only static files (i.e., files that never change or are replaced) are supported.
    16     26   
    17     27   .SH OPTIONS
    18     28   .TP
    19         -.B \-p
    20         -port
           29  +.B -h (or --help)
           30  +Prints detailed usage information
           31  +
           32  +.TP
           33  +.B -b (or --bind)
           34  +Specifies the address to listen for incoming HTTP
           35  +requests on.
           36  +
           37  +.TP
           38  +.B -p (or --port)
           39  +Specifies the TCP port number to listen for incoming HTTP
           40  +requests on.
           41  +
           42  +.TP
           43  +.B -t (or --threads)
           44  +Specifies the number of worker threads to create. Each
           45  +worker thread can service one concurrent HTTP session.
           46  +Thus the number of threads created will determine how
           47  +many simultaneous transfers will be possible.
           48  +
           49  +.TP
           50  +.B -c (or --cache)
           51  +Specifies the number of file information cache entries
           52  +to allocate.  Each cache entry holds file information as
           53  +well as an open file descriptor to the file, so resource
           54  +limits (i.e., ulimit) should be considered.  This should
           55  +be a prime number for ideal use with the lookup method.
           56  +
           57  +.TP
           58  +.B -u (or --user)
           59  +Specifies the user to switch user IDs to before servicing
           60  +requests.  The default is not change user IDs.
           61  +
           62  +.TP
           63  +.B -r (or --root)
           64  +Specifies the directory to act as the root directory for
           65  +the file server.  If this option is specified, chroot(2)
           66  +is called.  The default is not change root directories,
           67  +that is, the "/" directory is shared out.  This will
           68  +likely be a security issue, so this option should always
           69  +be used.
    21     70   
    22     71   .SH AUTHOR
    23     72   .Sp
    24     73   Roy Keene
    25     74   .I <filed@rkeene.org>