Path: blob/main/documentation/content/en/books/fdp-primer/manual-pages/_index.po
18099 views
# SOME DESCRIPTIVE TITLE # Copyright (C) YEAR The FreeBSD Project # This file is distributed under the same license as the FreeBSD Documentation package. # FIRST AUTHOR <EMAIL@ADDRESS>, YEAR. # #, fuzzy msgid "" msgstr "" "Project-Id-Version: FreeBSD Documentation VERSION\n" "POT-Creation-Date: 2025-08-17 20:54+0100\n" "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n" "Last-Translator: FULL NAME <EMAIL@ADDRESS>\n" "Language-Team: LANGUAGE <[email protected]>\n" "Language: \n" "MIME-Version: 1.0\n" "Content-Type: text/plain; charset=UTF-8\n" "Content-Transfer-Encoding: 8bit\n" #. type: YAML Front Matter: description #: documentation/content/en/books/fdp-primer/manual-pages/_index.adoc:1 #, no-wrap msgid "How to work with the FreeBSD Manual Pages" msgstr "" #. type: YAML Front Matter: title #: documentation/content/en/books/fdp-primer/manual-pages/_index.adoc:1 #, no-wrap msgid "Chapter 11. Manual Pages" msgstr "" #. type: Title = #: documentation/content/en/books/fdp-primer/manual-pages/_index.adoc:14 #, no-wrap msgid "Manual Pages" msgstr "" #. type: Title == #: documentation/content/en/books/fdp-primer/manual-pages/_index.adoc:52 #, no-wrap msgid "Introduction" msgstr "" #. type: Plain text #: documentation/content/en/books/fdp-primer/manual-pages/_index.adoc:56 msgid "" "_Manual pages_, commonly shortened to _man pages_, were conceived as readily-" "available reminders for command syntax, device driver details, or " "configuration file formats. They have become an extremely valuable quick-" "reference from the command line for users, system administrators, and " "programmers." msgstr "" #. type: Plain text #: documentation/content/en/books/fdp-primer/manual-pages/_index.adoc:58 msgid "" "Although intended as reference material rather than tutorials, the EXAMPLES " "sections of manual pages often provide detailed use case." msgstr "" #. type: Plain text #: documentation/content/en/books/fdp-primer/manual-pages/_index.adoc:62 msgid "" "Manual pages are generally shown interactively by the man:man[1] command. " "When the user types `man ls`, a search is performed for a manual page " "matching `ls`. The first matching result is displayed." msgstr "" #. type: Title == #: documentation/content/en/books/fdp-primer/manual-pages/_index.adoc:64 #, no-wrap msgid "Sections" msgstr "" #. type: Plain text #: documentation/content/en/books/fdp-primer/manual-pages/_index.adoc:68 msgid "" "Manual pages are grouped into _sections_. Each section contains manual " "pages for a specific category of documentation:" msgstr "" #. type: Table #: documentation/content/en/books/fdp-primer/manual-pages/_index.adoc:73 #, no-wrap msgid "Section Number" msgstr "" #. type: Table #: documentation/content/en/books/fdp-primer/manual-pages/_index.adoc:76 #, no-wrap msgid "Category" msgstr "" #. type: Table #: documentation/content/en/books/fdp-primer/manual-pages/_index.adoc:77 #, no-wrap msgid "1" msgstr "" #. type: Table #: documentation/content/en/books/fdp-primer/manual-pages/_index.adoc:79 #, no-wrap msgid "General Commands" msgstr "" #. type: Table #: documentation/content/en/books/fdp-primer/manual-pages/_index.adoc:80 #, no-wrap msgid "2" msgstr "" #. type: Table #: documentation/content/en/books/fdp-primer/manual-pages/_index.adoc:82 #, no-wrap msgid "System Calls" msgstr "" #. type: Table #: documentation/content/en/books/fdp-primer/manual-pages/_index.adoc:83 #, no-wrap msgid "3" msgstr "" #. type: Table #: documentation/content/en/books/fdp-primer/manual-pages/_index.adoc:85 #, no-wrap msgid "Library Functions" msgstr "" #. type: Table #: documentation/content/en/books/fdp-primer/manual-pages/_index.adoc:86 #, no-wrap msgid "4" msgstr "" #. type: Table #: documentation/content/en/books/fdp-primer/manual-pages/_index.adoc:88 #, no-wrap msgid "Kernel Interfaces" msgstr "" #. type: Table #: documentation/content/en/books/fdp-primer/manual-pages/_index.adoc:89 #, no-wrap msgid "5" msgstr "" #. type: Table #: documentation/content/en/books/fdp-primer/manual-pages/_index.adoc:91 #, no-wrap msgid "File Formats" msgstr "" #. type: Table #: documentation/content/en/books/fdp-primer/manual-pages/_index.adoc:92 #, no-wrap msgid "6" msgstr "" #. type: Table #: documentation/content/en/books/fdp-primer/manual-pages/_index.adoc:94 #, no-wrap msgid "Games" msgstr "" #. type: Table #: documentation/content/en/books/fdp-primer/manual-pages/_index.adoc:95 #, no-wrap msgid "7" msgstr "" #. type: Table #: documentation/content/en/books/fdp-primer/manual-pages/_index.adoc:97 #, no-wrap msgid "Miscellaneous" msgstr "" #. type: Table #: documentation/content/en/books/fdp-primer/manual-pages/_index.adoc:98 #, no-wrap msgid "8" msgstr "" #. type: Table #: documentation/content/en/books/fdp-primer/manual-pages/_index.adoc:100 #, no-wrap msgid "System Manager" msgstr "" #. type: Table #: documentation/content/en/books/fdp-primer/manual-pages/_index.adoc:101 #, no-wrap msgid "9" msgstr "" #. type: Table #: documentation/content/en/books/fdp-primer/manual-pages/_index.adoc:102 #, no-wrap msgid "Kernel Developer" msgstr "" #. type: Title == #: documentation/content/en/books/fdp-primer/manual-pages/_index.adoc:105 #, no-wrap msgid "Markup" msgstr "" #. type: Plain text #: documentation/content/en/books/fdp-primer/manual-pages/_index.adoc:113 msgid "" "Various markup forms and rendering programs have been used for manual " "pages. FreeBSD has used man:groff[7] and the newer man:mandoc[1]. Most " "existing FreeBSD manual pages, and all new ones, use the man:mdoc[7] form of " "markup. This is a simple line-based markup that is reasonably expressive. " "It is mostly semantic: parts of text are marked up for what they are, rather " "than for how they should appear when rendered. There is some appearance-" "based markup which is usually best avoided." msgstr "" #. type: Plain text #: documentation/content/en/books/fdp-primer/manual-pages/_index.adoc:116 msgid "" "Manual page source is usually interpreted and displayed to the screen " "interactively. The source files can be ordinary text files or compressed " "with man:gzip[1] to save space." msgstr "" #. type: Plain text #: documentation/content/en/books/fdp-primer/manual-pages/_index.adoc:119 msgid "" "Manual pages can also be rendered to other formats, including PostScript for " "printing or PDF generation. See man:man[1]." msgstr "" #. type: Title === #: documentation/content/en/books/fdp-primer/manual-pages/_index.adoc:121 #, no-wrap msgid "Manual Page Sections" msgstr "" #. type: Plain text #: documentation/content/en/books/fdp-primer/manual-pages/_index.adoc:126 msgid "" "Manual pages are composed of several standard sections. Each section has a " "title in upper case, and the sections for a particular type of manual page " "appear in a specific order. For a category 1 General Command manual page, " "the sections are:" msgstr "" #. type: Table #: documentation/content/en/books/fdp-primer/manual-pages/_index.adoc:131 #, no-wrap msgid "Section Name" msgstr "" #. type: Table #: documentation/content/en/books/fdp-primer/manual-pages/_index.adoc:134 #, no-wrap msgid "Description" msgstr "" #. type: Table #: documentation/content/en/books/fdp-primer/manual-pages/_index.adoc:135 #, no-wrap msgid "NAME" msgstr "" #. type: Table #: documentation/content/en/books/fdp-primer/manual-pages/_index.adoc:137 #, no-wrap msgid "Name of the command" msgstr "" #. type: Table #: documentation/content/en/books/fdp-primer/manual-pages/_index.adoc:138 #, no-wrap msgid "SYNOPSIS" msgstr "" #. type: Table #: documentation/content/en/books/fdp-primer/manual-pages/_index.adoc:140 #, no-wrap msgid "Format of options and arguments" msgstr "" #. type: Table #: documentation/content/en/books/fdp-primer/manual-pages/_index.adoc:141 #, no-wrap msgid "DESCRIPTION" msgstr "" #. type: Table #: documentation/content/en/books/fdp-primer/manual-pages/_index.adoc:143 #, no-wrap msgid "Description of purpose and usage" msgstr "" #. type: Table #: documentation/content/en/books/fdp-primer/manual-pages/_index.adoc:144 #, no-wrap msgid "ENVIRONMENT" msgstr "" #. type: Table #: documentation/content/en/books/fdp-primer/manual-pages/_index.adoc:146 #, no-wrap msgid "Environment settings that affect operation" msgstr "" #. type: Table #: documentation/content/en/books/fdp-primer/manual-pages/_index.adoc:147 #, no-wrap msgid "EXIT STATUS" msgstr "" #. type: Table #: documentation/content/en/books/fdp-primer/manual-pages/_index.adoc:149 #, no-wrap msgid "Error codes returned on exit" msgstr "" #. type: Table #: documentation/content/en/books/fdp-primer/manual-pages/_index.adoc:150 #, no-wrap msgid "EXAMPLES" msgstr "" #. type: Table #: documentation/content/en/books/fdp-primer/manual-pages/_index.adoc:152 #, no-wrap msgid "Examples of usage" msgstr "" #. type: Table #: documentation/content/en/books/fdp-primer/manual-pages/_index.adoc:153 #, no-wrap msgid "COMPATIBILITY" msgstr "" #. type: Table #: documentation/content/en/books/fdp-primer/manual-pages/_index.adoc:155 #, no-wrap msgid "Compatibility with other implementations" msgstr "" #. type: Table #: documentation/content/en/books/fdp-primer/manual-pages/_index.adoc:156 #, no-wrap msgid "SEE ALSO" msgstr "" #. type: Table #: documentation/content/en/books/fdp-primer/manual-pages/_index.adoc:158 #, no-wrap msgid "Cross-reference to related manual pages" msgstr "" #. type: Table #: documentation/content/en/books/fdp-primer/manual-pages/_index.adoc:159 #, no-wrap msgid "STANDARDS" msgstr "" #. type: Table #: documentation/content/en/books/fdp-primer/manual-pages/_index.adoc:161 #, no-wrap msgid "Compatibility with standards like POSIX" msgstr "" #. type: Table #: documentation/content/en/books/fdp-primer/manual-pages/_index.adoc:162 #, no-wrap msgid "HISTORY" msgstr "" #. type: Table #: documentation/content/en/books/fdp-primer/manual-pages/_index.adoc:164 #, no-wrap msgid "History of implementation" msgstr "" #. type: Table #: documentation/content/en/books/fdp-primer/manual-pages/_index.adoc:165 #, no-wrap msgid "BUGS" msgstr "" #. type: Table #: documentation/content/en/books/fdp-primer/manual-pages/_index.adoc:167 #, no-wrap msgid "Known bugs" msgstr "" #. type: Table #: documentation/content/en/books/fdp-primer/manual-pages/_index.adoc:168 #, no-wrap msgid "AUTHORS" msgstr "" #. type: Table #: documentation/content/en/books/fdp-primer/manual-pages/_index.adoc:169 #, no-wrap msgid "People who created the command or wrote the manual page." msgstr "" #. type: Plain text #: documentation/content/en/books/fdp-primer/manual-pages/_index.adoc:173 msgid "" "Some sections are optional, and the combination of sections for a specific " "type of manual page vary. Examples of the most common types are shown later " "in this chapter." msgstr "" #. type: Title === #: documentation/content/en/books/fdp-primer/manual-pages/_index.adoc:175 #, no-wrap msgid "Macros" msgstr "" #. type: Plain text #: documentation/content/en/books/fdp-primer/manual-pages/_index.adoc:180 msgid "" "man:mdoc[7] markup is based on _macros_. Lines that begin with a dot " "contain macro commands, each two or three letters long. For example, " "consider this portion of the man:ls[1] manual page:" msgstr "" #. type: delimited block . 4 #: documentation/content/en/books/fdp-primer/manual-pages/_index.adoc:209 #, no-wrap msgid "" ".Dd December 1, 2015 <.>\n" ".Dt LS 1\n" ".Sh NAME <.>\n" ".Nm ls\n" ".Nd list directory contents\n" ".Sh SYNOPSIS <.>\n" ".Nm <.>\n" ".Op Fl -libxo <.>\n" ".Op Fl ABCFGHILPRSTUWZabcdfghiklmnopqrstuwxy1, <.>\n" ".Op Fl D Ar format <.>\n" ".Op Ar <.>\n" ".Sh DESCRIPTION <.>\n" "For each operand that names a\n" ".Ar file\n" "of a type other than\n" "directory,\n" ".Nm\n" "displays its name as well as any requested,\n" "associated information.\n" "For each operand that names a\n" ".Ar file\n" "of type directory,\n" ".Nm\n" "displays the names of files contained\n" "within that directory, as well as any requested, associated\n" "information.\n" msgstr "" #. type: Plain text #: documentation/content/en/books/fdp-primer/manual-pages/_index.adoc:212 msgid "A _Document date_ and _Document title_ are defined." msgstr "" #. type: Plain text #: documentation/content/en/books/fdp-primer/manual-pages/_index.adoc:214 msgid "" "A _Section header_ for the NAME section is defined. Then the _Name_ of the " "command and a one-line _Name description_ are defined." msgstr "" #. type: Plain text #: documentation/content/en/books/fdp-primer/manual-pages/_index.adoc:216 msgid "" "The SYNOPSIS section begins. This section describes the command-line " "options and arguments accepted." msgstr "" #. type: Plain text #: documentation/content/en/books/fdp-primer/manual-pages/_index.adoc:217 msgid "" "_Name_ (`.Nm`) has already been defined, and repeating it here just displays " "the defined value in the text." msgstr "" #. type: Plain text #: documentation/content/en/books/fdp-primer/manual-pages/_index.adoc:219 msgid "" "An _Optional_ _Flag_ called `-libxo` is shown. The `Fl` macro adds a dash " "to the beginning of flags, so this appears in the manual page as `--libxo`." msgstr "" #. type: Plain text #: documentation/content/en/books/fdp-primer/manual-pages/_index.adoc:220 msgid "A long list of optional single-character flags are shown." msgstr "" #. type: Plain text #: documentation/content/en/books/fdp-primer/manual-pages/_index.adoc:224 msgid "" "An optional `-D` flag is defined. If the `-D` flag is given, it must be " "followed by an _Argument_. The argument is a _format_, a string that tells " "man:ls[1] what to display and how to display it. Details on the format " "string are given later in the manual page." msgstr "" #. type: Plain text #: documentation/content/en/books/fdp-primer/manual-pages/_index.adoc:226 msgid "" "A final optional argument is defined. Since no name is specified for the " "argument, the default of `file ...` is used." msgstr "" #. type: Plain text #: documentation/content/en/books/fdp-primer/manual-pages/_index.adoc:227 msgid "The _Section header_ for the DESCRIPTION section is defined." msgstr "" #. type: Plain text #: documentation/content/en/books/fdp-primer/manual-pages/_index.adoc:229 msgid "" "When rendered with the command `man ls`, the result displayed on the screen " "looks like this:" msgstr "" #. type: delimited block . 4 #: documentation/content/en/books/fdp-primer/manual-pages/_index.adoc:233 #, no-wrap msgid "LS(1) FreeBSD General Commands Manual LS(1)\n" msgstr "" #. type: delimited block . 4 #: documentation/content/en/books/fdp-primer/manual-pages/_index.adoc:236 #, no-wrap msgid "" "NAME\n" " ls - list directory contents\n" msgstr "" #. type: delimited block . 4 #: documentation/content/en/books/fdp-primer/manual-pages/_index.adoc:240 #, no-wrap msgid "" "SYNOPSIS\n" " ls [--libxo] [-ABCFGHILPRSTUWZabcdfghiklmnopqrstuwxy1,] [-D format]\n" " [file ...]\n" msgstr "" #. type: delimited block . 4 #: documentation/content/en/books/fdp-primer/manual-pages/_index.adoc:247 #, no-wrap msgid "" "DESCRIPTION\n" " For each operand that names a file of a type other than directory, ls\n" " displays its name as well as any requested, associated information. For\n" " each operand that names a file of type directory, ls displays the names\n" " of files contained within that directory, as well as any requested,\n" " associated information.\n" msgstr "" #. type: Plain text #: documentation/content/en/books/fdp-primer/manual-pages/_index.adoc:250 msgid "Optional values are shown inside square brackets." msgstr "" #. type: Title === #: documentation/content/en/books/fdp-primer/manual-pages/_index.adoc:252 #, no-wrap msgid "Markup Guidelines" msgstr "" #. type: Plain text #: documentation/content/en/books/fdp-primer/manual-pages/_index.adoc:256 msgid "" "The man:mdoc[7] markup language is not very strict. For clarity and " "consistency, the FreeBSD Documentation project adds some additional style " "guidelines:" msgstr "" #. type: Labeled list #: documentation/content/en/books/fdp-primer/manual-pages/_index.adoc:257 #, no-wrap msgid "Only the first letter of macros is upper case" msgstr "" #. type: Plain text #: documentation/content/en/books/fdp-primer/manual-pages/_index.adoc:259 msgid "" "Always use upper case for the first letter of a macro and lower case for the " "remaining letters." msgstr "" #. type: Labeled list #: documentation/content/en/books/fdp-primer/manual-pages/_index.adoc:260 #, no-wrap msgid "Begin new sentences on new lines" msgstr "" #. type: Plain text #: documentation/content/en/books/fdp-primer/manual-pages/_index.adoc:262 msgid "" "Start a new sentence on a new line, do not begin it on the same line as an " "existing sentence." msgstr "" #. type: Labeled list #: documentation/content/en/books/fdp-primer/manual-pages/_index.adoc:263 #, no-wrap msgid "Update `.Dd` when making non-trivial changes to a manual page" msgstr "" #. type: Plain text #: documentation/content/en/books/fdp-primer/manual-pages/_index.adoc:267 msgid "" "The _Document date_ informs the reader about the last time the manual page " "was updated. It is important to update whenever non-trivial changes are " "made to the manual pages. Trivial changes like spelling or punctuation " "fixes that do not affect usage can be made without updating `.Dd`." msgstr "" #. type: Labeled list #: documentation/content/en/books/fdp-primer/manual-pages/_index.adoc:268 #, no-wrap msgid "Give examples" msgstr "" #. type: Plain text #: documentation/content/en/books/fdp-primer/manual-pages/_index.adoc:273 msgid "" "Show the reader examples when possible. Even trivial examples are valuable, " "because what is trivial to the writer is not necessarily trivial to the " "reader. Three examples are a good goal. A trivial example shows the " "minimal requirements, a serious example shows actual use, and an in-depth " "example demonstrates unusual or non-obvious functionality." msgstr "" #. type: Labeled list #: documentation/content/en/books/fdp-primer/manual-pages/_index.adoc:274 #, no-wrap msgid "Include the BSD license" msgstr "" #. type: Plain text #: documentation/content/en/books/fdp-primer/manual-pages/_index.adoc:277 msgid "" "Include the BSD license on new manual pages. The preferred license is " "available from the extref:{committers-guide}[Committer's Guide]." msgstr "" #. type: Title === #: documentation/content/en/books/fdp-primer/manual-pages/_index.adoc:279 #, no-wrap msgid "Markup Tricks" msgstr "" #. type: Plain text #: documentation/content/en/books/fdp-primer/manual-pages/_index.adoc:282 msgid "Add a space before punctuation on a line with macros. Example:" msgstr "" #. type: delimited block . 4 #: documentation/content/en/books/fdp-primer/manual-pages/_index.adoc:290 #, no-wrap msgid "" ".Sh SEE ALSO\n" ".Xr geom 4 ,\n" ".Xr boot0cfg 8 ,\n" ".Xr geom 8 ,\n" ".Xr gptboot 8\n" msgstr "" #. type: Plain text #: documentation/content/en/books/fdp-primer/manual-pages/_index.adoc:296 msgid "" "Note how the commas at the end of the `.Xr` lines have been placed after a " "space. The `.Xr` macro expects two parameters to follow it, the name of an " "external manual page, and a section number. The space separates the " "punctuation from the section number. Without the space, the external links " "would incorrectly point to section `4,` or `8,`." msgstr "" #. type: Title === #: documentation/content/en/books/fdp-primer/manual-pages/_index.adoc:298 #, no-wrap msgid "Important Macros" msgstr "" #. type: Plain text #: documentation/content/en/books/fdp-primer/manual-pages/_index.adoc:303 msgid "" "Some very common macros will be shown here. For more usage examples, see " "man:mdoc[7], man:groff_mdoc[7], or search for actual use in [.filename]#/usr/" "share/man/man*# directories. For example, to search for examples of the " "`.Bd` _Begin display_ macro:" msgstr "" #. type: delimited block . 4 #: documentation/content/en/books/fdp-primer/manual-pages/_index.adoc:307 #, no-wrap msgid "% find /usr/share/man/man* | xargs zgrep '.Bd'\n" msgstr "" #. type: Title ==== #: documentation/content/en/books/fdp-primer/manual-pages/_index.adoc:310 #, no-wrap msgid "Organizational Macros" msgstr "" #. type: Plain text #: documentation/content/en/books/fdp-primer/manual-pages/_index.adoc:313 msgid "Some macros are used to define logical blocks of a manual page." msgstr "" #. type: Table #: documentation/content/en/books/fdp-primer/manual-pages/_index.adoc:318 #, no-wrap msgid "Organizational Macro" msgstr "" #. type: Table #: documentation/content/en/books/fdp-primer/manual-pages/_index.adoc:321 #: documentation/content/en/books/fdp-primer/manual-pages/_index.adoc:357 #, no-wrap msgid "Use" msgstr "" #. type: Table #: documentation/content/en/books/fdp-primer/manual-pages/_index.adoc:322 #, no-wrap msgid "`.Sh`" msgstr "" #. type: Table #: documentation/content/en/books/fdp-primer/manual-pages/_index.adoc:326 #, no-wrap msgid "" "Section header.\n" "Followed by the name of the section, traditionally all upper case.\n" "Think of these as chapter titles." msgstr "" #. type: Table #: documentation/content/en/books/fdp-primer/manual-pages/_index.adoc:327 #, no-wrap msgid "`.Ss`" msgstr "" #. type: Table #: documentation/content/en/books/fdp-primer/manual-pages/_index.adoc:331 #, no-wrap msgid "" "Subsection header.\n" "Followed by the name of the subsection.\n" "Used to divide a `.Sh` section into subsections." msgstr "" #. type: Table #: documentation/content/en/books/fdp-primer/manual-pages/_index.adoc:332 #, no-wrap msgid "`.Bl`" msgstr "" #. type: Table #: documentation/content/en/books/fdp-primer/manual-pages/_index.adoc:334 #, no-wrap msgid "Begin list. Start a list of items." msgstr "" #. type: Table #: documentation/content/en/books/fdp-primer/manual-pages/_index.adoc:335 #, no-wrap msgid "`.El`" msgstr "" #. type: Table #: documentation/content/en/books/fdp-primer/manual-pages/_index.adoc:337 #, no-wrap msgid "End a list." msgstr "" #. type: Table #: documentation/content/en/books/fdp-primer/manual-pages/_index.adoc:338 #, no-wrap msgid "`.Bd`" msgstr "" #. type: Table #: documentation/content/en/books/fdp-primer/manual-pages/_index.adoc:341 #, no-wrap msgid "" "Begin display.\n" "Begin a special area of text, like an indented area." msgstr "" #. type: Table #: documentation/content/en/books/fdp-primer/manual-pages/_index.adoc:342 #, no-wrap msgid "`.Ed`" msgstr "" #. type: Table #: documentation/content/en/books/fdp-primer/manual-pages/_index.adoc:343 #, no-wrap msgid "End display." msgstr "" #. type: Title ==== #: documentation/content/en/books/fdp-primer/manual-pages/_index.adoc:346 #, no-wrap msgid "Inline Macros" msgstr "" #. type: Plain text #: documentation/content/en/books/fdp-primer/manual-pages/_index.adoc:349 msgid "Many macros are used to mark up inline text." msgstr "" #. type: Table #: documentation/content/en/books/fdp-primer/manual-pages/_index.adoc:354 #, no-wrap msgid "Inline Macro" msgstr "" #. type: Table #: documentation/content/en/books/fdp-primer/manual-pages/_index.adoc:358 #, no-wrap msgid "`.Nm`" msgstr "" #. type: Table #: documentation/content/en/books/fdp-primer/manual-pages/_index.adoc:361 #, no-wrap msgid "" "Name.\n" "Called with a name as a parameter on the first use, then used later without the parameter to display the name that has already been defined." msgstr "" #. type: Table #: documentation/content/en/books/fdp-primer/manual-pages/_index.adoc:362 #, no-wrap msgid "`.Pa`" msgstr "" #. type: Table #: documentation/content/en/books/fdp-primer/manual-pages/_index.adoc:364 #, no-wrap msgid "" "Path to a file.\n" "Used to mark up filenames and directory paths." msgstr "" #. type: Title == #: documentation/content/en/books/fdp-primer/manual-pages/_index.adoc:367 #, no-wrap msgid "Sample Manual Page Structures" msgstr "" #. type: Plain text #: documentation/content/en/books/fdp-primer/manual-pages/_index.adoc:370 msgid "" "This section shows minimal desired man page contents for several common " "categories of manual pages." msgstr "" #. type: Title === #: documentation/content/en/books/fdp-primer/manual-pages/_index.adoc:372 #, no-wrap msgid "Section 1 or 8 Command" msgstr "" #. type: Plain text #: documentation/content/en/books/fdp-primer/manual-pages/_index.adoc:375 msgid "The preferred basic structure for a section 1 or 8 command:" msgstr "" #. type: delimited block . 4 #: documentation/content/en/books/fdp-primer/manual-pages/_index.adoc:396 #, no-wrap msgid "" ".Dd August 25, 2017\n" ".Dt EXAMPLECMD 8\n" ".Os\n" ".Sh NAME\n" ".Nm examplecmd\n" ".Nd \"command to demonstrate section 1 and 8 man pages\"\n" ".Sh SYNOPSIS\n" ".Nm\n" ".Op Fl v\n" ".Sh DESCRIPTION\n" "The\n" ".Nm\n" "utility does nothing except demonstrate a trivial but complete\n" "manual page for a section 1 or 8 command.\n" ".Sh SEE ALSO\n" ".Xr exampleconf 5\n" ".Sh AUTHORS\n" ".An Firstname Lastname Aq Mt [email protected]\n" msgstr "" #. type: Title === #: documentation/content/en/books/fdp-primer/manual-pages/_index.adoc:399 #, no-wrap msgid "Section 4 Device Driver" msgstr "" #. type: Plain text #: documentation/content/en/books/fdp-primer/manual-pages/_index.adoc:402 msgid "The preferred basic structure for a section 4 device driver:" msgstr "" #. type: delimited block . 4 #: documentation/content/en/books/fdp-primer/manual-pages/_index.adoc:458 #, no-wrap msgid "" ".Dd August 25, 2017\n" ".Dt EXAMPLEDRIVER 4\n" ".Os\n" ".Sh NAME\n" ".Nm exampledriver\n" ".Nd \"driver to demonstrate section 4 man pages\"\n" ".Sh SYNOPSIS\n" "To compile this driver into the kernel, add this line to the\n" "kernel configuration file:\n" ".Bd -ragged -offset indent\n" ".Cd \"device exampledriver\"\n" ".Ed\n" ".Pp\n" "To load the driver as a module at boot, add this line to\n" ".Xr loader.conf 5 :\n" ".Bd -literal -offset indent\n" "exampledriver_load=\"YES\"\n" ".Ed\n" ".Sh DESCRIPTION\n" "The\n" ".Nm\n" "driver provides an opportunity to show a skeleton or template\n" "file for section 4 manual pages.\n" ".Sh HARDWARE\n" "The\n" ".Nm\n" "driver supports these cards from the aptly-named Nonexistent\n" "Technologies:\n" ".Pp\n" ".Bl -bullet -compact\n" ".It\n" "NT X149.2 (single and dual port)\n" ".It\n" "NT X149.8 (single port)\n" ".El\n" ".Sh DIAGNOSTICS\n" ".Bl -diag\n" ".It \"flashing green light\"\n" "Something bad happened.\n" ".It \"flashing red light\"\n" "Something really bad happened.\n" ".It \"solid black light\"\n" "Power cord is unplugged.\n" ".El\n" ".Sh SEE ALSO\n" ".Xr example 8\n" ".Sh HISTORY\n" "The\n" ".Nm\n" "device driver first appeared in\n" ".Fx 49.2 .\n" ".Sh AUTHORS\n" ".An Firstname Lastname Aq Mt [email protected]\n" msgstr "" #. type: Title === #: documentation/content/en/books/fdp-primer/manual-pages/_index.adoc:461 #, no-wrap msgid "Section 5 Configuration File" msgstr "" #. type: Plain text #: documentation/content/en/books/fdp-primer/manual-pages/_index.adoc:464 msgid "The preferred basic structure for a section 5 configuration file:" msgstr "" #. type: delimited block . 4 #: documentation/content/en/books/fdp-primer/manual-pages/_index.adoc:480 #, no-wrap msgid "" ".Dd August 25, 2017\n" ".Dt EXAMPLECONF 5\n" ".Os\n" ".Sh NAME\n" ".Nm example.conf\n" ".Nd \"config file to demonstrate section 5 man pages\"\n" ".Sh DESCRIPTION\n" ".Nm\n" "is an example configuration file.\n" ".Sh SEE ALSO\n" ".Xr example 8\n" ".Sh AUTHORS\n" ".An Firstname Lastname Aq Mt [email protected]\n" msgstr "" #. type: Title == #: documentation/content/en/books/fdp-primer/manual-pages/_index.adoc:483 #, no-wrap msgid "Testing" msgstr "" #. type: Plain text #: documentation/content/en/books/fdp-primer/manual-pages/_index.adoc:490 msgid "" "Testing a new manual page can be challenging. Fortunately there are some " "tools that can assist in the task. Some of them, like man:man[1], do not " "look in the current directory. It is a good idea to prefix the filename " "with `./` if the new manual page is in the current directory. An absolute " "path can also be used." msgstr "" #. type: Plain text #: documentation/content/en/books/fdp-primer/manual-pages/_index.adoc:492 msgid "Use man:mandoc[1]'s linter to check for parsing errors:" msgstr "" #. type: delimited block . 4 #: documentation/content/en/books/fdp-primer/manual-pages/_index.adoc:496 #, no-wrap msgid "% mandoc -T lint ./mynewmanpage.8\n" msgstr "" #. type: Plain text #: documentation/content/en/books/fdp-primer/manual-pages/_index.adoc:499 msgid "Use package:textproc/igor[] to proofread the manual page:" msgstr "" #. type: delimited block . 4 #: documentation/content/en/books/fdp-primer/manual-pages/_index.adoc:503 #, no-wrap msgid "% igor ./mynewmanpage.8\n" msgstr "" #. type: Plain text #: documentation/content/en/books/fdp-primer/manual-pages/_index.adoc:508 msgid "" "Another useful tool is package:textproc/vale[]. It does not support the " "man:mdoc[7] syntax but the rendered manual page can be read from standard " "input:" msgstr "" #. type: delimited block . 4 #: documentation/content/en/books/fdp-primer/manual-pages/_index.adoc:512 #, no-wrap msgid "% man ls | vale\n" msgstr "" #. type: Plain text #: documentation/content/en/books/fdp-primer/manual-pages/_index.adoc:516 msgid "" "package:textproc/vale[] is highly configurable. It is advised to read its " "documentation." msgstr "" #. type: Plain text #: documentation/content/en/books/fdp-primer/manual-pages/_index.adoc:518 msgid "Use man:man[1] to check the final result of your changes:" msgstr "" #. type: delimited block . 4 #: documentation/content/en/books/fdp-primer/manual-pages/_index.adoc:522 #, no-wrap msgid "% man ./mynewmanpage.8\n" msgstr "" #. type: Plain text #: documentation/content/en/books/fdp-primer/manual-pages/_index.adoc:525 msgid "" "You can use man:col[1] to filter the output of man:man[1] and get rid of the " "backspace characters before loading the result in your favorite editor for " "spell checking:" msgstr "" #. type: delimited block . 4 #: documentation/content/en/books/fdp-primer/manual-pages/_index.adoc:529 #, no-wrap msgid "% man ./mynewmanpage.8 | col -b | vim -R -\n" msgstr "" #. type: Plain text #: documentation/content/en/books/fdp-primer/manual-pages/_index.adoc:534 msgid "" "Spell-checking with fully-featured dictionaries is encouraged, and can be " "accomplished by using package:textproc/hunspell[] or package:textproc/" "aspell[] combined with package:textproc/en-hunspell[] or package:textproc/en-" "aspell[], respectively. For instance:" msgstr "" #. type: delimited block . 4 #: documentation/content/en/books/fdp-primer/manual-pages/_index.adoc:538 #, no-wrap msgid "% aspell check --lang=en --mode=nroff ./mynewmanpage.8\n" msgstr "" #. type: Title == #: documentation/content/en/books/fdp-primer/manual-pages/_index.adoc:541 #, no-wrap msgid "Example Manual Pages to Use as Templates" msgstr "" #. type: Plain text #: documentation/content/en/books/fdp-primer/manual-pages/_index.adoc:544 msgid "Some manual pages are suitable as in-depth examples." msgstr "" #. type: Table #: documentation/content/en/books/fdp-primer/manual-pages/_index.adoc:549 #, no-wrap msgid "Manual Page" msgstr "" #. type: Table #: documentation/content/en/books/fdp-primer/manual-pages/_index.adoc:552 #, no-wrap msgid "Path to Source Location" msgstr "" #. type: Table #: documentation/content/en/books/fdp-primer/manual-pages/_index.adoc:553 #, no-wrap msgid "man:cp[1]" msgstr "" #. type: Table #: documentation/content/en/books/fdp-primer/manual-pages/_index.adoc:555 #, no-wrap msgid "[.filename]#/usr/src/bin/cp/cp.1#" msgstr "" #. type: Table #: documentation/content/en/books/fdp-primer/manual-pages/_index.adoc:556 #, no-wrap msgid "man:vt[4]" msgstr "" #. type: Table #: documentation/content/en/books/fdp-primer/manual-pages/_index.adoc:558 #, no-wrap msgid "[.filename]#/usr/src/share/man/man4/vt.4#" msgstr "" #. type: Table #: documentation/content/en/books/fdp-primer/manual-pages/_index.adoc:559 #, no-wrap msgid "man:crontab[5]" msgstr "" #. type: Table #: documentation/content/en/books/fdp-primer/manual-pages/_index.adoc:561 #, no-wrap msgid "[.filename]#/usr/src/usr.sbin/cron/crontab/crontab.5#" msgstr "" #. type: Table #: documentation/content/en/books/fdp-primer/manual-pages/_index.adoc:562 #, no-wrap msgid "man:gpart[8]" msgstr "" #. type: Table #: documentation/content/en/books/fdp-primer/manual-pages/_index.adoc:563 #, no-wrap msgid "[.filename]#/usr/src/sbin/geom/class/part/gpart.8#" msgstr "" #. type: Title == #: documentation/content/en/books/fdp-primer/manual-pages/_index.adoc:566 #, no-wrap msgid "Resources" msgstr "" #. type: Plain text #: documentation/content/en/books/fdp-primer/manual-pages/_index.adoc:569 msgid "Resources for manual page writers:" msgstr "" #. type: Plain text #: documentation/content/en/books/fdp-primer/manual-pages/_index.adoc:571 msgid "man:man[1]" msgstr "" #. type: Plain text #: documentation/content/en/books/fdp-primer/manual-pages/_index.adoc:572 msgid "man:mandoc[1]" msgstr "" #. type: Plain text #: documentation/content/en/books/fdp-primer/manual-pages/_index.adoc:573 msgid "man:style.mdoc[5]" msgstr "" #. type: Plain text #: documentation/content/en/books/fdp-primer/manual-pages/_index.adoc:574 msgid "man:groff_mdoc[7]" msgstr "" #. type: Plain text #: documentation/content/en/books/fdp-primer/manual-pages/_index.adoc:575 msgid "http://manpages.bsd.lv/mdoc.html[Practical UNIX Manuals: mdoc]" msgstr "" #. type: Plain text #: documentation/content/en/books/fdp-primer/manual-pages/_index.adoc:575 msgid "http://manpages.bsd.lv/history.html[History of UNIX Manpages]" msgstr ""