Commit Graph

893 Commits

Author SHA1 Message Date
teor
51c76215db
doc: Minor man page fixes
Fix a client port list that's missing HTTPTunnelPort.

Wrap a long line.
2020-01-20 16:41:07 +10:00
teor
6898131b41
doc: Improve port flags in man page
Explain that:
* most flags default to off
* flags that default to on are specified

Document PreferIPv6Automap in its "No" form, because it's on by
default.

Cleanup after 32637.
2020-01-20 16:38:02 +10:00
teor
bf2a399fc0
config: Make clients tell dual-stack exits they prefer IPv6
Make Tor clients tell dual-stack exits that they prefer IPv6
connections.

This change is equivalent to setting the PreferIPv6 flag on
SOCKSPorts (and most other listener ports). Tor Browser has
been setting this flag for some time, and we want to remove a
client distinguisher at exits.

Also update the man page, putting all the IP flags in their
non-default forms.

Closes ticket 32637.
2020-01-20 16:36:58 +10:00
Neel Chauhan
8d288eb3a7 Deprecate the ClientAutoIPv6ORPort option 2020-01-13 14:55:16 -08:00
Nick Mathewson
8b46372f26 Merge branch 'pr_1643_squashed' 2020-01-13 13:26:23 -05:00
Taylor Yu
d99e7cebb9 manpage: group some SafeSocks-related options
Move some SafeSocks-related options near each other.  Part of ticket
32846.
2020-01-13 13:26:13 -05:00
Taylor Yu
cfd21cc213 manpge: reorder some padding-related options
Move ReducedCircuitPadding and ReducedConnectionPadding immediately
after the corresponding non-Reduced options.  Part of ticket 32846.
2020-01-13 13:26:13 -05:00
Taylor Yu
4e597673b7 manpage: GuardfractionFile is authority-only
Only directory authorities use the GuardfractionFile option, so move
it to that section.  Part of ticket 32846.
2020-01-13 13:26:13 -05:00
Swati Thacker
ec52c8ed69 manpage: alphabetize client options
Alphabetize client options in tor.1.txt.  Closes ticket32846.
2020-01-13 13:26:12 -05:00
Nick Mathewson
93894fb770 Merge branch 'ticket22029_attempt_squashed' 2020-01-09 15:27:32 -05:00
Neel Chauhan
84d8dd8314 Update tor.1 man page for Bug #22029 2020-01-09 15:27:26 -05:00
Nick Mathewson
1b63eea66c Merge branch 'haxxpop/tcp_proxy_squashed' into tcp_proxy_squshed_and_merged 2020-01-06 13:41:20 -05:00
Nick Mathewson
42e31b5c45 Mark TestingEstimatedDescriptorPropagationTime as obsolete.
We stopped looking at this option in 85cf6dcba3, back when we
implemented the minimal pieces of prop275.  Since then, we've had
code to validate and adjust this option, and to give it a different
value in testing networks, but the option hasn't actually done
anything.

We can safely mark it as OBSOLETE, since doing so does not make any
old configuration get rejected.

Closes ticket 32807.
2019-12-19 11:04:48 -05:00
Taylor Yu
616c0f823c
manpage: fixes to alphabetize General Options 2019-12-17 09:48:57 +10:00
Taylor Yu
645acaf138 manpage: fix some quoting
Fix some quoting, especially of constructs like "[address:]port", that
were proving tricky for Asciidoctor tooling to parse correctly.

Also fix formatting of some configuration variable names that
contained double underscores.  Neither asciidoc nor asciidoctor was
rendering some of those correctly.

Part of ticket 32708.
2019-12-12 11:19:35 -06:00
Taylor Yu
6f31d7e048 manpage: section titles to 1-line
Change the section title formatting to use the one-line format.  This
allows Asciidoctor-based tooling to parse it more easily.

Part of ticket 32708.
2019-12-12 10:44:21 -06:00
Taylor Yu
8dff1d342d manpage: indent linebreak markup
Indent the asciidoc markup for lone linebreaks to match the preceding
paragraph line, so that Asciidoctor tools can format them correctly.

