Opened 9 months ago

Closed 9 months ago

#29635 closed defect (fixed)

tor man page screws up quotes when telling you to use quotes for command line

Reported by: arma Owned by:
Priority: Medium Milestone: Tor: 0.4.1.x-final
Component: Core Tor/Tor Version:
Severity: Normal Keywords: tor-doc
Cc: Actual Points:
Parent ID: Points:
Reviewer: ahf Sponsor:

Description

tor.1.txt says

You will need to
quote options with spaces in them: if you want Tor to log all debugging
messages to debug.log, you will probably need to say --Log 'debug file
debug.log'.

which results in a man page that says

       You will need to quote options with spaces in them:
       if you want Tor to log all debugging messages to debug.log, you will
       probably need to say --Log debug file debug.log.

which sure isn't going to help anybody.

Changing both the ' to " seems like it resolves it.

The bad quotes went in during commit f5e86bc.

Child Tickets

Change History (6)

comment:1 in reply to:  description Changed 9 months ago by arma

Replying to arma:

Changing both the ' to " seems like it resolves it.

Actually, the ' does something -- it makes the arguments underlined.

If we want to keep that (I don't know man page conventions) then here is the fix:

-messages to debug.log, you will probably need to say --Log 'debug file
-debug.log'.
+messages to debug.log, you will probably need to say --Log "'debug file
+debug.log'".

comment:2 Changed 9 months ago by rl1987

Status: newneeds_review

comment:3 Changed 9 months ago by rl1987

I'm using back-ticks because they're already used on another example further down in the manpage.

comment:4 Changed 9 months ago by dgoulet

Keywords: tor-doc added
Milestone: Tor: 0.4.1.x-final
Reviewer: ahf

comment:5 Changed 9 months ago by ahf

Status: needs_reviewmerge_ready

LGTM.

comment:6 Changed 9 months ago by nickm

Resolution: fixed
Status: merge_readyclosed

merged!

Note: See TracTickets for help on using tickets.