Changeset 92cb8c4 for doc/user-guide

Timestamp:

2010-06-06T23:47:46Z (14 years ago)

Author:

Wilmer van der Gaast <wilmer@…>

Branches:

master

Children:

36562b0

Parents:

16834a5

Message:

Complete (hopefully) fix for nickname changes: Add flags to the identify
command to allow identifying without loading any new settings. With some
documentation hints.

Location:

doc/user-guide

Files:

• commands.xml (modified) (2 diffs)
• misc.xml (modified) (1 diff)

doc/user-guide/commands.xml

@@ -1114 +1114 @@
 
         <bitlbee-command name="identify">
-                <syntax>identify &lt;password&gt;</syntax>
+                <syntax>identify [-noload|-force] &lt;password&gt;</syntax>
                 <short-description>Identify yourself with your password</short-description>
 
@@ -1124 +1124 @@
                         <para>
                                 Once you're registered, you can change your password using <emphasis>set password &lt;password&gt;</emphasis>.
+                        </para>
+
+                        <para>
+                                The <emphasis>-noload</emphasis> and <emphasis>-force</emphasis> flags can be used to identify when you're logged into some IM accounts already. <emphasis>-force</emphasis> will let you identify yourself and load all saved accounts (and keep the accounts you're logged into already).
+                        </para>
+                        
+                        <para>
+                                <emphasis>-noload</emphasis> will log you in but not load any accounts and settings saved under your current nickname. These will be overwritten once you save your settings (i.e. when you disconnect).
                         </para>
                 </description>

doc/user-guide/misc.xml

@@ -117 +117 @@
 </sect1>
 
+<sect1 id="nick_changes">
+<title>Changing your nickname</title>
+
+<para>
+BitlBee now allows you to change your nickname. So far this was not possible because it made managing saved accounts more complicated.
+</para>
+
+<para>
+The restriction no longer exists now though. When you change your nick (just using the <emphasis>/nick</emphasis> command), your logged-in status will be reset, which means any changes made to your settings/accounts will not be saved.
+</para>
+
+<para>
+To restore your logged-in status, you need to either use the <emphasis>register</emphasis> command to create an account under the new nickname, or use <emphasis>identify -noload</emphasis> to re-identify yourself under the new nickname. The <emphasis>-noload</emphasis> flag tells the command to verify your password and log you in, but not load any new settings. See <emphasis>help identify</emphasis> for more information.
+</para>
+
+</sect1>
+
 </chapter>