Skip to content

Commit 9035a8e

Browse files
committed
Adding guidance for referencing man pages
1 parent 57d69e7 commit 9035a8e

File tree

1 file changed

+17
-0
lines changed

1 file changed

+17
-0
lines changed

supplementary_style_guide/style_guidelines/formatting.adoc

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,23 @@ Follow the _IBM Style_ guide advice of _day Month year_ for date formats, for ex
88

99
When the format _day Month year_ causes a presentation or clarity issue, use _Month day, year_ (for example, October 3, 2019) instead.
1010

11+
[[man-pages]]
12+
== Man page references
13+
14+
When referencing a man page in an "Additional resources" section, use the following format:
15+
16+
* `_<man_page_name>_(_<section_number>_)` man page on your system
17+
18+
Do not link to a website that contains the man page information. The contents of a man page might vary between systems or package versions, so users must run the `man` command on the target system to view the system-specific information for the named command or utility.
19+
20+
.Example: Single man page
21+
22+
* `sudoers(5)` man page on your system
23+
24+
.Example: Multiple man pages
25+
26+
* `nmcli(1)`, `nm-settings(5)`, and `sudoers(5)` man pages on your system
27+
1128
[[non-breaking-spaces]]
1229
== Non-breaking spaces
1330

0 commit comments

Comments
 (0)