Is there a specification for a man page's SYNOPSIS section?
I'm trying to write some specifications to be shared between a small team and getting picky about the format I put some command listings in. Is there any formal definition of the syntax used in the SYNOPSIS section of man pages?
From the Wikimedia Commons, here's an example of a man page with the SYNOPSIS section I'm talking about, where the command is listed with the required and optional arguments it understands.
There is no formal definition of a manpage anywhere, not even in the POSIX standard. The man(1) manpage in your example is pretty typical: you write out the various ways a program can be used (often just one) with [] denoting optional, bold (or typewriter font with the mdoc macros) denoting literal command line input and italics denoting variables.
The manpages man(7) and mdoc(7) will explain the most important conventions. man(7) is for old-style Unix manpages and is still popular on Linux (see man-pages(7)); mdoc(7) comes from 4.4BSD and is popular in its derivatives. The latter maintains a stricter separation of content and presentation and can produce (IMHO) prettier PDF/HTML output
- Fatal error - Parse error: syntax error, unexpected ':', expecting - Wordpress
- logicals operators long and short forms on vectors
- No Multiline Lambda in Python: Why not?
- What does the symbol ::: mean in R
- QueryDSL and SubQuery with Tuple condition
- Defining bareword operators in Raku
- Is it possible to use a C like array in C#?
- What is the syntax for a multiline string literal?
- How to convert Set to Array?
- What actually happens when we put conditions without [] (brackets) in if else block in a bash script?
- Use of Union with reference
- How do I break a string in YAML over multiple lines?
- Proper syntax in redshift sql for "schema"."table"."field"?
- int a[] = {1,2,}; Why is a trailing comma in an initializer-list allowed?
- Python invalid syntax on a string?
- Kotlin: conditional items during map creation
- how do I pass a range of values on the command line - passing an expression as an argument
- Why does int **a = &(&val); result in an error in C++?
- Clarity on Java Lambda Syntax
- What does "static" mean in C?
- `/` vs `//` for division in Python
- Kotlin asterisk operator before variable name or Spread Operator in Kotlin
- Why can hexadecimal python integers access properties but not regular ints?
- Pitfalls with using scientific notation in JavaScript
- How to concatenate string variables in Bash
- Double underscore in PHP
- What's the difference between arguments with default values and keyword-arguments?
- syntaxerror: "unexpected character after line continuation character in python" math
- I'm getting an IndentationError (or a TabError). How do I fix it?
- Testing for equality between a uint8_t and an inverted uint8_t does not work as expected