Editing 1343: Manuals

{{comic
| number    = 1343
| date      = March 17, 2014
| title     = Manuals
| image     = manuals.png
| titletext = The most ridiculous offender of all is the sudoers man page, which for 15 years has started with a 'quick guide' to EBNF, a system for defining the grammar of a language. 'Don't despair', it says, 'the definitions below are annotated.'
}}

==Explanation==
The chart shows the quality of tools regarding their manual:
*If you don't even need a manual to use a certain tool, that tool tends to help solve problems effectively.
*If you do need a manual, the tool will probably solve the problems but you have to understand that manual before you can use this tool effectively.
*Much less helpful are the tools where you need a manual but it doesn't exist — these tools tend to create more problems than they solve.
*But the worst tools are where the manuals start with a description of the manual itself — which implies both that the tool is very complex and the manual is very hard to understand, or has low expectations of its viewers.

The title text refers to ''sudoers'', a config file for the unix command ''{{w|sudo}}''. ''sudo'' allows users to run a program with elevated permissions, as referenced in [[149: Sandwich]]. Man pages are collections of manuals for different tools, commands, files, and functions on Unix-like systems which can be viewed with the tool ''man''. You can type <code>man man</code> in a terminal to get the manpage for the manual program. See for instance also the comic [[912: Manual Override]].

The sudoers file specifies which users have sudo access, and which commands they are allowed to run as other users (typically root). The syntax of the file is very complex, and the manpage uses the {{w|Extended Backus–Naur Form}} (or EBNF) to describe the syntax. The sudoers man page starts off with an explanation of EBNF's grammar, which they reference throughout the rest of the man page in describing the syntax of the sudoers file. The [http://linux.die.net/man/5/sudoers sudoers man page] is very long, clocking in at 1504 lines. In contrast, the [http://linux.die.net/man/1/man manpages man page] only has 566 lines. The number of lines may differ between some distributions and versions.

The title text also notes that the manual's assurance, "don't despair" because "the definitions below are annotated", fails to be reassuring, and instead merely emphasizes the length and complexity of the document to read.

==Transcript==
:[A line graph evidently relating tools, their documentation, and their ability to solve problems.  There are four points on the line, one to the left and two to the right of a midpoint.]
: [label to left of midpoint] Solve problems
: [point to left of midpoint] Tools that don't need a manual
: [midpoint] Tools that need a manual
: [label to right of midpoint] Create problems
: [point to right of midpoint] Tools that need a manual but don't have one
: [point farther to right of midpoint] Tools whose manual starts with "How to read this manual"

{{comic discussion}}
[[Category:Charts]]
[[Category:Man pages]]