diff options
Diffstat (limited to 'spec/pt-spec/pluggable-transport-to-parent-process-communication.md')
| -rw-r--r-- | spec/pt-spec/pluggable-transport-to-parent-process-communication.md | 16 |
1 files changed, 8 insertions, 8 deletions
diff --git a/spec/pt-spec/pluggable-transport-to-parent-process-communication.md b/spec/pt-spec/pluggable-transport-to-parent-process-communication.md index 985bcb5..21fd18b 100644 --- a/spec/pt-spec/pluggable-transport-to-parent-process-communication.md +++ b/spec/pt-spec/pluggable-transport-to-parent-process-communication.md @@ -83,7 +83,7 @@ respond with an error message and terminate. The "ENV-ERROR" message is used to signal the PT proxy's failure to parse the configuration environment variables (3.2). -The <ErrorMessage> SHOULD consist of a useful error message +The `<ErrorMessage>` SHOULD consist of a useful error message that can be used to diagnose and correct the root cause of the failure. @@ -111,7 +111,7 @@ PROXY DONE The "PROXY DONE" message is used to signal the PT proxy's acceptance of the upstream proxy specified by "TOR_PT_PROXY". -PROXY-ERROR <ErrorMessage> +`PROXY-ERROR <ErrorMessage>` The "PROXY-ERROR" message is used to signal that the upstream proxy is malformed/unsupported or otherwise unusable. @@ -130,7 +130,7 @@ and initialize the listeners. For each transport initialized, the PT proxy reports the listener status back to the parent via messages to stdout. -CMETHOD <transport> <'socks4','socks5'> <address:port> +`CMETHOD <transport> <'socks4','socks5'> <address:port>` The "CMETHOD" message is used to signal that a requested PT transport has been launched, the protocol which the parent @@ -139,9 +139,9 @@ and port that the PT transport's forward proxy is listening on. Example: -CMETHOD trebuchet socks5 127.0.0.1:19999 +`CMETHOD trebuchet socks5 127.0.0.1:19999` -CMETHOD-ERROR <transport> <ErrorMessage> +`CMETHOD-ERROR <transport> <ErrorMessage>` The "CMETHOD-ERROR" message is used to signal that requested PT transport was unable to be launched. @@ -186,7 +186,7 @@ in "TOR_PT_CLIENT_TRANSPORTS" and initialize the listeners. For each transport initialized, the PT proxy reports the listener status back to the parent via messages to stdout. -SMETHOD <transport> <address:port> [options] +`SMETHOD <transport> <address:port> [options]` The "SMETHOD" message is used to signal that a requested PT transport has been launched, the protocol which will be @@ -202,7 +202,7 @@ per-transport information back to the parent process. The currently recognized 'options' are: -ARGS:[<Key>=<Value>,]+[<Key>=<Value>] +`ARGS:[<Key>=<Value>,]+[<Key>=<Value>]` ```text The "ARGS" option is used to pass additional key/value @@ -264,7 +264,7 @@ The format of the message: `LOG SEVERITY=Severity MESSAGE=Message` The SEVERITY value indicate at which logging level the message applies. -The accepted values for <Severity> are: error, warning, notice, info, debug +The accepted values for `<Severity>` are: error, warning, notice, info, debug The MESSAGE value is a human readable string formatted by the PT. The `<Message>` contains the log message which can be a String or CString (see |