Browse Source

man: Add a comment to anchor only option

Some anchor don't appear in the final man page so document those so we
understand why we do that in the future.

Part of #25582

Signed-off-by: David Goulet <dgoulet@torproject.org>
David Goulet 7 years ago
parent
commit
ff38c0589c
1 changed files with 4 additions and 0 deletions
  1. 4 0
      doc/tor.1.txt

+ 4 - 0
doc/tor.1.txt

@@ -1203,6 +1203,7 @@ The following options are useful only for clients (that is, if
         on different SocksPorts, TransPorts, etc are always isolated from one
         on different SocksPorts, TransPorts, etc are always isolated from one
         another. This option overrides that behavior.)
         another. This option overrides that behavior.)
 
 
+// Anchor only for formatting, not visible in the man page.
 [[OtherSocksPortFlags]]::
 [[OtherSocksPortFlags]]::
     Other recognized __flags__ for a SocksPort are:
     Other recognized __flags__ for a SocksPort are:
     **NoIPv4Traffic**;;
     **NoIPv4Traffic**;;
@@ -1267,6 +1268,7 @@ The following options are useful only for clients (that is, if
         authentication" when IsolateSOCKSAuth is disabled, or when this
         authentication" when IsolateSOCKSAuth is disabled, or when this
         option is set.
         option is set.
 
 
+// Anchor only for formatting, not visible in the man page.
 [[SocksPortFlagsMisc]]::
 [[SocksPortFlagsMisc]]::
     Flags are processed left to right. If flags conflict, the last flag on the
     Flags are processed left to right. If flags conflict, the last flag on the
     line is used, and all earlier flags are ignored. No error is issued for
     line is used, and all earlier flags are ignored. No error is issued for
@@ -1904,6 +1906,7 @@ is non-zero):
        reject *:6881-6999
        reject *:6881-6999
        accept *:*
        accept *:*
 
 
+// Anchor only for formatting, not visible in the man page.
 [[ExitPolicyDefault]]::
 [[ExitPolicyDefault]]::
     Since the default exit policy uses accept/reject *, it applies to both
     Since the default exit policy uses accept/reject *, it applies to both
     IPv4 and IPv6 addresses.
     IPv4 and IPv6 addresses.
@@ -2079,6 +2082,7 @@ is non-zero):
         If the address is absent, or resolves to both an IPv4 and an IPv6
         If the address is absent, or resolves to both an IPv4 and an IPv6
         address, only listen to the IPv6 address.
         address, only listen to the IPv6 address.
 
 
+// Anchor only for formatting, not visible in the man page.
 [[ORPortFlagsExclusive]]::
 [[ORPortFlagsExclusive]]::
     For obvious reasons, NoAdvertise and NoListen are mutually exclusive, and
     For obvious reasons, NoAdvertise and NoListen are mutually exclusive, and
     IPv4Only and IPv6Only are mutually exclusive.
     IPv4Only and IPv6Only are mutually exclusive.