Part of ticket 32708.
2019-12-12 10:44:21 -06:00
Taylor Yu
1e3f53d613 manpage: minor formatting fixes
These are unrelated changes done by Swati while doing the alphabetizing.

Part of ticket 32708.
2019-12-12 10:44:21 -06:00
Swati Thacker
21b3073b9a manpage: alphabetize General Options
Part of ticket 32708.
2019-12-12 10:44:21 -06:00
Nick Mathewson
d8ff7d0236 Merge branch 'reversible_3' 2019-11-21 07:49:18 -05:00
David Goulet
709d7fba11 hs-v3: Return bad address SOCKS5 extended error
If ExtendedErrors is set for the SocksPort, an invalid .onion address now
returns the 0xF6 error code per prop304.

Closes #30022

Signed-off-by: David Goulet <dgoulet@torproject.org>
2019-11-21 13:02:29 +02:00
Nick Mathewson
a30d143228 Make KeyDirectory's GroupReadable behave the same as CacheDirectory's.
In #26913 we solved a bug where CacheDirectoryGroupReadable would
override DataDirectoryGroupReadable when the two directories are the
same.  We never did the same for KeyDirectory, though, because
that's a rare setting.

Now that I'm testing this code, though, fixing this issue seems
fine.  Fixes bug #27992; bugfix on 0.3.3.1-alpha.
2019-11-20 09:26:47 -05:00
George Kadianakis
d28b6792cb Merge branch 'tor-github/pr/1423' 2019-11-18 19:06:53 +02:00
David Goulet
d60ed5a6a2 doc: Manpage entry for ExtendedErrors of prop304
Signed-off-by: David Goulet <dgoulet@torproject.org>
2019-11-18 19:06:43 +02:00
Nick Mathewson
6d9db29dda Document --dump-config.
Closes ticket 32467.
2019-11-12 08:19:35 -05:00
Nick Mathewson
32a2f96f82 Add the ability to fail when a hardware accelerator is missing.
Closes ticket 32406.
2019-11-07 07:28:43 -05:00
teor
40e75bc3e1
doc: Add defaults for some transport options 2019-10-31 11:27:26 +10:00
Taylor Yu
5e4ae73051 Reformat some options in tor.1.txt
Reformat command line options in tor.1.txt to display as fixed-width
in the HTML version.  Based on a patch by Swati Thacker.  Part of
ticket 32277.
2019-10-29 16:39:03 -05:00
Taylor Yu
8660a32d18 Reword command-options in tor.1.txt
Reword the COMMAND-LINE OPTIONS section of tor.1.txt.  Based on a
patch by Swati Thacker.  Part of ticket 32277.
2019-10-29 16:39:03 -05:00
Taylor Yu
90ba8bae3f Reword DESCRIPTION in tor.1.txt
Reword the DESCRIPTION section of tor.1.txt.

Based on a patch by Swati Thacker.  Part of ticket 32277.
2019-10-29 16:39:03 -05:00
Taylor Yu
4c38fccb9b Move command-line conf option description earlier
In tor.1.txt, move the paragraphs at the end of the COMMAND-LINE
OPTIONS section earlier.  This text describes how the user can specify
configuration options on the command line.

Also clarify some wording and formatting.

Based on a patch by Swati Thacker.  Part of ticket 32277.
2019-10-29 16:39:03 -05:00
Nick Mathewson
9a66b33229 A little more text in the SEE ALSO section. 2019-10-24 11:45:07 -04:00
Nick Mathewson
fefee871a6 Merge remote-tracking branch 'tor-github/pr/1437' 2019-10-24 11:44:19 -04:00
teor
9db1602ec5
Merge branch 'maint-0.4.2' 2019-10-23 08:47:30 +10:00
Philipp Winter
80a198928e
Remove outdated note.
BridgeDB supports bridge-distribution lines since version 0.5.0:
<https://bugs.torproject.org/23957>
2019-10-23 07:52:05 +10:00
Roger Dingledine
4233fb7014
clarify in man page: we count by powers of two
Make clear in the man page, in both the bandwidth section and the
accountingmax section, that Tor counts in powers of two, not
powers of ten: 1 GByte is 1024*1024*1024 bytes, not one billion
bytes.

