aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--control-spec.txt16
1 files changed, 15 insertions, 1 deletions
diff --git a/control-spec.txt b/control-spec.txt
index 808e161..e38daf2 100644
--- a/control-spec.txt
+++ b/control-spec.txt
@@ -388,15 +388,23 @@
3.6. SAVECONF
Sent from the client to the server. The syntax is:
- "SAVECONF" CRLF
+ "SAVECONF" [SP "FORCE"] CRLF
Instructs the server to write out its config options into its torrc. Server
returns "250 OK" if successful, or "551 Unable to write configuration
to disk" if it can't write the file or some other error occurs.
+ If the %include option is used on torrc, SAVECONF will not write the
+ configuration to disk. If the flag string "FORCE" is provided, the
+ configuration will be overwritten even if %include is used. Using %include
+ on defaults-torrc does not affect SAVECONF. (Introduced in 0.3.1.1-alpha.)
+
See also the "getinfo config-text" command, if the controller wants
to write the torrc file itself.
+ See also the "getinfo config-can-saveconf" command, to tell if the FORCE
+ flag will be required. (Also introduced in 0.3.1.1-alpha.)
+
3.7. SIGNAL
Sent from the client to the server. The syntax is:
@@ -1003,6 +1011,12 @@
consensus, base-64 encoded. An empty value means that either
the consensus has no shared random value, or Tor has no consensus.
+ [New in Tor 0.3.1.0-alpha.]
+
+ "config-can-saveconf"
+ 0 or 1, depending on whether it is possile to use SAVECONF without the
+ FORCE flag. (Introduced in 0.3.1.1-alpha.)
+
Examples:
C: GETINFO version desc/name/moria1
S: 250+desc/name/moria=