The descriptions will help users know what options to expect under each category. Firstly, add a brief description about each option category, such as, the Server Options, Client Options, and so on.Additionally, this format will make it easy for the TOR manual to be used as ‘man’ pages in future. By the end of this month, we will have a consistent format for documenting existing options and any new option in future. All the existing information about options needs to be reorganized using a template.

Currently, the options are not documented in a structured format and information about each option is presented in paragraphs that makes it hard to find information at a glance.

The purpose of the manual page must be to quickly answer questions about what each option does and how. For the sake of consistency and to keep the focus of this manual on configurations options, I think that the command-line options can be moved out of this page and can be linked to this page as a reference. Note: Currently, the TOR Manual also lists a set of command-line options. (We can include information from the introductory text under THE CONFIGURATION FILE FORMAT topic).

Overview – Add information about where TOR maintains the configuration for these different option categories, if they are all at once place, the name and default location of the configuration file, the rules to use the command options, and how can users modify these options.

By the end of this month, the users will be able to navigate to the different configuration categories on fingertips. The TOC will include an overview topic, and the headings of all the 9 categories of configuration options. Month 1:Ĭreate a table of contents for this page. This project will complete in 3 months and the following ideas are broken down by month. Project summary Open source organization: Tor Project Technical writer: Swati Thacker Project name: Rewrite the Tor manual page Project length: Long running (5 months) Project descriptionĪfter a discussion with the TOR mentors to understand what their expectations from this project are, I propose the following ideas to establish a consistent structure and format for the TOR Manual page ( ) in order to turn it into a useful, quick reference for users. This page contains the details of a technical writing project accepted for

Tor project online