aboutsummaryrefslogtreecommitdiff
path: root/spec/control-spec
diff options
context:
space:
mode:
authorNick Mathewson <nickm@torproject.org>2023-10-14 18:52:20 -0400
committerNick Mathewson <nickm@torproject.org>2023-10-14 18:53:18 -0400
commit3457b0720834c8347d8318c1080ebc9486d77300 (patch)
treeb486a3d03fdfae7d98c4e6cf510179cf907c443f /spec/control-spec
parenta331e9f48790ad4beaba1ee443c5ad8b13d3afb4 (diff)
downloadtorspec-3457b0720834c8347d8318c1080ebc9486d77300.tar.gz
torspec-3457b0720834c8347d8318c1080ebc9486d77300.zip
Add short IDs for most long section names
I've left off sections that are headings for their whole document.
Diffstat (limited to 'spec/control-spec')
-rw-r--r--spec/control-spec/implementation-notes.md18
-rw-r--r--spec/control-spec/message-format.md6
-rw-r--r--spec/control-spec/replies.md58
3 files changed, 41 insertions, 41 deletions
diff --git a/spec/control-spec/implementation-notes.md b/spec/control-spec/implementation-notes.md
index 37ce9d6..ebbf113 100644
--- a/spec/control-spec/implementation-notes.md
+++ b/spec/control-spec/implementation-notes.md
@@ -64,7 +64,7 @@ or encoded in hexadecimal.
<a id="control-spec.txt-5.2"></a>
-## Don't let the buffer get too big
+## Don't let the buffer get too big { #buffer-size }
With old versions of Tor (before 0.2.0.16-alpha), if you ask for
lots of events, and 16MB of them queue up on the buffer, the Tor
@@ -76,7 +76,7 @@ of memory, so you should still be careful about buffer size.
<a id="control-spec.txt-5.3"></a>
-## Backward compatibility with v0 control protocol
+## Backward compatibility with v0 control protocol { #v0-compat }
The 'version 0' control protocol was replaced in Tor 0.1.1.x. Support
was removed in Tor 0.2.0.x. Every non-obsolete version of Tor now
@@ -90,7 +90,7 @@ This compatibility was removed in Tor 0.1.2.16 and 0.2.0.4-alpha.
<a id="control-spec.txt-5.4"></a>
-## Tor config options for use by controllers
+## Tor config options for use by controllers { #special-config-options }
Tor provides a few special configuration options for use by controllers.
These options are not saved to disk by SAVECONF. Most can be set and
@@ -188,7 +188,7 @@ to fill this gap, Tor will not correctly handle user requests.
<a id="control-spec.txt-5.5"></a>
-## Phases from the Bootstrap status event
+## Phases from the Bootstrap status event { #bootstrap-phases }
```text
[For the bootstrap phases reported by Tor prior to 0.4.0.x, see
@@ -209,7 +209,7 @@ fails.
<a id="control-spec.txt-5.5.1"></a>
-### Overview of Bootstrap reporting
+### Overview of Bootstrap reporting { #bootstrap-overview }
Bootstrap phases can be viewed as belonging to one of three stages:
@@ -244,7 +244,7 @@ connections to relays or bridges that it did not connect to in Stage
<a id="control-spec.txt-5.5.2"></a>
-### Phases in Bootstrap Stage 1
+### Phases in Bootstrap Stage 1 { #bootstrap-stage1 }
Phase 0:
tag=starting summary="Starting"
@@ -321,7 +321,7 @@ established.
<a id="control-spec.txt-5.5.3"></a>
-### Phases in Bootstrap Stage 2
+### Phases in Bootstrap Stage 2 { #bootstrap-stage2 }
```text
Phase 20:
@@ -408,7 +408,7 @@ indicate partial steps.
<a id="control-spec.txt-5.5.4"></a>
-### Phases in Bootstrap Stage 3
+### Phases in Bootstrap Stage 3 { #bootstrap-stage3 }
```text
Phase 76:
@@ -521,7 +521,7 @@ application connections now.
<a id="control-spec.txt-5.6"></a>
-## Bootstrap phases reported by older versions of Tor
+## Bootstrap phases reported by older versions of Tor { #bootstrap-obsolete }
These phases were reported by Tor older than 0.4.0.x. For newer
versions of Tor, see Section 5.5.
diff --git a/spec/control-spec/message-format.md b/spec/control-spec/message-format.md
index 5a1a6ad..a9af669 100644
--- a/spec/control-spec/message-format.md
+++ b/spec/control-spec/message-format.md
@@ -64,7 +64,7 @@ controller correctly.
<a id="control-spec.txt-2.2"></a>
-## Commands from controller to Tor
+## Commands from controller to Tor { #commands }
```text
Command = Keyword OptArguments CRLF / "+" Keyword OptArguments CRLF CmdData
@@ -81,7 +81,7 @@ their arguments are described below in section 3.
<a id="control-spec.txt-2.3"></a>
-## Replies from Tor to the controller
+## Replies from Tor to the controller { #replies }
```text
Reply = SyncReply / AsyncReply
@@ -109,7 +109,7 @@ the final line (usually "650 OK") omitted.\]
<a id="control-spec.txt-2.4"></a>
-## General-use tokens
+## General-use tokens { #tokens }
; CRLF means, "the ASCII Carriage Return character (decimal value 13)
; followed by the ASCII Linefeed character (decimal value 10)."
diff --git a/spec/control-spec/replies.md b/spec/control-spec/replies.md
index c7b1ab7..4046d6d 100644
--- a/spec/control-spec/replies.md
+++ b/spec/control-spec/replies.md
@@ -141,7 +141,7 @@ become a "MUST NOT".
<a id="control-spec.txt-4.1.1"></a>
-### Circuit status changed
+### Circuit status changed { #CIRC }
The syntax is:
@@ -301,7 +301,7 @@ The syntax is:
<a id="control-spec.txt-4.1.2"></a>
-### Stream status changed
+### Stream status changed { #STREAM }
The syntax is:
@@ -457,7 +457,7 @@ to talk to itself.
<a id="control-spec.txt-4.1.3"></a>
-### OR Connection status changed
+### OR Connection status changed { #ORCONN }
The syntax is:
@@ -530,7 +530,7 @@ events.
<a id="control-spec.txt-4.1.4"></a>
-### Bandwidth used in the last second
+### Bandwidth used in the last second { #BW }
The syntax is:
@@ -548,7 +548,7 @@ bandwidth this second (not implemented yet).\]
<a id="control-spec.txt-4.1.5"></a>
-### Log messages
+### Log messages { #LOG }
The syntax is:
@@ -570,7 +570,7 @@ events, to avoid modifying control output when debugging.
<a id="control-spec.txt-4.1.6"></a>
-### New descriptors available
+### New descriptors available { #NEWDESC }
This event is generated when new router descriptors (not microdescs or
extrainfos or anything else) are received.
@@ -587,7 +587,7 @@ Syntax:
<a id="control-spec.txt-4.1.7"></a>
-### New Address mapping
+### New Address mapping { #ADDRMAP }
These events are generated when a new address mapping is entered in
Tor's address map cache, or when the answer for a RESOLVE command is
@@ -630,7 +630,7 @@ the address was resolved.
<a id="control-spec.txt-4.1.8"></a>
-### Descriptors uploaded to us in our role as authoritative dirserver
+### Descriptors uploaded to us in our role as authoritative dirserver { #AUTHDIR_NEWDESCS}
\[NOTE: This feature was removed in Tor 0.3.2.1-alpha.\]
@@ -656,7 +656,7 @@ explaining why we chose the Action. (It doesn't contain newlines.)
<a id="control-spec.txt-4.1.9"></a>
-### Our descriptor changed
+### Our descriptor changed { #DESCCHANGED }
Syntax:
@@ -666,7 +666,7 @@ Syntax:
<a id="control-spec.txt-4.1.10"></a>
-### Status events
+### Status events { #STATUS }
Status events (STATUS_GENERAL, STATUS_CLIENT, and STATUS_SERVER) are sent
based on occurrences in the Tor process pertaining to the general state of
@@ -1111,7 +1111,7 @@ Actions for STATUS_GENERAL events can be as follows:
<a id="control-spec.txt-4.1.11"></a>
-### Our set of guard nodes has changed
+### Our set of guard nodes has changed { #GUARD }
Syntax:
@@ -1147,7 +1147,7 @@ The Status values are:
<a id="control-spec.txt-4.1.12"></a>
-### Network status has changed
+### Network status has changed { #NS }
Syntax:
@@ -1163,7 +1163,7 @@ down in our local status, for example based on connection attempts.
<a id="control-spec.txt-4.1.13"></a>
-### Bandwidth used on an application stream
+### Bandwidth used on an application stream { #STREAM_BW }
The syntax is:
@@ -1192,7 +1192,7 @@ or so on). They are not generated for exiting streams.
<a id="control-spec.txt-4.1.14"></a>
-### Per-country client stats
+### Per-country client stats { #CLIENTS_SEEN }
The syntax is:
@@ -1229,7 +1229,7 @@ in dir-spec.txt.
<a id="control-spec.txt-4.1.15"></a>
-### New consensus networkstatus has arrived
+### New consensus networkstatus has arrived { #NEWCONSENSUS }
The syntax is:
@@ -1247,7 +1247,7 @@ relay *not* mentioned in this list is implicitly no longer recommended.
<a id="control-spec.txt-4.1.16"></a>
-### New circuit buildtime has been set
+### New circuit buildtime has been set { #BUILDTIMEOUT_SET }
The syntax is:
@@ -1289,7 +1289,7 @@ this value to the nearest second before using it.
<a id="control-spec.txt-4.1.17"></a>
-### Signal received
+### Signal received { #SIGNAL }
The syntax is:
@@ -1313,7 +1313,7 @@ generate any event.
<a id="control-spec.txt-4.1.18"></a>
-### Configuration changed
+### Configuration changed { #CONF_CHANGED }
The syntax is:
@@ -1331,7 +1331,7 @@ Undefined configuration options contain only the KEYWORD.
<a id="control-spec.txt-4.1.19"></a>
-### Circuit status changed slightly
+### Circuit status changed slightly { #CIRC_MINOR }
The syntax is:
@@ -1360,7 +1360,7 @@ Other fields are as specified in section 4.1.1 above.
<a id="control-spec.txt-4.1.20"></a>
-### Pluggable transport launched
+### Pluggable transport launched { #TRANSPORT_LAUNCHED }
The syntax is:
@@ -1378,7 +1378,7 @@ The syntax is:
<a id="control-spec.txt-4.1.21"></a>
-### Bandwidth used on an OR or DIR or EXIT connection
+### Bandwidth used on an OR or DIR or EXIT connection { #CONN_BW }
The syntax is:
@@ -1411,7 +1411,7 @@ These events are only generated if TestingTorNetwork is set.
<a id="control-spec.txt-4.1.22"></a>
-### Bandwidth used by all streams attached to a circuit
+### Bandwidth used by all streams attached to a circuit { #CIRC_BW }
The syntax is:
@@ -1486,7 +1486,7 @@ were added in Tor 0.3.4.0-alpha\]
<a id="control-spec.txt-4.1.23"></a>
-### Per-circuit cell stats
+### Per-circuit cell stats { #CELL_STATS }
The syntax is:
@@ -1558,7 +1558,7 @@ cell. These events are only generated if TestingTorNetwork is set.
<a id="control-spec.txt-4.1.24"></a>
-### Token buckets refilled
+### Token buckets refilled { #TB_EMPTY }
The syntax is:
@@ -1607,7 +1607,7 @@ These events are only generated if TestingTorNetwork is set.
<a id="control-spec.txt-4.1.25"></a>
-### HiddenService descriptors
+### HiddenService descriptors { #HS_DESC }
The syntax is:
@@ -1681,7 +1681,7 @@ The syntax is:
<a id="control-spec.txt-4.1.26"></a>
-### HiddenService descriptors content
+### HiddenService descriptors content { #HS_DESC_CONTENT }
The syntax is:
@@ -1719,7 +1719,7 @@ this event will reply either the descriptor's content or an empty one.
<a id="control-spec.txt-4.1.27"></a>
-### Network liveness has changed
+### Network liveness has changed { #NETWORK_LIVENESS }
Syntax:
@@ -1735,7 +1735,7 @@ Syntax:
<a id="control-spec.txt-4.1.28"></a>
-### Pluggable Transport Logs
+### Pluggable Transport Logs { #PT_LOG }
Syntax:
@@ -1764,7 +1764,7 @@ Syntax:
<a id="control-spec.txt-4.1.29"></a>
-### Pluggable Transport Status
+### Pluggable Transport Status { #PT_STATUS }
Syntax: