Changeset 568 in code for trunk/doc

Timestamp:

Jun 25, 2021, 6:33:13 PM (4 years ago)

Author:

contact

Message:

Add per-user realname setting

This allows users to set a default realname used if the per-network
realname isn't set.

A new "user update" command is introduced and can be extended to edit
other user properties and other users in the future.

File:

• trunk/doc/soju.1.scd (modified) (2 diffs)

trunk/doc/soju.1.scd

@@ -161 +161 @@
 
         *-realname* <realname>
-                Connect with the specified real name. By default, the nickname is used.
+                Connect with the specified real name. By default, the account's realname
+                is used if set, otherwise the network's nickname is used.
 
         *-nick* <nickname>
@@ -297 +298 @@
         Disable SASL authentication and remove stored credentials.
 
-*user create* -username <username> -password <password> [-admin]
+*user create* -username <username> -password <password> [options...]
         Create a new soju user. Only admin users can create new accounts.
+
+        Options:
+
+        *-admin*
+                Make the new user an administrator.
+
+        *-realname* <realname>
+                Set the user's realname. This is used as a fallback if there is no
+                realname set for a network.
+
+*user update* [-realname <realname>]
+        Update the current user.
 
 *user delete* <username>