[Date Prev][Date Next] [Thread Prev][Thread Next] [Date Index] [Thread Index]

Re: [RFR] templates://ddclient/{ddclient.templates}



Christian Perrier wrote:
>  Template: ddclient/names
>  Type: string
>  _Description: DynDNS fully qualified domain names:
> - Enter the list of fully qualified domain names for your host (like
> - "myname.dyndns.org" if you have only one host or
> + Please enter the list of fully qualified domain names for the local host(s)
> + (for instance, "myname.dyndns.org" with only one host or
>   "myname1.dyndns.org,myname2.dyndns.org" for two hosts).
> 
> Use "for instance" instead of "like". Personal taste. This might be
> better English, but Justin Rye will confirm...

Using "like" to mean "for example" is one of those well-established
usages that are unpopular with stylebooks.  Here, "like" is
defensible on the grounds that it really is talking about strings
similar in format to those given.  But I'm not going to change it
back.

>  Template: ddclient/daemon_interval
>  Type: string
>  Default: 300
> -_Description: ddclient update interval:
> +_Description: Daemon update interval:
>   Please choose the delay between interface address checks.
>   Values may be given in seconds (e.g. "5s"), in minutes (e.g. "3m"), in
>   hours (e.g. "7h") or in days (e.g. "1d").
> 
> Avoid the situation where we have a leading lowercase letter because
> the first word is a program name.

Problem: these "ddclient updates" don't exactly update ddclient
(they update the dyndns.com server).  There's probably a better way
of phrasing it with "updates", but I can't find it, so:

   _Description: Interval between ddclient runs:

>  Template: ddclient/modifiedconfig
[...]
> + You may have edited the configuration file manually and it will not
> + be modified. If you need a new configuration file, please run

I'm not keen on this "and" (or the comma splice in the original).
Maybe we can say:

    If you edited the configuration file manually, it won't be modified.
    If you need a new configuration file, run "dpkg-reconfigure ddclient".

In the control file:
> +Description: dynamic DNS services address updating utility

In a noun-pile like this, plural "services" feels awkward; probably
it would be wiser to reorder it as

   Description: address updating utility for dynamic DNS services

> + This package provides a client to update dynamic IP addresses with
> + several synamic DNS service providers, such at DynDNS.com.
Typos:      d                                    s
> + .
> + This allows using a fixed hostname
> + (myhost.dyndns.org) to access a machine with a dynamic IP address.

Breaking it up definitely helps.  But how about:

    This makes it possible to use a fixed hostname (such as
    myhost.dyndns.org) to access a machine with a dynamic IP address.

> + .
> + This client supports both
>   the dynamic and (near) static services, MX setting, and alternative
> + host. It caches the address, and only attempts the update when the
> + address changes.

> Avoid mentioning the various DynDNS services (they may change over
> time) and only use DynDNS which is the "leader of the market")

Indeed, Hammernode no longer exists (and ZoneEdit.com insists on
camelcase).  But I'd reorganise this list a little -
 * puzzling use of "both" at the start of a list of four things
 * "MX setting" is overabbreviated
 * DynDNS's docs call it "alternative name", not "alternative host"

So how about:
    This client supports both dynamic and (near) static services, as well
    as MX record and alternative name management.
 
> Final sentence: simplify it, dropping the "actually" which I
> personnally find to be used in any situation in current language,
> which I find annoying (Justin wiill confirm or not).

It's an overused intensifier (a few years ago I discovered it was
the commonest eight-letter word in my vocabulary); reserve it for
cases where there's a real contrast to be drawn.  In this case the
emphasis isn't needed, and nor is the repetition of "the address".
I'd prefer

   It caches the address, and only attempts the update when it has changed.
-- 
JBR	with qualifications in linguistics, experience as a Debian
	sysadmin, and probably no clue about this particular package
--- ../ddclient.old/debian/ddclient.templates	2009-01-07 08:24:43.000000000 +0000
+++ debian/ddclient.templates	2009-01-12 13:00:47.000000000 +0000
@@ -1,5 +1,6 @@
 Template: ddclient/service
 Type: select
