Standardize on "username" (not "user") in user-facing contexts

diff --git a/README.client b/README.client
index cec4e8c42113dd69749cfe588fcbdc00732364af..04bdee7bddc8b0f1fd297b6259f3af8844831f14 100644 (file)
--- a/README.client
+++ b/README.client
@@ -17,7 +17,7 @@ There is currently no standard DisOrder port number.
 
     where PORT is the same as 'listen PORT' on the server.
 
 
     where PORT is the same as 'listen PORT' on the server.
 

- 3. Copy the password file for each user to ~USER/.disorder/passwd, the
+ 3. Copy the password file for each user to ~USERNAME/.disorder/passwd, the

     contents being:
 
       password PASSWORD
     contents being:
 
       password PASSWORD

diff --git a/clients/disorder.c b/clients/disorder.c
index fa42558dd59ed838b6c5050a6fbfa9eeb81a621c..2088bc4a9fed9224dfd605008b79439d7a4ea160 100644 (file)
--- a/clients/disorder.c
+++ b/clients/disorder.c
@@ -475,22 +475,22 @@ static const struct command {
   int (*isarg)(const char *);
   const char *argstr, *desc;
 } commands[] = {
   int (*isarg)(const char *);
   const char *argstr, *desc;
 } commands[] = {

-  { "adduser",        2, 3, cf_adduser, isarg_rights, "USER PASSWORD [RIGHTS]",
+  { "adduser",        2, 3, cf_adduser, isarg_rights, "USERNAME PASSWORD [RIGHTS]",

                       "Create a new user" },
   { "allfiles",       1, 2, cf_allfiles, isarg_regexp, "DIR [~REGEXP]",
                       "List all files and directories in DIR" },
                       "Create a new user" },
   { "allfiles",       1, 2, cf_allfiles, isarg_regexp, "DIR [~REGEXP]",
                       "List all files and directories in DIR" },

-  { "authorize",      1, 2, cf_authorize, isarg_rights, "USER [RIGHTS]",
-                      "Authorize USER to connect to the server" },
-  { "deluser",        1, 1, cf_deluser, 0, "USER",
-                      "Delete a user" },
+  { "authorize",      1, 2, cf_authorize, isarg_rights, "USERNAME [RIGHTS]",
+                      "Authorize user USERNAME to connect to the server" },
+  { "deluser",        1, 1, cf_deluser, 0, "USERNAME",
+                      "Delete user USERNAME" },

   { "dirs",           1, 2, cf_dirs, isarg_regexp, "DIR [~REGEXP]",
                       "List directories in DIR" },
   { "disable",        0, 0, cf_disable, 0, "",
                       "Disable play" },
   { "disable-random", 0, 0, cf_random_disable, 0, "",
                       "Disable random play" },
   { "dirs",           1, 2, cf_dirs, isarg_regexp, "DIR [~REGEXP]",
                       "List directories in DIR" },
   { "disable",        0, 0, cf_disable, 0, "",
                       "Disable play" },
   { "disable-random", 0, 0, cf_random_disable, 0, "",
                       "Disable random play" },

-  { "edituser",       3, 3, cf_edituser, 0, "USER PROPERTY VALUE",
-                      "Set a property of a user" },
+  { "edituser",       3, 3, cf_edituser, 0, "USERNAME PROPERTY VALUE",
+                      "Set a property of user USERNAME" },

   { "enable",         0, 0, cf_enable, 0, "",
                       "Enable play" },
   { "enable-random",  0, 0, cf_random_enable, 0, "",
   { "enable",         0, 0, cf_enable, 0, "",
                       "Enable play" },
   { "enable-random",  0, 0, cf_random_enable, 0, "",


@@ -566,8 +566,8 @@ static const struct command {
                       "Unset a preference" },
   { "unset-global",   1, 1, cf_unset_global, 0, "NAME",
                       "Unset a global preference" },
                       "Unset a preference" },
   { "unset-global",   1, 1, cf_unset_global, 0, "NAME",
                       "Unset a global preference" },

-  { "userinfo",       2, 2, cf_userinfo, 0, "USER PROPERTY",
-                      "Get a property of as user" },
+  { "userinfo",       2, 2, cf_userinfo, 0, "USERNAME PROPERTY",
+                      "Get a property of a user" },

   { "users",          0, 0, cf_users, 0, "",
                       "List all users" },
   { "version",        0, 0, cf_version, 0, "",
   { "users",          0, 0, cf_users, 0, "",
                       "List all users" },
   { "version",        0, 0, cf_version, 0, "",

diff --git a/disobedience/users.c b/disobedience/users.c
index ee9c16d87db7a25af152176932bd4934e4fb6e9f..80f3bf2fbd0b30419428c6f6bcb122757eff2f58 100644 (file)
--- a/disobedience/users.c
+++ b/disobedience/users.c
@@ -33,9 +33,6 @@
  * When you select 'add' a new empty set of details are displayed to be edited.
  * Again Apply will commit them.
  *
  * When you select 'add' a new empty set of details are displayed to be edited.
  * Again Apply will commit them.
  *

- * TODO: @ref RIGHT_ADMIN and @ref RIGHT_USERINFO should be applied here, so we
- * can give decent error messages.
- *

  * TODO: it would be really nice if the Username entry could be removed and new
  * user names entered in the list, rather off in the details panel.  This may
  * be possible with a sufficiently clever GtkCellRenderer.
  * TODO: it would be really nice if the Username entry could be removed and new
  * user names entered in the list, rather off in the details panel.  This may
  * be possible with a sufficiently clever GtkCellRenderer.

diff --git a/doc/disorder.1.in b/doc/disorder.1.in
index 61f6f02d3b95ecd5f92e918d74c697a1afcaafbc..e1981f62df5b218181f1791dd1e8005fe3aaac36 100644 (file)
--- a/doc/disorder.1.in
+++ b/doc/disorder.1.in
@@ -55,25 +55,25 @@ Display version number.
 List all known commands.
 .SH COMMANDS
 .TP
 List all known commands.
 .SH COMMANDS
 .TP

-.B adduser \fIUSER PASSWORD\fR [\fIRIGHTS\fR]
+.B adduser \fIUSERNAME PASSWORD\fR [\fIRIGHTS\fR]

 Create a new user.
 If \fIRIGHTS\fR is not specified then the \fBdefault_rights\fR
 setting from the server's configuration file applies.
 .TP
 Create a new user.
 If \fIRIGHTS\fR is not specified then the \fBdefault_rights\fR
 setting from the server's configuration file applies.
 .TP

-.B authorize \fIUSER\fR [\fIRIGHTS\fR]
-Create \fIUSER\fR with a random password.
-\fIUSER\fR must be a UNIX login user (not just any old string).
+.B authorize \fIUSERNAME\fR [\fIRIGHTS\fR]
+Create user \fIUSERNAME\fR with a random password.
+User \fIUSERNAME\fR must be a UNIX login user (not just any old string).

 If \fIRIGHTS\fR is not specified then the \fBdefault_rights\fR
 setting from the server's configuration file applies.
 .IP
 If \fIRIGHTS\fR is not specified then the \fBdefault_rights\fR
 setting from the server's configuration file applies.
 .IP

-\fI~USER/.disorder/passwd\fR is created with the password in it, so the new
+\fI~USERNAME/.disorder/passwd\fR is created with the password in it, so the new

 user should be able to log in immediately.
 .IP
 If writing the \fIpasswd\fR file fails then the user will already have been
 created in DisOrder's user database.
 Use \fBdisorder deluser\fR to remove them before trying again.
 .TP
 user should be able to log in immediately.
 .IP
 If writing the \fIpasswd\fR file fails then the user will already have been
 created in DisOrder's user database.
 Use \fBdisorder deluser\fR to remove them before trying again.
 .TP

-.B deluser \fIUSER\fR
+.B deluser \fIUSERNAME\fR

 Delete a user.
 .TP
 .B dirs \fIDIRECTORY\fR [\fB~\fIREGEXP\fR]
 Delete a user.
 .TP
 .B dirs \fIDIRECTORY\fR [\fB~\fIREGEXP\fR]


@@ -85,7 +85,7 @@ Only directories with a basename matching the regexp will be returned.
 .B disable
 Disable playing after the current track finishes.
 .TP
 .B disable
 Disable playing after the current track finishes.
 .TP

-.B edituser \fIUSER PROPERTY VALUE
+.B edituser \fIUSERNAME PROPERTY VALUE

 Set some property of a user.
 .TP
 .B enable
 Set some property of a user.
 .TP
 .B enable


@@ -238,7 +238,7 @@ Unset the preference \fIKEY\fR for \fITRACK\fR.
 .B unset\-global \fIKEY\fR
 Unset the global preference \fIKEY\fR.
 .TP
 .B unset\-global \fIKEY\fR
 Unset the global preference \fIKEY\fR.
 .TP

-.B userinfo \fIUSER PROPERTY
+.B userinfo \fIUSERNAME PROPERTY

 Get some property of a user.
 .TP
 .B users
 Get some property of a user.
 .TP
 .B users

diff --git a/doc/disorder_config.5.in b/doc/disorder_config.5.in
index b0f20aed8e9f83b8177f4e44efc15688d116211a..a9549ed61f2b5a2548f42483b9e3490590279114 100644 (file)
--- a/doc/disorder_config.5.in
+++ b/doc/disorder_config.5.in
@@ -214,12 +214,12 @@ Configuration files are read in the following order:
 Should be readable only by the jukebox group.
 Not really useful any more and will be abolished in future.
 .TP
 Should be readable only by the jukebox group.
 Not really useful any more and will be abolished in future.
 .TP

-.I ~\fRUSER\fI/.disorder/passwd
+.I ~\fRUSERNAME\fI/.disorder/passwd

 Per-user client configuration.
 Optional but if it exists must be readable only by the relevant user.
 Would normally contain a \fBpassword\fR directive.
 .TP
 Per-user client configuration.
 Optional but if it exists must be readable only by the relevant user.
 Would normally contain a \fBpassword\fR directive.
 .TP

-.I pkgconfdir/config.\fRUSER
+.I pkgconfdir/config.\fRUSERNAME

 Per-user system-controlled client configuration.
 Optional but if it exists must be readable only by the relevant user.
 Would normally contain a \fBpassword\fR directive.
 Per-user system-controlled client configuration.
 Optional but if it exists must be readable only by the relevant user.
 Would normally contain a \fBpassword\fR directive.


@@ -691,7 +691,7 @@ Specifies the module used to calculate the length of files matching
 If \fBtracklength\fR is used without arguments then the list of modules is
 cleared.
 .TP
 If \fBtracklength\fR is used without arguments then the list of modules is
 cleared.
 .TP

-.B user \fIUSER\fR
+.B user \fIUSERNAME\fR

 Specifies the user to run as.
 Only makes sense if invoked as root (or the target user).
 .SS "Client Configuration"
 Specifies the user to run as.
 Only makes sense if invoked as root (or the target user).
 .SS "Client Configuration"


@@ -768,8 +768,9 @@ longer needs to be specified.
 This must be the full URL, e.g. \fBhttp://myhost/cgi-bin/jukebox\fR and not
 \fB/cgi-bin/jukebox\fR.
 .SS "Authentication Configuration"
 This must be the full URL, e.g. \fBhttp://myhost/cgi-bin/jukebox\fR and not
 \fB/cgi-bin/jukebox\fR.
 .SS "Authentication Configuration"

-These options would normally be used in \fI~\fRUSER\fI/.disorder/passwd\fR or
-\fIpkgconfdir/config.\fRUSER.
+These options would normally be used in \fI~\fRUSERNAME\fI/.disorder/passwd\fR
+or
+\fIpkgconfdir/config.\fRUSERNAME.

 .TP
 .B password \fIPASSWORD\fR
 Specify password.
 .TP
 .B password \fIPASSWORD\fR
 Specify password.

diff --git a/doc/disorder_protocol.5.in b/doc/disorder_protocol.5.in
index 678c1fd0da4e5438bd5771f881c3808efb973814..5a2bf839a25e5601ad66b4e84824b48979ee3f4b 100644 (file)
--- a/doc/disorder_protocol.5.in
+++ b/doc/disorder_protocol.5.in
@@ -237,15 +237,15 @@ See below for the track information syntax.
 Request that DisOrder reconfigure itself.
 Requires the \fBadmin\fR right.
 .TP
 Request that DisOrder reconfigure itself.
 Requires the \fBadmin\fR right.
 .TP

-.B register \fIUSER PASSWORD EMAIL
+.B register \fIUSERNAME PASSWORD EMAIL

 Register a new user.
 Requires the \fBregister\fR right.
 The result contains a confirmation string; the user will be be able
 to log in until this has been presented back to the server via the
 \fBconfirm\fR command.
 .TP
 Register a new user.
 Requires the \fBregister\fR right.
 The result contains a confirmation string; the user will be be able
 to log in until this has been presented back to the server via the
 \fBconfirm\fR command.
 .TP

-.B reminder \fIUSER\fR
-Send a password reminder to \fIUSER\fR.
+.B reminder \fIUSERNAME\fR
+Send a password reminder to user \fIUSERNAME\fR.

 If the user has no valid email address, or no password, or a
 reminder has been sent too recently, then no reminder will be sent.
 .TP
 If the user has no valid email address, or no password, or a
 reminder has been sent too recently, then no reminder will be sent.
 .TP


@@ -321,13 +321,13 @@ Requires the \fBprefs\fR right.
 Unset a global preference.
 Requires the \fBglobal prefs\fR right.
 .TP
 Unset a global preference.
 Requires the \fBglobal prefs\fR right.
 .TP

-.B user \fIUSER\fR \fIRESPONSE\fR
-Authenticate as \fIUSER\fR.
+.B user \fIUSERNAME\fR \fIRESPONSE\fR
+Authenticate as user \fIUSERNAME\fR.

 See
 .B AUTHENTICATION
 below.
 .TP
 See
 .B AUTHENTICATION
 below.
 .TP

-.B userinfo \fIUSER PROPERTY
+.B userinfo \fIUSERNAME PROPERTY

 Get a user property.
 .TP
 .B users
 Get a user property.
 .TP
 .B users


@@ -494,11 +494,11 @@ Completed playing \fITRACK\fR
 .B failed \fITRACK\fR \fIERROR\fR
 Completed playing \fITRACK\fR with an error status
 .TP
 .B failed \fITRACK\fR \fIERROR\fR
 Completed playing \fITRACK\fR with an error status
 .TP

-.B moved \fIUSER\fR
-User \fIUSER\fR moved some track(s).
+.B moved \fIUSERNAME\fR
+User \fIUSERNAME\fR moved some track(s).

 Further details aren't included any more.
 .TP
 Further details aren't included any more.
 .TP

-.B playing \fITRACK\fR [\fIUSER\fR]
+.B playing \fITRACK\fR [\fIUSERNAME\fR]

 Started playing \fITRACK\fR.
 .TP
 .B queue \fIQUEUE-ENTRY\fR...
 Started playing \fITRACK\fR.
 .TP
 .B queue \fIQUEUE-ENTRY\fR...


@@ -510,16 +510,16 @@ Added \fIID\fR to the recently played list.
 .B recent_removed \fIID\fR
 Removed \fIID\fR from the recently played list.
 .TP
 .B recent_removed \fIID\fR
 Removed \fIID\fR from the recently played list.
 .TP

-.B removed \fIID\fR [\fIUSER\fR]
+.B removed \fIID\fR [\fIUSERNAME\fR]

 Queue entry \fIID\fR was removed.
 Queue entry \fIID\fR was removed.

-This is used both for explicit removal (when \fIUSER\fR is present)
+This is used both for explicit removal (when \fIUSERNAME\fR is present)

 and when playing a track (when it is absent).
 .TP
 .B rescanned
 A rescan completed.
 .TP
 and when playing a track (when it is absent).
 .TP
 .B rescanned
 A rescan completed.
 .TP

-.B scratched \fITRACK\fR \fIUSER\fR
-\fITRACK\fR was scratched by \fIUSER\fR.
+.B scratched \fITRACK\fR \fIUSERNAME\fR
+\fITRACK\fR was scratched by \fIUSERNAME\fR.

 .TP
 .B state \fIKEYWORD\fR
 Some state change occurred.
 .TP
 .B state \fIKEYWORD\fR
 Some state change occurred.