Resolves ticket 32106.
2019-10-23 07:50:20 +10:00
Taylor Yu
6f8fad54fd Reword back matter of tor.1.txt
Reword the SEE ALSO and BUGS sections of tor.1.txt.  Based on a patch
by Swati Thacker.  Part of #32176.
2019-10-21 16:20:12 -05:00
Taylor Yu
8b9b51a6cb Reformat some file names in tor.1.txt
Reformat file name headings in the FILES section of tor.1.txt to
display as fixed-width in the HTML version.

Based on a patch by Swati Thacker.  Part of #32176.
2019-10-21 16:20:12 -05:00
Taylor Yu
e8fe6bd8d6 Reword FILES section of tor.1.txt
Reword the FILES section of tor.1.txt.  Based on a patch by Swati
Thacker.

Part of #32176.
2019-10-21 16:20:12 -05:00
Taylor Yu
a4e83cd5e5 Remove redundant FILES entry in tor.1.txt
There was a redundant entry for approved-routers in the FILES section
of tor.1.txt.

Part of #32176.
2019-10-21 16:20:12 -05:00
Suphanat Chunhapanya
1b07a2d7bf doc: Add TCPProxy option
TCPProxy is used for proxying all outgoing OR connections through some
proxy with the protocol specified in the option.
2019-10-17 15:33:16 +08:00
Roger Dingledine
71daad1692 never say XB, always XBytes
fix three more instances in the man page that we forgot to fix
in earlier attempts
2019-10-16 03:31:23 -04:00
David Goulet
1f60337da4 Merge branch 'tor-github/pr/1381' 2019-10-08 14:49:39 -04:00
George Kadianakis
723288a32f Improve v3 client auth documentation in the man page. 2019-10-01 13:39:34 +03:00
Nick Mathewson
6581f3e2fa Fix the documentation for GuardLifetime. 2019-09-30 14:54:52 -04:00
teor
102546f99f
doc: Document the signal-safe log behaviour in the tor man page
Part of 31389.
2019-09-24 15:03:17 +10:00
David Goulet
e5cf1423fd man: Entry for the HS intro DoS defenses
This also adds a "subsection" to the HIDDEN SERVICE OPTIONS section to
seperate per-service and per-instance options. It is a bit less messy this
way.

The HS DoS options are added to the per-service section.

Part of #30924

Signed-off-by: David Goulet <dgoulet@torproject.org>
2019-08-26 15:53:46 +03:00
teor
e87e34099c
Fix typos in HiddenServiceExportCircuitID
Closes bug 31418.
2019-08-15 18:58:10 +10:00
teor
f65f4b5c38
Merge remote-tracking branch 'tor-github/pr/1020' into maint-0.3.5 2019-08-12 09:49:53 +10:00
teor
a57e168caa
Merge remote-tracking branch 'tor-github/pr/741' into maint-0.3.5 2019-08-12 09:36:14 +10:00
George Kadianakis
15e28af2d1 Merge remote-tracking branch 'dgoulet/ticket31008_035_01' 2019-07-02 13:19:40 +03:00
David Goulet
f446db59e1 man: Fix -help typo to --help
Signed-off-by: David Goulet <dgoulet@torproject.org>
2019-06-27 14:52:12 -04:00
David Goulet
c34a6b922f Merge branch 'tor-github/pr/1129' 2019-06-27 10:19:45 -04:00
teor
362afa8c4e doc: update the man page entries for DirAuthority and FallbackDir
Improve the documentation for the DirAuthority and FallbackDir torrc
options.

Closes ticket 30955.
2019-06-27 10:19:40 -04:00
teor
872b85e689
Merge branch 'bug30956_041' into bug30956_master 2019-06-24 19:47:34 +10:00
teor
8356cc5b51 stats: Always publish pluggable transports in extra info documents
Always publish bridge pluggable transport information in the extra info
descriptor, even if ExtraInfoStatistics is 0. This information is
needed by BridgeDB.

