Skip to content

Commit

Permalink
Add item to docs/TODO.md regarding formatting conventions in man pages
Browse files Browse the repository at this point in the history
  • Loading branch information
craigbarnes committed Dec 21, 2024
1 parent ee8c21c commit f539b0d
Showing 1 changed file with 10 additions and 0 deletions.
10 changes: 10 additions & 0 deletions docs/TODO.md
Original file line number Diff line number Diff line change
Expand Up @@ -152,6 +152,16 @@ Features
Documentation
-------------

* Briefly describe formatting conventions used in "COMMANDS" section of
`dterc(5)` man page (and also cross-reference `man(1)`, where similar
conventions are mentioned):
* **Bold**: Type exactly as shown
* _Italic_ (or underline, in `roff(7)`): Replace with appropriate argument
* `[-abc]`: Any or all arguments within `[ ]` are optional
* `-a|-b`: Options delimited by `|` cannot be used together
* `argument ...`: Argument is repeatable
* `[expression] ...`: Entire expression within `[ ]` is repeatable

* Improve documentation for [`search`] command

* For the [`hi`] command, mention that `gray`, `darkgray` and `white` are
Expand Down

0 comments on commit f539b0d

Please sign in to comment.