[tor-commits] [stem/master] Keygen manual information

[atagar at torproject.org]

commit d0cad523579df662370123dc4a5471806eada39f
Author: Damian Johnson <atagar at torproject.org>
Date:   Thu Jan 28 08:59:46 2016 -0800

    Keygen manual information
    
    Quick update for https://trac.torproject.org/projects/tor/ticket/17583
---
 stem/cached_tor_manual.cfg |    7 ++++---
 1 file changed, 4 insertions(+), 3 deletions(-)

diff --git a/stem/cached_tor_manual.cfg b/stem/cached_tor_manual.cfg
index 2e35cad..4866251 100644
--- a/stem/cached_tor_manual.cfg
+++ b/stem/cached_tor_manual.cfg
@@ -6,8 +6,8 @@ description
 |Basically, Tor provides a distributed network of servers or relays ("onion routers"). Users bounce their TCP streams -- web traffic, ftp, ssh, etc. -- around the network, and recipients, observers, and even the relays themselves have difficulty tracking the source of the stream.
 |
 |By default, tor will only act as a client only. To help the network by providing bandwidth as a relay, change the ORPort configuration option -- see below. Please also consult the documentation on the Tor Project's website.
-man_commit 4f0e28977d6376ccba599e7089aeb9e3b4f25e5f
-stem_commit 3c7ea19c05dfb5c373cafd367e08741a79c8d9d3
+man_commit a5bed4dab2f8521f744d5137e4f439b073c7e5e9
+stem_commit 5b8b5ca5dc3cd2c0797c10910d6826e274651ff5
 commandline_options -f FILE => Specify a new configuration file to contain further Tor configuration options OR pass - to make Tor read its configuration from standard input. (Default: @CONFDIR@/torrc, or $HOME/.torrc if that file is not found)
 commandline_options --ignore-missing-torrc => Specifies that Tor should treat a missing torrc file as though it were empty. Ordinarily, Tor does this for missing default torrc files, but not for those specified on the command line.
 commandline_options --list-fingerprint => Generate your keys and output your nickname and fingerprint.
@@ -17,6 +17,7 @@ commandline_options --nt-service => Used internally to implement a Windows servi
 commandline_options --verify-config => Verify the configuration file is valid.
 commandline_options --service remove|start|stop => Remove, start, or stop a configured Tor Windows service.
 commandline_options --quiet|--hush => Override the default console log. By default, Tor starts out logging messages at level "notice" and higher to the console. It stops doing so after it parses its configuration, if the configuration tells it to log anywhere else. You can override this behavior with the --hush option, which tells Tor to only send warnings and errors to the console, or with the --quiet option, which tells Tor not to log to the console at all.
+commandline_options --keygen [--newpass] => Running "tor --keygen" creates a new ed25519 master identity key for a relay, or only a fresh temporary signing key and certificate, if you already have a master key. Optionally you can encrypt the master identity key with a passphrase: Tor will ask you for one. If you don't want to encrypt the master key, just don't enter any passphrase when asked. The --newpass option should be used with --keygen only when you need to add, change, or remove a passphrase on an existing ed25519 master identity key. You will be prompted for the old passphase (if any), and the new passphrase (if any). When generating a master key, you will probably want to use --DataDirectory to control where the keys and certificates will be stored, and --SigningKeyLifetime to control their lifetimes. Their behavior is as documented in the server options section below. (You must have write access to the specified DataDirectory.) To use the generated files, you must copy the
 m to the DataDirectory/keys directory of your Tor daemon, and make sure that they are owned by the user actually running the Tor daemon on your system.
 commandline_options --list-torrc-options => List all valid options.
 commandline_options --service install [--options command-line options] => Install an instance of Tor as a Windows service, with the provided command-line options. Current instructions can be found at https://www.torproject.org/docs/faq#NTService
 commandline_options --version => Display Tor version and exit.
@@ -1398,7 +1399,7 @@ config_options.OfflineMasterKey.category Relay
 config_options.OfflineMasterKey.name OfflineMasterKey
 config_options.OfflineMasterKey.usage 0|1
 config_options.OfflineMasterKey.summary Don't generate the master secret key
-config_options.OfflineMasterKey.description If non-zero, the Tor relay will never generate or load its master secret key. Instead, you'll have to use "tor --keygen" to manage the master secret key. (Default: 0)
+config_options.OfflineMasterKey.description If non-zero, the Tor relay will never generate or load its master secret key. Instead, you'll have to use "tor --keygen" to manage the permanent ed25519 master identity key, as well as the corresponding temporary signing keys and certificates. (Default: 0)
 config_options.HiddenServiceDir.category Hidden Service
 config_options.HiddenServiceDir.name HiddenServiceDir
 config_options.HiddenServiceDir.usage DIRECTORY