Fixes bug 30956; bugfix on 0.4.1.1-alpha.
2019-06-24 19:44:24 +10:00
Iain R. Learmonth
58cb98af32 Prop 301: No longer vote on RecommendedPackages
This is the first half of implementing proposal 301. The
RecommendedPackages torrc option is marked as obsolete and
the test cases for the option removed. Additionally, the code relating
to generating and formatting package lines in votes is removed.

These lines may still appear in votes from other directory authorities
running earlier versions of the code and so consensuses may still
contain package lines. A new consensus method will be needed to stop
including package lines in consensuses.

Fixes: #28465
2019-05-16 13:31:54 +01:00
Nick Mathewson
1c95bdb83b Merge branch 'ticket30452_035_v3' into ticket30452_041_v3 2019-05-14 19:20:53 -04:00
Nick Mathewson
1b16fcb70c Add a --list-modules command
Closes ticket 30452.
2019-05-14 19:19:53 -04:00
Nick Mathewson
9ad2eb8f73 Merge branch 'bug28683_30173_29203_squashed' 2019-05-13 14:33:31 -04:00
Mike Perry
621ea2315b Bug 29203: Provide ReducedCircuitPadding torrc and consensus params 2019-05-13 14:30:35 -04:00
Mike Perry
f4064d6ce2 Bug 28693: Provide Torrc option to disable circuit padding. 2019-05-13 14:30:35 -04:00
Nick Mathewson
c8c64caf37 Merge remote-tracking branch 'tor-github/pr/923' 2019-05-06 17:16:37 -04:00
teor
231036a110
Merge branch 'maint-0.3.4' into maint-0.3.5 2019-04-19 12:00:41 +10:00
teor
b1762f8d12
Merge remote-tracking branch 'tor-github/pr/638' into maint-0.3.4 2019-04-19 11:44:38 +10:00
Neel Chauhan
caa55a6d37 Grammar fixes for IPv6Exit in tor.1.txt 2019-04-17 21:41:31 -04:00
Neel Chauhan
cfada969a9 Update tor.1 man page for IPv6Exit 2019-04-17 07:26:55 -04:00
Nick Mathewson
f8dc935fb7 Merge remote-tracking branch 'tor-github/pr/741' 2019-04-11 14:27:06 -04:00
teor
8cfab3b7c3
doc: Improve the documentation for MapAddress .exit
Fixes bug 30109; bugfix on 0.1.0.1-rc.
2019-04-10 17:43:59 +10:00
teor
3d45079c27
Merge branch 'maint-0.4.0' 2019-04-09 11:36:59 +10:00
rl1987
61e6b217c5
manpage: Clarify that Tor does stream isolation between *Port listeners by default
cherry-pick of tor-github/pr/841 to maint-0.4.0.
2019-04-09 11:34:51 +10:00
George Kadianakis
574c207670 Merge branch 'maint-0.4.0' 2019-04-05 14:51:33 +03:00
Nick Mathewson
d194f6bedf Implement an DormantCanceledByStartup option
Closes ticket 29357, and comes with appropriate notions of caution.
2019-04-04 11:48:36 -04:00
Nick Mathewson
a47b61f329 Merge branch 'messaging_v3' into messaging_v3_merged 2019-03-26 20:13:49 -04:00
George Kadianakis
d11976b8bd Merge branch 'tor-github/pr/709' 2019-03-26 15:34:54 +02:00
Nick Mathewson
0944500a8e Add MESG as a new log domain. 2019-03-25 16:35:33 -04:00
rl1987
27eec50527 manpage: fix formatting of example on quoting options with spaces 2019-03-03 11:51:08 +02:00
teor
9b7cdd23de
doc: update the man page and sample torrc for ExitRelay
We changed the default of ExitRelay in #21530 in 0.3.5.1-alpha, but
forgot to update the documentation.

