Opened 8 years ago

Last modified 2 years ago

#4310 new task

Reorder tor manpage entries within sections

Reported by: arma Owned by:
Priority: Medium Milestone: Tor: unspecified
Component: Core Tor/Tor Version:
Severity: Normal Keywords: documentation tor-client manpage easy
Cc: Actual Points:
Parent ID: Points: 3
Reviewer: Sponsor:

Description

Once upon a time the man page entries were alphabetical. Then we started adding a few near the other ones when it made sense. Now it's a mishmash of alphabetical-except-when-we-decided-not-to-do-it-that-way.

We should take a step back and think about a way to organize the options into categories so it's possible to a) get a sense of what all you can configure, and b) find the thing you're looking for.

Child Tickets

Change History (5)

comment:1 Changed 8 years ago by atagar

This isn't entirely right - the man page is organized by categories. I have some interest in this since arm scrapes the man page's content, though worst case scenario is that arm falls back to the bundled configuration information.

I've filtered the options down to a few for a 'config.important' flag (totally subjective) and written short summaries for all of the options (accuracy may vary due to some very cryptic man descriptions) in case that helps:
https://gitweb.torproject.org/arm.git/blob/HEAD:/src/settings.cfg

comment:2 Changed 8 years ago by nickm

Keywords: documentation added
Milestone: Tor: unspecified

comment:3 Changed 7 years ago by nickm

Keywords: tor-client added

comment:4 Changed 7 years ago by nickm

Component: Tor ClientTor

comment:5 Changed 2 years ago by nickm

Keywords: manpage easy added
Points: 3
Severity: Normal
Summary: Order of Tor man page entries is confusingReorder tor manpage entries within sections
Type: defecttask

I think the a little work here might go a long way.

If you want to submit a patch, please make sure that it does nothing else besides reorder the manpage entries; otherwise, it will be hard to review.

Note: See TracTickets for help on using tickets.