+#flag:translate:5
 __Choices: www.dyndns.com, www.easydns.com, www.dslreports.com, www.zoneedit.com, other
 Default: www.dyndns.com
 _Description: Dynamic DNS service provider:
@@ -10,7 +11,7 @@
 Template: ddclient/server
 Type: string
 _Description: Dynamic DNS server:
- Enter the name of the server which is providing you with dynamic DNS
+ Please enter the name of the server which is providing you with dynamic DNS
  service (example: members.dyndns.org).
 
 Template: ddclient/protocol
@@ -18,37 +19,37 @@
 Choices: dyndns2, dslreports1, easydns, hammernode1, zoneedit1, dyndns1
 Default: dyndns2
 _Description: Dynamic DNS update protocol:
- Select the dynamic DNS update protocol used by your dynamic DNS service
+ Please select the dynamic DNS update protocol used by your dynamic DNS service
  provider.
 
 Template: ddclient/names
 Type: string
 _Description: DynDNS fully qualified domain names:
- Enter the list of fully qualified domain names for your host (like
- "myname.dyndns.org" if you have only one host or
+ Please enter the list of fully qualified domain names for the local host(s)
+ (for instance, "myname.dyndns.org" with only one host or
  "myname1.dyndns.org,myname2.dyndns.org" for two hosts).
 
 Template: ddclient/username
 Type: string
 _Description: Username for dynamic DNS service:
- Enter the username you use to log into the dynamic DNS service.
+ Please enter the username to use with the dynamic DNS service.
 
 Template: ddclient/password
 Type: password
 _Description: Password for dynamic DNS service:
- Enter the password you use to log into the dynamic DNS service.
+ Please enter the password to use with the dynamic DNS service.
 
 Template: ddclient/interface
 Type: string
 _Description: Network interface used for dynamic DNS service:
- Enter the name of the network interface (eth0/wlan0/ppp0/...) to use for 
- dynamic DNS service.
+ Please enter the name of the network interface (eth0/wlan0/ppp0/...)
+ to use for dynamic DNS service.
 
 Template: ddclient/run_ipup
 Type: boolean
 Default: false
 _Description: Run ddclient on PPP connect?
- Enable this if ddclient should be run every time a PPP connection is
+ You should enable this option if ddclient should be run every time a PPP connection is
  established.
 
 Template: ddclient/run_daemon
@@ -61,16 +62,17 @@
 Template: ddclient/daemon_interval
 Type: string
 Default: 300
-_Description: ddclient update interval:
+_Description: Interval between ddclient runs:
  Please choose the delay between interface address checks.
  Values may be given in seconds (e.g. "5s"), in minutes (e.g. "3m"), in
  hours (e.g. "7h") or in days (e.g. "1d").
 
 Template: ddclient/modifiedconfig
-Type: note
+Type: error
 _Description: Modified configuration file
  The config file /etc/ddclient.conf on your system does not consist of
- three entries. The automatic configuration utility (debconf) cannot handle
- this. Maybe you modified the configuration file manually, thus it won't
- be modified. If you want a new config file to be created, please run
- "dpkg-reconfigure ddclient".
+ three entries. The automatic configuration utility cannot handle
+ this situation.
+ .
+ If you have edited the configuration file manually, it won't be modified.
+ If you need a new configuration file, run "dpkg-reconfigure ddclient".
--- ../ddclient.old/debian/control	2009-01-07 08:24:43.000000000 +0000
+++ debian/control	2009-01-12 13:06:54.000000000 +0000
@@ -12,11 +12,13 @@
 Depends: perl5, ${misc:Depends}, lsb-base (>= 3.1), initscripts (>= 2.86)
 Recommends: libio-socket-ssl-perl
 Provides: dyndns-client
-Description: Update IP addresses at dynamic DNS services
- A perl based client to update your dynamic IP address at DynDNS.com
- (or other dynamic DNS services such as Hammernode, Zoneedit or
- EasyDNS), thus allowing you and others to use a fixed hostname
- (myhost.dyndns.org) to access your machine. This client supports both
- the dynamic and (near) static services, MX setting, and alternative
- host. It caches the address, and only attempts the update if the
- address actually changes.
+Description: address updating utility for dynamic DNS services
+ This package provides a client to update dynamic IP addresses with
+ several dynamic DNS service providers, such as DynDNS.com.
+ .
+ This makes it possible to use a fixed hostname (such as
+ myhost.dyndns.org) to access a machine with a dynamic IP address.
+ .
+ This client supports both dynamic and (near) static services, as  well as
+ MX record and alternative name management. It caches the address, and
+ only attempts the update when it has changed.
Template: ddclient/service
Type: select
#flag:translate:5
__Choices: www.dyndns.com, www.easydns.com, www.dslreports.com, www.zoneedit.com, other
Default: www.dyndns.com
_Description: Dynamic DNS service provider:
 Please select the dynamic DNS service you are using. If the service you use is
 not listed, choose "other" and you will be asked for the protocol and the
 server name.

Template: ddclient/server
Type: string
_Description: Dynamic DNS server:
 Please enter the name of the server which is providing you with dynamic DNS
 service (example: members.dyndns.org).

Template: ddclient/protocol
Type: select
Choices: dyndns2, dslreports1, easydns, hammernode1, zoneedit1, dyndns1
Default: dyndns2
_Description: Dynamic DNS update protocol:
 Please select the dynamic DNS update protocol used by your dynamic DNS service
 provider.

Template: ddclient/names
Type: string
_Description: DynDNS fully qualified domain names:
 Please enter the list of fully qualified domain names for the local host(s)
 (for instance, "myname.dyndns.org" with only one host or
 "myname1.dyndns.org,myname2.dyndns.org" for two hosts).

Template: ddclient/username
Type: string
_Description: Username for dynamic DNS service:
 Please enter the username to use with the dynamic DNS service.

Template: ddclient/password
Type: password
_Description: Password for dynamic DNS service:
 Please enter the password to use with the dynamic DNS service.

Template: ddclient/interface
Type: string
_Description: Network interface used for dynamic DNS service:
 Please enter the name of the network interface (eth0/wlan0/ppp0/...)
 to use for dynamic DNS service.

Template: ddclient/run_ipup
Type: boolean
Default: false
_Description: Run ddclient on PPP connect?
 You should enable this option if ddclient should be run every time a PPP connection is
 established.

Template: ddclient/run_daemon
Type: boolean
Default: false
_Description: Run ddclient as daemon?
 Please choose whether you want ddclient to be run in daemon mode on system
 startup.

Template: ddclient/daemon_interval
Type: string
Default: 300
_Description: Interval between ddclient runs:
 Please choose the delay between interface address checks.
 Values may be given in seconds (e.g. "5s"), in minutes (e.g. "3m"), in
 hours (e.g. "7h") or in days (e.g. "1d").

Template: ddclient/modifiedconfig
Type: error
_Description: Modified configuration file
 The config file /etc/ddclient.conf on your system does not consist of
 three entries. The automatic configuration utility cannot handle
 this situation.
 .
 If you have edited the configuration file manually, it won't be modified.
 If you need a new configuration file, run "dpkg-reconfigure ddclient".
Source: ddclient
Section: net
Priority: extra
Maintainer: Torsten Landschoff <torsten@debian.org>
Uploaders: Marco Rodrigues <gothicx@sapo.pt>
Build-Depends: debhelper (>= 5), po-debconf, xmlto, quilt
Standards-Version: 3.7.2
Homepage: http://ddclient.sf.net

Package: ddclient
Architecture: all
Depends: perl5, ${misc:Depends}, lsb-base (>= 3.1), initscripts (>= 2.86)
Recommends: libio-socket-ssl-perl
Provides: dyndns-client
Description: address updating utility for dynamic DNS services
 This package provides a client to update dynamic IP addresses with
 several dynamic DNS service providers, such as DynDNS.com.
 .
 This makes it possible to use a fixed hostname (such as
 myhost.dyndns.org) to access a machine with a dynamic IP address.
 .
 This client supports both dynamic and (near) static services, as  well as
 MX record and alternative name management. It caches the address, and
 only attempts the update when it has changed.

Reply to: