doc/manual.docbook
changeset 122 05b676684c7e
parent 121 62185dc7d0c9
child 123 20b54500a618
--- a/doc/manual.docbook	Wed Oct 14 14:48:33 2009 +0100
+++ b/doc/manual.docbook	Wed Oct 14 14:51:45 2009 +0100
@@ -69,7 +69,8 @@
 <section>
 <title>Creating a repository host</title>
 <para>
-In what follows, we assume that you usually sit at a machine called
+In what follows, we assume that your username is <systemitem
+class="username">jay</systemitem>, that you usually sit at a machine called
 <systemitem class="systemname">my-workstation</systemitem> and you wish to
 install mercurial-server on <systemitem
 class="systemname">repository-host</systemitem>. First, you'll need to
@@ -78,48 +79,48 @@
 this.
 </para>
 <screen>
-<computeroutput>user@my-workstation:~$ </computeroutput><userinput>ssh-keygen</userinput>
+<computeroutput>jay@my-workstation:~$ </computeroutput><userinput>ssh-keygen</userinput>
 <computeroutput>Generating public/private rsa key pair.
 Enter passphrase (empty for no passphrase): 
 Enter same passphrase again: 
-Your identification has been saved in /home/user/.ssh/id_rsa.
-Your public key has been saved in /home/user/.ssh/id_rsa.pub.
+Your identification has been saved in /home/jay/.ssh/id_rsa.
+Your public key has been saved in /home/jay/.ssh/id_rsa.pub.
 The key fingerprint is:
-8b:aa:0a:98:fe:e7:84:48:a3:fe:5f:31:4b:16:e6:0b user@my-workstation
-user@my-workstation:~$ </computeroutput><userinput>ssh-add</userinput>
-<computeroutput>Enter passphrase for /home/user/.ssh/id_rsa: 
-Identity added: /home/user/.ssh/id_rsa (/home/user/.ssh/id_rsa)
-user@my-workstation:~$ </computeroutput></screen>
+8b:aa:0a:98:fe:e7:84:48:a3:fe:5f:31:4b:16:e6:0b jay@my-workstation
+jay@my-workstation:~$ </computeroutput><userinput>ssh-add</userinput>
+<computeroutput>Enter passphrase for /home/jay/.ssh/id_rsa: 
+Identity added: /home/jay/.ssh/id_rsa (/home/jay/.ssh/id_rsa)
+jay@my-workstation:~$ </computeroutput></screen>
 <para>Now copy the files you're going to need over to your target system, and install mercurial-server</para>
 <screen>
-<computeroutput>user@my-workstation:~$ </computeroutput><userinput>ssh-copy-id repository-host</userinput>
-<computeroutput>user@repository-host's password:
+<computeroutput>jay@my-workstation:~$ </computeroutput><userinput>ssh-copy-id repository-host</userinput>
+<computeroutput>jay@repository-host's password:
 Now try logging into the machine, with "ssh 'repository-host'", and check in:
 
   .ssh/authorized_keys
 
 to make sure we haven't added extra keys that you weren't expecting.
-user@my-workstation:~$ </computeroutput><userinput>scp mercurial-server_0.6.1_amd64.deb repository-host:</userinput>
+jay@my-workstation:~$ </computeroutput><userinput>scp mercurial-server_0.6.1_amd64.deb repository-host:</userinput>
 <computeroutput>mercurial-server_0.6.1_amd64.deb 100%
-user@my-workstation:~$ </computeroutput><userinput>ssh -A repository-host</userinput>
-<computeroutput>user@repository-host:~$ </computeroutput><userinput>sudo dpkg -i ../mercurial-server_0.6.1_amd64.deb</userinput>
-<computeroutput>[sudo] password for user: 
+jay@my-workstation:~$ </computeroutput><userinput>ssh -A repository-host</userinput>
+<computeroutput>jay@repository-host:~$ </computeroutput><userinput>sudo dpkg -i ../mercurial-server_0.6.1_amd64.deb</userinput>
+<computeroutput>[sudo] password for jay: 
 Selecting previously deselected package mercurial-server.
 (Reading database ... 144805 files and directories currently installed.)
 Unpacking mercurial-server (from .../mercurial-server_0.6.1_amd64.deb) ...
 Setting up mercurial-server (0.6.1) ...
-user@repository-host:~$ </computeroutput></screen>
+jay@repository-host:~$ </computeroutput></screen>
 <para>
 mercurial-server is now installed on the repository host.  Next, we need to give you permission to access its repositories.
 </para>
 <screen>
-<computeroutput>user@repository-host:~$ </computeroutput><userinput>ssh-add -L > my-key</userinput>
-<computeroutput>user@repository-host:~$ </computeroutput><userinput>sudo mkdir -p /etc/mercurial-server/keys/root/user</userinput>
-<computeroutput>user@repository-host:~$ </computeroutput><userinput>sudo cp my-key /etc/mercurial-server/keys/root/user/my-workstation</userinput>
-<computeroutput>user@repository-host:~$ </computeroutput><userinput>sudo -u hg /usr/share/mercurial-server/refresh-auth</userinput>
-<computeroutput>user@repository-host:~$ </computeroutput><userinput>exit</userinput>
+<computeroutput>jay@repository-host:~$ </computeroutput><userinput>ssh-add -L > my-key</userinput>
+<computeroutput>jay@repository-host:~$ </computeroutput><userinput>sudo mkdir -p /etc/mercurial-server/keys/root/jay</userinput>
+<computeroutput>jay@repository-host:~$ </computeroutput><userinput>sudo cp my-key /etc/mercurial-server/keys/root/jay/my-workstation</userinput>
+<computeroutput>jay@repository-host:~$ </computeroutput><userinput>sudo -u hg /usr/share/mercurial-server/refresh-auth</userinput>
+<computeroutput>jay@repository-host:~$ </computeroutput><userinput>exit</userinput>
 <computeroutput>Connection to shell closed.
-user@my-workstation:~$ </computeroutput></screen>
+jay@my-workstation:~$ </computeroutput></screen>
 <para>
 You can now create repositories on the remote machine and have complete
 read-write access to all of them; you need never log on to <systemitem
@@ -129,18 +130,18 @@
 <section>
 <title>Creating repositories</title>
 <screen>
-<computeroutput>user@my-workstation:~$ </computeroutput><userinput>cd my-mercurial-project</userinput>
-<computeroutput>user@my-workstation:~/my-mercurial-project$ </computeroutput><userinput>hg clone . ssh://hg@repository-host/repository/name</userinput>
+<computeroutput>jay@my-workstation:~$ </computeroutput><userinput>cd my-mercurial-project</userinput>
+<computeroutput>jay@my-workstation:~/my-mercurial-project$ </computeroutput><userinput>hg clone . ssh://hg@repository-host/repository/name</userinput>
 <computeroutput>searching for changes
 remote: adding changesets
 remote: adding manifests
 remote: adding file changes
 remote: added 119 changesets with 284 changes to 61 files
-user@my-workstation:~/my-mercurial-project$ </computeroutput><userinput>hg pull ssh://hg@repository-host/repository/name</userinput>
+jay@my-workstation:~/my-mercurial-project$ </computeroutput><userinput>hg pull ssh://hg@repository-host/repository/name</userinput>
 <computeroutput>pulling from ssh://hg@repository-host/repository/name
 searching for changes
 no changes found
-user@my-workstation:~/my-mercurial-project$ </computeroutput></screen>
+jay@my-workstation:~/my-mercurial-project$ </computeroutput></screen>
 </section>
 <section>
 <title>Adding other users</title>
@@ -156,26 +157,26 @@
 However, there's a more convenient way.
 </para>
 <screen>
-<computeroutput>user@my-workstation:~/my-mercurial-project$ </computeroutput><userinput>cd ..</userinput>
-<computeroutput>user@my-workstation:~$ </computeroutput><userinput>hg clone ssh://hg@repository-host/hgadmin</userinput>
+<computeroutput>jay@my-workstation:~/my-mercurial-project$ </computeroutput><userinput>cd ..</userinput>
+<computeroutput>jay@my-workstation:~$ </computeroutput><userinput>hg clone ssh://hg@repository-host/hgadmin</userinput>
 <computeroutput>destination directory: hgadmin
 no changes found
 updating working directory
 0 files updated, 0 files merged, 0 files removed, 0 files unresolved
-user@my-workstation:~$ </computeroutput><userinput>cd hgadmin</userinput>
-<computeroutput>user@my-workstation:~/hgadmin$ </computeroutput><userinput>mkdir -p keys/users/other-user</userinput>
-<computeroutput>user@my-workstation:~/hgadmin$ </computeroutput><userinput>cp ~/other-users-key.pub keys/users/other-user/their-workstation</userinput>
-<computeroutput>user@my-workstation:~/hgadmin$ </computeroutput><userinput>hg add</userinput>
-<computeroutput>adding keys/users/other-user/their-workstation
-user@my-workstation:~/hgadmin$ </computeroutput><userinput>hg commit -m "Add other user"</userinput>
-<computeroutput>user@my-workstation:~/hgadmin$ </computeroutput><userinput>hg push</userinput>
+jay@my-workstation:~$ </computeroutput><userinput>cd hgadmin</userinput>
+<computeroutput>jay@my-workstation:~/hgadmin$ </computeroutput><userinput>mkdir -p keys/users/pat</userinput>
+<computeroutput>jay@my-workstation:~/hgadmin$ </computeroutput><userinput>cp ~/other-users-key.pub keys/users/pat/their-workstation</userinput>
+<computeroutput>jay@my-workstation:~/hgadmin$ </computeroutput><userinput>hg add</userinput>
+<computeroutput>adding keys/users/pat/their-workstation
+jay@my-workstation:~/hgadmin$ </computeroutput><userinput>hg commit -m "Add other jay"</userinput>
+<computeroutput>jay@my-workstation:~/hgadmin$ </computeroutput><userinput>hg push</userinput>
 <computeroutput>pushing to ssh://hg@repository-host/hgadmin
 searching for changes
 remote: adding changesets
 remote: adding manifests
 remote: adding file changes
 remote: added 1 changesets with 1 changes to 1 files
-user@my-workstation:~/hgadmin$ </computeroutput></screen>
+jay@my-workstation:~/hgadmin$ </computeroutput></screen>
 <para>
 The new user can now read and write to your
 <literal>ssh://hg@repository-host/repository/name</literal> repository.