Closes 29612.
2019-02-28 11:22:20 +10:00
David Goulet
a5dd41b9af Merge branch 'tor-github/pr/638' into maint-0.4.0 2019-02-26 11:24:43 -05:00
teor
a798bd40fb stats: Stop reporting statistics when ExtraInfoStatistics is 0
When ExtraInfoStatistics is 0, stop including bandwidth usage statistics,
GeoIPFile hashes, ServerTransportPlugin lines, and bridge statistics
by country in extra-info documents.

Fixes bug 29018; bugfix on 0.2.4.1-alpha (and earlier versions).
2019-02-19 19:01:44 +10:00
teor
361738c964 Merge branch 'bug29017-033' into bug29017-master-merge 2019-02-19 18:59:16 +10:00
rl1987
58cbe51708 Use RFC5737-compliant example IP addresses in manpage when describing MapAddress 2019-01-30 17:13:40 +02:00
Nick Mathewson
0ce4d23af5 Merge branch 'maint-0.3.5' 2019-01-22 08:04:55 -05:00
Nick Mathewson
7c6a8c674b Fix documentation for ClientAuth on HSv3.
The manpage erroneously said "privkey" when "public-key" would have
been correct.  Reported by "Felixix" as ticket 28979. Bugfix on
0.3.5.1-alpha.
2019-01-16 16:10:20 -05:00
Nick Mathewson
b169c8c14f Merge remote-tracking branch 'asn-github/adaptive_padding-final' 2019-01-14 14:48:00 -05:00
George Kadianakis
2b29bccb85 Misc trivial improvements around circpadding code. 2019-01-10 13:06:08 +02:00
teor
85c598cbc2 stats: Make PaddingStatistics depend on ExtraInfoStatistics
When ExtraInfoStatistics is 0, stop including PaddingStatistics in
relay and bridge extra-info documents.

Fixes bug 29017; bugfix on 0.3.1.1-alpha.
2019-01-08 18:21:10 +10:00
Mike Perry
8ad497bb57 Config option to specify specific MiddleNodes.
Hope is this will make it easier to test on the live tor network.

Does not need to be merged if we don't want to, but will come in handy
for researchers.

Co-authored-by: George Kadianakis <desnacked@riseup.net>
2019-01-02 15:25:55 +02:00
rl1987
8eadfad71d Tweak ControlPort description in manpage 2018-12-23 19:58:25 +02:00
Taylor Yu
b0f974633a Add LD_BTRACK log domain for bootstrap tracker
Part of ticket 27167.
2018-12-20 18:46:17 -06:00
Nick Mathewson
0e6e902cbc Merge branch 'document_--version' 2018-12-20 11:50:48 -05:00
Nick Mathewson
4d9b55907c Even more clarify on --version. 2018-12-20 11:50:40 -05:00
Nick Mathewson
508837b62b Document the output of --version
Closes 28889
2018-12-17 17:54:01 -05:00
Nick Mathewson
e969d9c6b4 Merge branch 'ticket28179_squashed' into ticket28179_squashed_merged 2018-12-17 16:41:01 -05:00
Alexander Færøy
ad4cc89c5d Add "PT" log domain.
See: https://bugs.torproject.org/28179
2018-12-17 16:39:28 -05:00
Nick Mathewson
69264f96f3 Merge branch 'dormant_persist_squashed' 2018-12-13 08:26:10 -05:00
David Goulet
53855d72b7 man: Add that "GETINFO address" won't work with "Sandbox 1"
Patch by "wagon".

Closes #28538

Signed-off-by: David Goulet <dgoulet@torproject.org>
2018-12-12 13:23:46 -05:00
Nick Mathewson
4002a84ffe Merge remote-tracking branch 'tor-github/pr/561' 2018-12-05 08:29:41 -05:00
David Goulet
8506dcdeb7 Merge branch 'maint-0.3.5' 2018-12-04 12:55:02 -05:00
Nick Mathewson
4f55884315 Add an option to start tor in dormant mode for the first time. 2018-12-04 12:08:24 -05:00