Re: [RFR] templates://webfs/{templates}
Christian PERRIER wrote:
> Your review should be sent as an answer to this mail.
(The mail problems I was having at the weekend turned out to be at
the edlug end; they seem to be fixed now.)
> Template: webfsd/web_ip
> Type: string
> -_Description: IP address webfsd should listen on:
> - If your box has more than one IP address, you can pick one here for webfsd.
> - Leaving this field blank will allow webfsd to listen on all IP addresses.
> +_Description: IP address webfsd should listen to:
> + When multiple IP addresses are used, webfsd can be configured to
> + listen to only one of them.
"Are used" could mean by webfs; stick to something closer to the
original, like "On a system with multiple IP addresses".
> + .
> + If you leave this empty, webfsd will listen to all IP addresses.
>
> I'm not really sure here. "listen on" or "listen to"?
"Listen on (an address)" seems to be the accepted idiom.
> Template: webfsd/web_conn
[...]
> + For private and small
> + networks, the default number of parallel network connections should
> + be fine. This can be increased for larger networks.
Unless we mean "both private networks of any size and small ones of
any type" I would recommend just "For small private networks".
> Template: webfsd/web_virtual
[...]
> +_Description: Enable virtual host?
> Please choose this option if you want webfsd support name-based
> + virtual hosts. The first directory level below the web server's document root
> will then be used as hostname.
If you want webfsd ^to^ support it - or if your boss insists! And
presumably the multiple vhosts have a directory/hostname each. Oh,
and "the web server's document root" seems redundant, given that web
servers are the only things I know of that have docroots. So:
This option allows webfsd to support name-based virtual hosts, taking
the directories immediately below the document root as hostnames.
> Template: webfsd/web_root
> Type: string
> Default: /var/ftp
(Obligatory outside-my-jurisdiction nitpick: doesn't the FHS
advocate /srv/ftp these days?)
> _Description: Document root for webfsd:
> + Webfsd is a lightweight HTTP server which only serves static files.
> + That may be useful to provide basic HTTP access to an anonymous FTP
> + server, for instance.
Updating this to match the current package description:
Webfsd is a lightweight HTTP server for mostly static content. Its
most obvious use is to provide HTTP access to an anonymous FTP server.
> Template: webfsd/web_syslog
> Type: boolean
> Default: false
> +_Description: Log webfsd events (start/stop/...) to syslog?
That "(foo/bar/...)" idiom isn't common in English, but it does
occur in CLI prompts, so you can get away with it here.
> Template: webfsd/web_accesslog
> Type: string
> _Description: Access log file:
> + Accesses to webfsd can be logged in common log format.
Access
For some reason this feels more natural treated as uncountable
"stuff" rather than plural "things".
> Template: webfsd/web_extras
> Type: string
> _Description: Extra options to include:
> + Please specify any webfsd option you want to use with the main
> + daemon.
> + .
> + This allows, for instance, to specify the use of a chrooted service,
> + timed expiration of files, and locked binding to
> + either IPv6 or IPv4.
Oh, it's my old friend "this allows to". Disallowed!
"Locked binding" sounds like something you'd find on a tome of
forbidden knowledge. Does it mean anything more than "binding"?
For instance, webfsd can run chrooted, provide timed expiration of
files, and bind either IPv4 or IPv6 addresses.
> + .
> + Please check webfsd manual page for more details.
^'s
or indeed:
See webfsd's manual page for details.
> --- webfs.old/debian/control 2010-02-03 21:27:50.000000000 +0100
> +++ webfs/debian/control 2010-02-20 14:40:11.580999397 +0100
> +Description: lightweight HTTP server for static content
> - This is a simple http server for mostly static content. You
> + This package provides a simple HTTP server for static content.
_Mostly_ static. Though if I'm going to put that back, the caveats
should go here too:
This package provides a simple web server for mostly static content,
with limited CGI support (GET requests only).
> - can use it to serve the content of a ftp server via http for
> - example. It is also nice to export some files the quick way
> - by starting a http server in a few seconds, without editing
> - some config file first. Limited cgi support (GET requests
> - only) has been added recently.
> + .
> + It can be used for instance to serve the content of an FTP server via
> + HTTP.
> + It also allows a quick and painless setup of an HTTP server, without editing
> + configuration files first.
I'd like to keep a couple of phrases from the original, reduce
repetition of "HTTP" and "serve(r)", and rearrange it all:
Example uses include giving HTTP access to the contents of an FTP
site, or exporting some files by quickly starting a web server
without any need to edit configuration files first.
> + .
> + Webfsd also includes some limited CGI support, only for GET requests.
(Moved.)
--
JBR with qualifications in linguistics, experience as a Debian
sysadmin, and probably no clue about this particular package
--- webfs.old/debian/templates 2010-02-16 11:08:50.000000000 +0000
+++ webfs/debian/templates 2010-02-24 23:25:05.000000000 +0000
@@ -1,14 +1,14 @@
Template: webfsd/web_ip
Type: string
-_Description: IP address webfsd should listen on:
- If your box has more than one IP address, you can pick one here for webfsd.
- Leaving this field blank will allow webfsd to listen on all IP addresses.
+_Description: IP address webfsd should listen to:
+ On a system with multiple IP addresses, webfsd can be configured to
+ listen to only one of them.
+ .
+ If you leave this empty, webfsd will listen on all IP addresses.
Template: webfsd/web_timeout
Type: string
_Description: Timeout for network connections:
- The default timeout is 60 seconds. You can pick another value here if you
- want.
Template: webfsd/pending
Type: string
@@ -18,51 +18,46 @@
Template: webfsd/web_conn
Type: string
_Description: Number of parallel network connections:
- By default, webfsd allows 32 network connections. For private/small
- networks, the default should be fine. If you are running a big server, you
- probably want to use a higher number.
+ For small private networks, the default number of parallel network
+ connections should be fine. This can be increased for larger networks.
Template: webfsd/web_dircache
Type: string
_Description: Directory cache size:
- webfsd can keep cached directory listings. By default, the size of
- the cache is limited to 128 entries. If you have a very big
- directory tree, you might want to raise this value.
+ Directory listings can be cached by webfsd. By default, the size of
+ the cache is limited to 128 entries. If the web server has
+ very big directory trees, you might want to raise this value.
Template: webfsd/web_port
Type: string
-_Description: Port number webfsd should listen on:
- By default, webfsd listens on port 8000. If you want to use another port, enter
- it here.
+_Description: Incoming port number for webfsd:
Template: webfsd/web_virtual
Type: boolean
Default: false
-_Description: Should virtual host support be enabled?
- Please choose this option if you want webfsd support name-based
- virtual hosts. The first directory level below your document root
- will then be used as hostname.
+_Description: Enable virtual host?
+ This option allows webfsd to support name-based virtual hosts, taking
+ the directories immediately below the document root as hostnames.
Template: webfsd/web_root
Type: string
Default: /var/ftp
_Description: Document root for webfsd:
- webfsd is a lightweight HTTP server which only serves static files. You
- can use it for example to provide HTTP access to your anonymous FTP
- server.
+ Webfsd is a lightweight HTTP server for mostly static content. Its
+ most obvious use is to provide HTTP access to an anonymous FTP server.
.
- You need to specify the document root for the webfs daemon, i.e. the
- directory tree which will be exported.
+ Please specify the document root for the webfs daemon.
.
- Leave this blank if you don't want webfsd started by the system at boot time.
+ If you leave this field blank, webfsd will not be started at boot time.
Template: webfsd/web_host
Type: string
_Description: Host name for webfsd:
- webfsd will use the machine's hostname by default. If this box has an alias
- name (like ftp.domain.org) which should be visible outside instead of the
- real hostname (say debian.domain.org), then enter this name here.
- Otherwise you can leave this blank.
+ By default, webfsd uses the machine name as hostname.
+ .
+ You can specify an alternate host name to be used as an external
+ alias name (for instance "ftp.example.org") instead of the machine's
+ fully qualified domain name.
Template: webfsd/web_user
Type: string
@@ -72,13 +67,15 @@
Template: webfsd/web_syslog
Type: boolean
Default: false
-_Description: Should webfsd log events (start/stop/...) to syslog?
+_Description: Log webfsd events (start/stop/...) to syslog?
Template: webfsd/web_accesslog
Type: string
_Description: Access log file:
- webfsd can write an access log in common log format. If you want this,
- enter the log file name here. By default, no logfile will be written.
+ Access to webfsd can be logged in common log format.
+ .
+ If this field is left empty, no logging of incomming connections will
+ be done.
Template: webfsd/web_logbuffering
Type: boolean
@@ -96,22 +93,29 @@
Type: string
_Description: Directory index filename:
If webfsd receives a request for a directory, it can optionally look for an
- index file it should send to the client. Common names are index.html and
- default.html. If you want this, enter the filename here. If you leave it
- blank or no such file exists, webfsd will send a directory listing to the
+ index file it should send to the client. Common names are "index.html" and
+ "default.html".
+ .
+ If you leave this field empty, webfsd will send a directory listing to the
client.
Template: webfsd/web_cgipath
Type: string
_Description: CGI script catalog:
- If webfsd shall be able to deliver output from CGI functions, their
- location must be declared. The path must begin immediately below
- the document root and be specified with an initial slash. An empty
- path disables this feature.
+ Please specify the location for CGI scripts served by webfsd. This
+ path should be located immediately below
+ the document root.
+ .
+ Please specify the full path name and not a relative path. If this
+ field is left empty, CGI scripts will be disabled.
Template: webfsd/web_extras
Type: string
_Description: Extra options to include:
- Webfsd has further capacities that were not mentioned above, such as
- chrooted service, timed expiration of files, and locked binding to
- either IPv6 or IPv4. Consult the manual page and add any extras here.
+ Please specify any webfsd option you want to use with the main
+ daemon.
+ .
+ For instance, webfsd can run chrooted, provide timed expiration of
+ files, and bind either IPv4 or IPv6 addresses.
+ .
+ See webfsd's manual page for details.
--- webfs.old/debian/control 2010-02-16 11:08:52.000000000 +0000
+++ webfs/debian/control 2010-02-24 23:30:22.000000000 +0000
@@ -10,10 +10,10 @@
Architecture: any
Depends: ${shlibs:Depends}, ${misc:Depends}, debconf | debconf-2.0
Provides: httpd
-Description: lightweight http server for static content
- This is a simple http server for mostly static content. You
- can use it to serve the content of a ftp server via http for
- example. It is also nice to export some files the quick way
- by starting a http server in a few seconds, without editing
- some config file first. Limited cgi support (GET requests
- only) has been added recently.
+Description: lightweight HTTP server for static content
+ This package provides a simple web server for mostly static content,
+ with limited CGI support (GET requests only).
+ .
+ Example uses include giving HTTP access to the contents of an FTP
+ site, or exporting some files by quickly starting a web server
+ without any need to edit configuration files first.
Template: webfsd/web_ip
Type: string
_Description: IP address webfsd should listen to:
On a system with multiple IP addresses, webfsd can be configured to
listen to only one of them.
.
If you leave this empty, webfsd will listen on all IP addresses.
Template: webfsd/web_timeout
Type: string
_Description: Timeout for network connections:
Template: webfsd/pending
Type: string
Default: no
Description: for internal use only
Template: webfsd/web_conn
Type: string
_Description: Number of parallel network connections:
For small private networks, the default number of parallel network
connections should be fine. This can be increased for larger networks.
Template: webfsd/web_dircache
Type: string
_Description: Directory cache size:
Directory listings can be cached by webfsd. By default, the size of
the cache is limited to 128 entries. If the web server has
very big directory trees, you might want to raise this value.
Template: webfsd/web_port
Type: string
_Description: Incoming port number for webfsd:
Template: webfsd/web_virtual
Type: boolean
Default: false
_Description: Enable virtual host?
This option allows webfsd to support name-based virtual hosts, taking
the directories immediately below the document root as hostnames.
Template: webfsd/web_root
Type: string
Default: /var/ftp
_Description: Document root for webfsd:
Webfsd is a lightweight HTTP server for mostly static content. Its
most obvious use is to provide HTTP access to an anonymous FTP server.
.
Please specify the document root for the webfs daemon.
.
If you leave this field blank, webfsd will not be started at boot time.
Template: webfsd/web_host
Type: string
_Description: Host name for webfsd:
By default, webfsd uses the machine name as hostname.
.
You can specify an alternate host name to be used as an external
alias name (for instance "ftp.example.org") instead of the machine's
fully qualified domain name.
Template: webfsd/web_user
Type: string
Default: www-data
_Description: User running the webfsd daemon:
Template: webfsd/web_syslog
Type: boolean
Default: false
_Description: Log webfsd events (start/stop/...) to syslog?
Template: webfsd/web_accesslog
Type: string
_Description: Access log file:
Access to webfsd can be logged in common log format.
.
If this field is left empty, no logging of incomming connections will
be done.
Template: webfsd/web_logbuffering
Type: boolean
Default: true
_Description: Should logging be buffered?
With buffered logging, entries will be written in chunks, not as soon
as they are registered as client calls.
Template: webfsd/web_group
Type: string
Default: www-data
_Description: Group running the webfsd daemon:
Template: webfsd/web_index
Type: string
_Description: Directory index filename:
If webfsd receives a request for a directory, it can optionally look for an
index file it should send to the client. Common names are "index.html" and
"default.html".
.
If you leave this field empty, webfsd will send a directory listing to the
client.
Template: webfsd/web_cgipath
Type: string
_Description: CGI script catalog:
Please specify the location for CGI scripts served by webfsd. This
path should be located immediately below
the document root.
.
Please specify the full path name and not a relative path. If this
field is left empty, CGI scripts will be disabled.
Template: webfsd/web_extras
Type: string
_Description: Extra options to include:
Please specify any webfsd option you want to use with the main
daemon.
.
For instance, webfsd can run chrooted, provide timed expiration of
files, and bind either IPv4 or IPv6 addresses.
.
See webfsd's manual page for details.
Source: webfs
Section: httpd
Priority: optional
Build-Depends: debhelper (>= 7), po-debconf
Maintainer: Mats Erik Andersson <mats.andersson@gisladisker.se>
Standards-Version: 3.8.4
Homepage: http://linux.bytesex.org/misc/webfs.html
Package: webfs
Architecture: any
Depends: ${shlibs:Depends}, ${misc:Depends}, debconf | debconf-2.0
Provides: httpd
Description: lightweight HTTP server for static content
This package provides a simple web server for mostly static content,
with limited CGI support (GET requests only).
.
Example uses include giving HTTP access to the contents of an FTP
site, or exporting some files by quickly starting a web server
without any need to edit configuration files first.
Reply to: