From: david-sarah Date: Thu, 22 Mar 2012 22:05:34 +0000 (+0000) Subject: Cosmetic formatting in docs. X-Git-Url: https://git.rkrishnan.org/pf/content/en/seg/?a=commitdiff_plain;h=c5e10e2261f4737582a18b718ff88e0a2807046a;p=tahoe-lafs%2Ftahoe-lafs.git Cosmetic formatting in docs. --- diff --git a/docs/configuration.rst b/docs/configuration.rst index 2425500b..0c6ede0b 100644 --- a/docs/configuration.rst +++ b/docs/configuration.rst @@ -440,8 +440,9 @@ Storage Server Configuration If provided, this value defines how much disk space is reserved: the storage server will not accept any share that causes the amount of free disk space to drop below this value. (The free space is measured by a - call to statvfs(2) on Unix, or GetDiskFreeSpaceEx on Windows, and is the - space available to the user account under which the storage server runs.) + call to ``statvfs(2)`` on Unix, or ``GetDiskFreeSpaceEx`` on Windows, and + is the space available to the user account under which the storage server + runs.) This string contains a number, with an optional case-insensitive scale suffix like "K" or "M" or "G", and an optional "B" or "iB" suffix. So diff --git a/docs/frontends/FTP-and-SFTP.rst b/docs/frontends/FTP-and-SFTP.rst index ed881be6..763c4b2e 100644 --- a/docs/frontends/FTP-and-SFTP.rst +++ b/docs/frontends/FTP-and-SFTP.rst @@ -71,7 +71,7 @@ The words "ssh-rsa" and "ssh-dsa" after the username are reserved to specify the public key format, so users cannot have a password equal to either of these strings. -Now add an 'accounts.file' directive to your tahoe.cfg file, as described in +Now add an ``accounts.file`` directive to your ``tahoe.cfg`` file, as described in the next sections. Running An Account Server (accounts.url) @@ -123,7 +123,7 @@ the server to only accept connections from localhost. You will use directives in the tahoe.cfg file to tell the SFTP code where to find these keys. To create one, use the ``ssh-keygen`` tool (which comes with -the standard openssh client distribution):: +the standard OpenSSH client distribution):: % cd BASEDIR % ssh-keygen -f private/ssh_host_rsa_key @@ -224,10 +224,10 @@ writeable directory. This does not prevent the directory entry from being unlinked or replaced. When using sshfs, the 'no-write' field can be set by clearing the 'w' bits in -the Unix permissions, for example using the command 'chmod 444 -path/to/file'. Note that this does not mean that arbitrary combinations of -Unix permissions are supported. If the 'w' bits are cleared on a link to a -mutable file or directory, that link will become read-only. +the Unix permissions, for example using the command ``chmod 444 path/to/file``. +Note that this does not mean that arbitrary combinations of Unix permissions +are supported. If the 'w' bits are cleared on a link to a mutable file or +directory, that link will become read-only. If SFTP is used to write to an existing mutable file, it will publish a new version when the file handle is closed.