#, fuzzy msgid "" msgstr "" "Project-Id-Version: man-pages-l10n VERSION\n" "POT-Creation-Date: 2014-07-17 17:57+0900\n" "MIME-Version: 1.0\n" "Content-Type: text/plain; charset=UTF-8\n" "Content-Transfer-Encoding: 8bit\n" #. Copyright (c) 1990, 1993 #. The Regents of the University of California. All rights reserved. #. %%%LICENSE_START(BSD_4_CLAUSE_UCB) #. Redistribution and use in source and binary forms, with or without #. modification, are permitted provided that the following conditions #. are met: #. 1. Redistributions of source code must retain the above copyright #. notice, this list of conditions and the following disclaimer. #. 2. Redistributions in binary form must reproduce the above copyright #. notice, this list of conditions and the following disclaimer in the #. documentation and/or other materials provided with the distribution. #. 3. All advertising materials mentioning features or use of this software #. must display the following acknowledgement: #. This product includes software developed by the University of #. California, Berkeley and its contributors. #. 4. Neither the name of the University nor the names of its contributors #. may be used to endorse or promote products derived from this software #. without specific prior written permission. #. THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND #. ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE #. IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE #. ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE #. FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL #. DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS #. OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) #. HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT #. LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY #. OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF #. SUCH DAMAGE. #. %%%LICENSE_END #. @(#)mdoc.samples.7 8.2 (Berkeley) 12/30/93 #. $Id: mdoc.samples.7,v 1.17 1998/12/03 03:38:45 jkoshy Exp $ #. This tutorial sampler invokes every macro in the package several #. times and is guaranteed to give a worst case performance #. for an already extremely slow package. #. String \*(Pu was not defined, probably means punctuation #. type: ds Pu #: man-pages/man7/mdoc.samples.7:42 #, no-wrap msgid "[ .,:;()[]?! ]" msgstr "" #. type: Dd #: man-pages/man7/mdoc.samples.7:43 #, no-wrap msgid "December 30, 1993" msgstr "" #. type: Dt #: man-pages/man7/mdoc.samples.7:45 #, no-wrap msgid "MDOC.SAMPLES 7" msgstr "" #. type: Sh #: man-pages/man7/mdoc.samples.7:46 #, no-wrap msgid "NAME" msgstr "" #. type: Plain text #: man-pages/man7/mdoc.samples.7:48 msgid "E<.Nm mdoc.samples>" msgstr "" #. type: Nd #: man-pages/man7/mdoc.samples.7:48 #, no-wrap msgid "tutorial sampler for writing" msgstr "" #. type: Plain text #: man-pages/man7/mdoc.samples.7:52 msgid "E<.Bx> manuals with E<.Nm \\-mdoc>" msgstr "" #. type: Sh #: man-pages/man7/mdoc.samples.7:52 #, no-wrap msgid "SYNOPSIS" msgstr "" #. type: Plain text #: man-pages/man7/mdoc.samples.7:54 msgid "E<.Nm man mdoc.samples>" msgstr "" #. type: Sh #: man-pages/man7/mdoc.samples.7:54 #, no-wrap msgid "DESCRIPTION" msgstr "" #. type: Plain text #: man-pages/man7/mdoc.samples.7:100 msgid "" "A tutorial sampler for writing E<.Bx> manual pages with the E<.Nm \\-mdoc> " "macro package, a E<.Em content Ns \\-based> and E<.Em domain Ns \\-based> " "formatting package for E<.Xr troff 1>. Its predecessor, the E<.Xr \\-man 7> " "package, addressed page layout leaving the manipulation of fonts and other " "typesetting details to the individual author. In E<.Nm \\-mdoc>, page " "layout macros make up the E<.Em \"page structure domain\"> which consists of " "macros for titles, section headers, displays and lists. Essentially items " "which affect the physical position of text on a formatted page. In addition " "to the page structure domain, there are two more domains, the manual domain " "and the general text domain. The general text domain is defined as macros " "which perform tasks such as quoting or emphasizing pieces of text. The " "manual domain is defined as macros that are a subset of the day to day " "informal language used to describe commands, routines and related E<.Bx> " "files. Macros in the manual domain handle command names, command-line " "arguments and options, function names, function parameters, pathnames, " "variables, cross references to other manual pages, and so on. These domain " "items have value for both the author and the future user of the manual page. " " It is hoped the consistency gained across the manual set will provide " "easier translation to future documentation tools." msgstr "" #. type: Plain text #: man-pages/man7/mdoc.samples.7:107 msgid "" "Throughout the E<.Ux> manual pages, a manual entry is simply referred to as " "a man page, regardless of actual length and without sexist intention." msgstr "" #. type: Sh #: man-pages/man7/mdoc.samples.7:107 #, no-wrap msgid "GETTING STARTED" msgstr "" #. type: Plain text #: man-pages/man7/mdoc.samples.7:113 msgid "" "Since a tutorial document is normally read when a person desires to use the " "material immediately, the assumption has been made that the user of this " "document may be impatient. The material presented in the remained of this " "document is outlined as follows:" msgstr "" #. type: Plain text #: man-pages/man7/mdoc.samples.7:116 msgid "E<.Tn \"TROFF IDIOSYNCRASIES\">" msgstr "" #. type: It #: man-pages/man7/mdoc.samples.7:117 #, no-wrap msgid "\"Macro Usage\" ." msgstr "" #. type: It #: man-pages/man7/mdoc.samples.7:118 #, no-wrap msgid "\"Passing Space Characters in an Argument\" ." msgstr "" #. type: It #: man-pages/man7/mdoc.samples.7:119 #, no-wrap msgid "\"Trailing Blank Space Characters (a warning)\" ." msgstr "" #. type: It #: man-pages/man7/mdoc.samples.7:120 #, no-wrap msgid "\"Escaping Special Characters\" ." msgstr "" #. type: Plain text #: man-pages/man7/mdoc.samples.7:124 msgid "E<.Tn \"THE ANATOMY OF A MAN PAGE\">" msgstr "" #. type: It #: man-pages/man7/mdoc.samples.7:125 #, no-wrap msgid "\"A manual page template\" ." msgstr "" #. type: Plain text #: man-pages/man7/mdoc.samples.7:129 msgid "E<.Tn \"TITLE MACROS\">." msgstr "" #. type: Plain text #: man-pages/man7/mdoc.samples.7:131 msgid "E<.Tn \"INTRODUCTION OF MANUAL AND GENERAL TEXT DOMAINS\">." msgstr "" #. type: It #: man-pages/man7/mdoc.samples.7:132 #, no-wrap msgid "\"What's in a name...\" ." msgstr "" #. type: It #: man-pages/man7/mdoc.samples.7:133 #, no-wrap msgid "\"General Syntax\" ." msgstr "" #. type: Plain text #: man-pages/man7/mdoc.samples.7:137 msgid "E<.Tn \"MANUAL DOMAIN\">" msgstr "" #. type: It #: man-pages/man7/mdoc.samples.7:138 #, no-wrap msgid "Addresses ." msgstr "" #. type: It #: man-pages/man7/mdoc.samples.7:139 #, no-wrap msgid "\"Author name\" ." msgstr "" #. type: It #: man-pages/man7/mdoc.samples.7:140 #, no-wrap msgid "Arguments ." msgstr "" #. type: It #: man-pages/man7/mdoc.samples.7:141 #, no-wrap msgid "\"Configuration Declarations (section four only)\" ." msgstr "" #. type: It #: man-pages/man7/mdoc.samples.7:142 #, no-wrap msgid "\"Command Modifier\" ." msgstr "" #. type: It #: man-pages/man7/mdoc.samples.7:143 #, no-wrap msgid "\"Defined Variables\" ." msgstr "" #. type: It #: man-pages/man7/mdoc.samples.7:144 #, no-wrap msgid "\"Errno's (Section two only)\" ." msgstr "" #. type: It #: man-pages/man7/mdoc.samples.7:145 #, no-wrap msgid "\"Environment Variables\" ." msgstr "" #. type: It #: man-pages/man7/mdoc.samples.7:146 #, no-wrap msgid "\"Function Argument\" ." msgstr "" #. type: It #: man-pages/man7/mdoc.samples.7:147 #, no-wrap msgid "\"Function Declaration\" ." msgstr "" #. type: It #: man-pages/man7/mdoc.samples.7:148 #, no-wrap msgid "Flags ." msgstr "" #. type: It #: man-pages/man7/mdoc.samples.7:149 #, no-wrap msgid "\"Functions (library routines)\" ." msgstr "" #. type: It #: man-pages/man7/mdoc.samples.7:150 #, no-wrap msgid "\"Function Types\" ." msgstr "" #. .It "Header File (including source code)" . #. type: It #: man-pages/man7/mdoc.samples.7:152 #, no-wrap msgid "\"Interactive Commands\" ." msgstr "" #. type: It #: man-pages/man7/mdoc.samples.7:153 #, no-wrap msgid "Names ." msgstr "" #. type: It #: man-pages/man7/mdoc.samples.7:154 #, no-wrap msgid "Options ." msgstr "" #. type: It #: man-pages/man7/mdoc.samples.7:155 #, no-wrap msgid "Pathnames ." msgstr "" #. type: It #: man-pages/man7/mdoc.samples.7:156 #, no-wrap msgid "Variables ." msgstr "" #. type: It #: man-pages/man7/mdoc.samples.7:157 #, no-wrap msgid "\"Cross References\" ." msgstr "" #. type: Plain text #: man-pages/man7/mdoc.samples.7:161 msgid "E<.Tn \"GENERAL TEXT DOMAIN\">" msgstr "" #. type: It #: man-pages/man7/mdoc.samples.7:162 #, no-wrap msgid "\"AT&T Macro\" ." msgstr "" #. type: It #: man-pages/man7/mdoc.samples.7:163 #, no-wrap msgid "\"BSD Macro\" ." msgstr "" #. type: It #: man-pages/man7/mdoc.samples.7:164 #, no-wrap msgid "\"FreeBSD Macro\" ." msgstr "" #. type: It #: man-pages/man7/mdoc.samples.7:165 #, no-wrap msgid "\"UNIX Macro\" ." msgstr "" #. type: It #: man-pages/man7/mdoc.samples.7:166 #, no-wrap msgid "Enclosure/Quoting Macros" msgstr "" #. type: It #: man-pages/man7/mdoc.samples.7:168 #, no-wrap msgid "\"Angle Bracket Quote/Enclosure\" ." msgstr "" #. type: It #: man-pages/man7/mdoc.samples.7:169 #, no-wrap msgid "\"Bracket Quotes/Enclosure\" ." msgstr "" #. type: It #: man-pages/man7/mdoc.samples.7:170 #, no-wrap msgid "\"Double Quote macro/Enclosure\" ." msgstr "" #. type: It #: man-pages/man7/mdoc.samples.7:171 #, no-wrap msgid "\"Parenthesis Quote/Enclosure\" ." msgstr "" #. type: It #: man-pages/man7/mdoc.samples.7:172 #, no-wrap msgid "\"Single Quotes/Enclosure\" ." msgstr "" #. type: It #: man-pages/man7/mdoc.samples.7:173 #, no-wrap msgid "\"Prefix Macro\" ." msgstr "" #. type: It #: man-pages/man7/mdoc.samples.7:175 #, no-wrap msgid "\"No\\-Op or Normal Text Macro\" ." msgstr "" #. type: It #: man-pages/man7/mdoc.samples.7:176 #, no-wrap msgid "\"No Space Macro\" ." msgstr "" #. type: It #: man-pages/man7/mdoc.samples.7:177 #, no-wrap msgid "\"Section Cross References\" ." msgstr "" #. type: It #: man-pages/man7/mdoc.samples.7:178 #, no-wrap msgid "\"References and Citations\" ." msgstr "" #. type: It #: man-pages/man7/mdoc.samples.7:179 #, no-wrap msgid "Return Values (sections two and three only)" msgstr "" #. type: It #: man-pages/man7/mdoc.samples.7:180 #, no-wrap msgid "\"Trade Names (Acronyms and Type Names)\" ." msgstr "" #. type: It #: man-pages/man7/mdoc.samples.7:181 #, no-wrap msgid "\"Extended Arguments\" ." msgstr "" #. type: Plain text #: man-pages/man7/mdoc.samples.7:185 msgid "E<.Tn \"PAGE STRUCTURE DOMAIN\">" msgstr "" #. type: It #: man-pages/man7/mdoc.samples.7:186 #, no-wrap msgid "\"Section Headers\" ." msgstr "" #. type: It #: man-pages/man7/mdoc.samples.7:187 #, no-wrap msgid "\"Paragraphs and Line Spacing\" ." msgstr "" #. type: It #: man-pages/man7/mdoc.samples.7:188 #, no-wrap msgid "Keeps ." msgstr "" #. type: It #: man-pages/man7/mdoc.samples.7:189 #, no-wrap msgid "Displays ." msgstr "" #. type: It #: man-pages/man7/mdoc.samples.7:190 #, no-wrap msgid "\"Font Modes (Emphasis, Literal, and Symbolic)\" ." msgstr "" #. type: It #: man-pages/man7/mdoc.samples.7:191 #, no-wrap msgid "\"Lists and Columns\" ." msgstr "" #. type: Plain text #: man-pages/man7/mdoc.samples.7:195 msgid "E<.Tn \"PREDEFINED STRINGS\">" msgstr "" #. type: Plain text #: man-pages/man7/mdoc.samples.7:197 msgid "E<.Tn \"DIAGNOSTICS\">" msgstr "" #. type: Plain text #: man-pages/man7/mdoc.samples.7:199 msgid "E<.Tn \"FORMATTING WITH GROFF, TROFF AND NROFF\">" msgstr "" #. type: Plain text #: man-pages/man7/mdoc.samples.7:201 msgid "E<.Tn \"BUGS\">" msgstr "" #. type: Sh #: man-pages/man7/mdoc.samples.7:203 #, no-wrap msgid "TROFF IDIOSYNCRASIES" msgstr "" #. type: Plain text #: man-pages/man7/mdoc.samples.7:217 msgid "" "The E<.Nm \\-mdoc> package attempts to simplify the process of writing a man " "page. Theoretically, one should not have to learn the dirty details of E<." "Xr troff 1> to use E<.Nm \\-mdoc>; however, there are a few limitations " "which are unavoidable and best gotten out of the way. And, too, be " "forewarned, this package is E<.Em not> fast." msgstr "" #. type: Ss #: man-pages/man7/mdoc.samples.7:217 #, no-wrap msgid "Macro Usage" msgstr "" #. type: Plain text #: man-pages/man7/mdoc.samples.7:242 msgid "" "As in E<.Xr troff 1>, a macro is called by placing a E<.Ql \\&.> (dot " "character) at the beginning of a line followed by the two character name " "for the macro. Arguments may follow the macro separated by spaces. It is " "the dot character at the beginning of the line which causes E<.Xr troff 1> " "to interpret the next two characters as a macro name. To place a E<.Ql \\&." "> (dot character) at the beginning of a line in some context other than a " "macro invocation, precede the E<.Ql \\&.> (dot) with the E<.Ql \\e&> escape " "sequence. The E<.Ql \\e&> translates literally to a zero width space, and " "is never displayed in the output." msgstr "" #. type: Plain text #: man-pages/man7/mdoc.samples.7:257 msgid "" "In general, E<.Xr troff 1> macros accept up to nine arguments, any extra " "arguments are ignored. Most macros in E<.Nm \\-mdoc> accept nine arguments " "and, in limited cases, arguments may be continued or extended on the next " "line (See E<.Sx Extensions>). A few macros handle quoted arguments (see E<." "Sx Passing Space Characters in an Argument> below)." msgstr "" #. type: Plain text #: man-pages/man7/mdoc.samples.7:284 msgid "" "Most of the E<.Nm \\-mdoc> general text domain and manual domain macros are " "special in that their argument lists are E<.Em parsed> for callable macro " "names. This means an argument on the argument list which matches a general " "text or manual domain macro name and is determined to be callable will be " "executed or called when it is processed. In this case, the argument, " "although the name of a macro, is not preceded by a E<.Ql \\&.> (dot). It is " "in this manner that many macros are nested; for example the option macro, E<." "Ql \\&.Op>, may E<.Em call> the flag and argument macros, E<.Ql \\&Fl> and " "E<.Ql \\&Ar>, to specify an optional flag with an argument:" msgstr "" #. type: It #: man-pages/man7/mdoc.samples.7:285 #, no-wrap msgid "Op Fl s Ar bytes" msgstr "" #. type: Plain text #: man-pages/man7/mdoc.samples.7:288 msgid "is produced by E<.Li \\&.Op \\&Fl s \\&Ar bytes>" msgstr "" #. type: Plain text #: man-pages/man7/mdoc.samples.7:295 msgid "" "To prevent a two character string from being interpreted as a macro name, " "precede the string with the escape sequence E<.Ql \\e&>:" msgstr "" #. type: It #: man-pages/man7/mdoc.samples.7:296 #, no-wrap msgid "Op \\&Fl s \\&Ar bytes" msgstr "" #. type: Plain text #: man-pages/man7/mdoc.samples.7:299 msgid "is produced by E<.Li \\&.Op \\e&Fl s \\e&Ar bytes>" msgstr "" #. type: Plain text #: man-pages/man7/mdoc.samples.7:320 msgid "" "Here the strings E<.Ql \\&Fl> and E<.Ql \\&Ar> are not interpreted as macros." " Macros whose argument lists are parsed for callable arguments are referred " "to as parsed and macros which may be called from an argument list are " "referred to as callable throughout this document and in the companion quick " "reference manual E<.Xr mdoc 7>. This is a technical E<.Em faux pas> as " "almost all of the macros in E<.Nm \\-mdoc> are parsed, but as it was " "cumbersome to constantly refer to macros as being callable and being able to " "call other macros, the term parsed has been used." msgstr "" #. type: Ss #: man-pages/man7/mdoc.samples.7:320 #, no-wrap msgid "Passing Space Characters in an Argument" msgstr "" #. type: Plain text #: man-pages/man7/mdoc.samples.7:338 msgid "" "Sometimes it is desirable to give as one argument a string containing one or " "more blank space characters. This may be necessary to defeat the nine " "argument limit or to specify arguments to macros which expect particular " "arrangement of items in the argument list. For example, the function macro " "E<.Ql \\&.Fn> expects the first argument to be the name of a function and " "any remaining arguments to be function parameters. As E<.Tn \"ANSI C\"> " "stipulates the declaration of function parameters in the parenthesized " "parameter list, each parameter is guaranteed to be at minimum a two word " "string. For example, E<.Fa int foo>." msgstr "" #. type: Plain text #: man-pages/man7/mdoc.samples.7:353 msgid "" "There are two possible ways to pass an argument which contains an embedded " "space. E<.Em Implementation note>: Unfortunately, the most convenient way " "of passing spaces in between quotes by reassigning individual arguments " "before parsing was fairly expensive speed wise and space wise to implement " "in all the macros for E<.Tn AT&T> E<.Xr troff>. It is not expensive for E<." "Xr groff> but for the sake of portability, has been limited to the following " "macros which need it the most:" msgstr "" #. type: It #: man-pages/man7/mdoc.samples.7:355 #, no-wrap msgid "Li \\&Cd" msgstr "" #. type: Plain text #: man-pages/man7/mdoc.samples.7:358 msgid "Configuration declaration (section 4 E<.Sx SYNOPSIS>)" msgstr "" #. type: It #: man-pages/man7/mdoc.samples.7:358 #, no-wrap msgid "Li \\&Bl" msgstr "" #. type: Plain text #: man-pages/man7/mdoc.samples.7:360 msgid "Begin list (for the width specifier)." msgstr "" #. type: It #: man-pages/man7/mdoc.samples.7:360 #, no-wrap msgid "Li \\&Em" msgstr "" #. type: Plain text #: man-pages/man7/mdoc.samples.7:362 msgid "Emphasized text." msgstr "" #. type: It #: man-pages/man7/mdoc.samples.7:362 #, no-wrap msgid "Li \\&Fn" msgstr "" #. type: Plain text #: man-pages/man7/mdoc.samples.7:364 msgid "Functions (sections two and four)." msgstr "" #. type: It #: man-pages/man7/mdoc.samples.7:364 #, no-wrap msgid "Li \\&It" msgstr "" #. type: Plain text #: man-pages/man7/mdoc.samples.7:366 msgid "List items." msgstr "" #. type: It #: man-pages/man7/mdoc.samples.7:366 #, no-wrap msgid "Li \\&Li" msgstr "" #. type: Plain text #: man-pages/man7/mdoc.samples.7:368 msgid "Literal text." msgstr "" #. type: It #: man-pages/man7/mdoc.samples.7:368 #, no-wrap msgid "Li \\&Sy" msgstr "" #. type: Plain text #: man-pages/man7/mdoc.samples.7:370 msgid "Symbolic text." msgstr "" #. type: It #: man-pages/man7/mdoc.samples.7:370 #, no-wrap msgid "Li \\&%B" msgstr "" #. type: Plain text #: man-pages/man7/mdoc.samples.7:372 msgid "Book titles." msgstr "" #. type: It #: man-pages/man7/mdoc.samples.7:372 #, no-wrap msgid "Li \\&%J" msgstr "" #. type: Plain text #: man-pages/man7/mdoc.samples.7:374 msgid "Journal names." msgstr "" #. type: It #: man-pages/man7/mdoc.samples.7:374 #, no-wrap msgid "Li \\&%O" msgstr "" #. type: Plain text #: man-pages/man7/mdoc.samples.7:376 msgid "Optional notes for a reference." msgstr "" #. type: It #: man-pages/man7/mdoc.samples.7:376 #, no-wrap msgid "Li \\&%R" msgstr "" #. type: Plain text #: man-pages/man7/mdoc.samples.7:378 msgid "Report title (in a reference)." msgstr "" #. type: It #: man-pages/man7/mdoc.samples.7:378 #, no-wrap msgid "Li \\&%T" msgstr "" #. type: Plain text #: man-pages/man7/mdoc.samples.7:380 msgid "Title of article in a book or journal." msgstr "" #. type: Plain text #: man-pages/man7/mdoc.samples.7:397 msgid "" "One way of passing a string containing blank spaces is to use the hard or " "unpaddable space character E<.Ql \\e\\ >, that is, a blank space preceded by " "the escape character E<.Ql \\e>. This method may be used with any macro but " "has the side effect of interfering with the adjustment of text over the " "length of a line. E<.Xr Troff> sees the hard space as if it were any other " "printable character and cannot split the string into blank or newline " "separated pieces as one would expect. The method is useful for strings " "which are not expected to overlap a line boundary. For example:" msgstr "" #. type: It #: man-pages/man7/mdoc.samples.7:398 #, no-wrap msgid "Fn fetch char\\ *str" msgstr "" #. type: Plain text #: man-pages/man7/mdoc.samples.7:401 msgid "is created by E<.Ql \\&.Fn fetch char\\e *str>" msgstr "" #. type: It #: man-pages/man7/mdoc.samples.7:401 #, no-wrap msgid "Fn fetch \"char *str\"" msgstr "" #. type: Plain text #: man-pages/man7/mdoc.samples.7:404 msgid "can also be created by E<.Ql \\&.Fn fetch \"\\*qchar *str\\*q\">" msgstr "" #. type: Plain text #: man-pages/man7/mdoc.samples.7:413 msgid "" "If the E<.Ql \\e> or quotes were omitted, E<.Ql \\&.Fn> would see three " "arguments and the result would be:" msgstr "" #. type: Dl #: man-pages/man7/mdoc.samples.7:414 #, no-wrap msgid "Fn fetch char *str" msgstr "" #. type: Plain text #: man-pages/man7/mdoc.samples.7:420 msgid "" "For an example of what happens when the parameter list overlaps a newline " "boundary, see the E<.Sx BUGS> section." msgstr "" #. type: Ss #: man-pages/man7/mdoc.samples.7:420 #, no-wrap msgid "Trailing Blank Space Characters" msgstr "" #. type: Plain text #: man-pages/man7/mdoc.samples.7:433 msgid "" "E<.Xr Troff> can be confused by blank space characters at the end of a line. " " It is a wise preventive measure to globally remove all blank spaces from " "Eblank-spaceEEend-of-lineE character sequences. Should the " "need arise to force a blank character at the end of a line, it may be forced " "with an unpaddable space and the E<.Ql \\e&> escape character. For example, " "E<.Ql string\\e\\ \\e&>." msgstr "" #. type: Ss #: man-pages/man7/mdoc.samples.7:433 #, no-wrap msgid "Escaping Special Characters" msgstr "" #. type: Plain text #: man-pages/man7/mdoc.samples.7:445 msgid "" "Special characters like the newline character E<.Ql \\en>, are handled by " "replacing the E<.Ql \\e> with E<.Ql \\ee> (e.g., E<.Ql \\een>) to preserve " "the backslash." msgstr "" #. type: Sh #: man-pages/man7/mdoc.samples.7:445 #, no-wrap msgid "THE ANATOMY OF A MAN PAGE" msgstr "" #. type: Plain text #: man-pages/man7/mdoc.samples.7:452 msgid "" "The body of a man page is easily constructed from a basic template found in " "the file E<.Pa /usr/share/misc/mdoc.template>. Several example man pages " "can also be found in E<.Pa /usr/share/examples/mdoc>." msgstr "" #. type: Ss #: man-pages/man7/mdoc.samples.7:453 #, no-wrap msgid "A manual page template" msgstr "" #. type: Plain text #: man-pages/man7/mdoc.samples.7:484 #, no-wrap msgid "" "\\&.\\e\" The following requests are required for all man pages.\n" "\\&.Dd Month day, year\n" "\\&.Os OPERATING_SYSTEM [version/release]\n" "\\&.Dt DOCUMENT_TITLE [section number] [volume]\n" "\\&.Sh NAME\n" "\\&.Nm name\n" "\\&.Nd one line description of name\n" "\\&.Sh SYNOPSIS\n" "\\&.Sh DESCRIPTION\n" "\\&.\\e\" The following requests should be uncommented and\n" "\\&.\\e\" used where appropriate. This next request is\n" "\\&.\\e\" for sections 2 and 3 function return values only.\n" "\\&.\\e\" .Sh RETURN VALUE\n" "\\&.\\e\" This next request is for sections 1, 6, 7 & 8 only\n" "\\&.\\e\" .Sh ENVIRONMENT\n" "\\&.\\e\" .Sh FILES\n" "\\&.\\e\" .Sh EXAMPLES\n" "\\&.\\e\" This next request is for sections 1, 6, 7 & 8 only\n" "\\&.\\e\" (command return values (to shell) and\n" "\\&.\\e\" fprintf/stderr type diagnostics)\n" "\\&.\\e\" .Sh DIAGNOSTICS\n" "\\&.\\e\" The next request is for sections 2 and 3 error\n" "\\&.\\e\" and signal handling only.\n" "\\&.\\e\" .Sh ERRORS\n" "\\&.\\e\" .Sh SEE ALSO\n" "\\&.\\e\" .Sh CONFORMING TO\n" "\\&.\\e\" .Sh HISTORY\n" "\\&.\\e\" .Sh AUTHORS\n" "\\&.\\e\" .Sh BUGS\n" msgstr "" #. type: Plain text #: man-pages/man7/mdoc.samples.7:498 msgid "" "The first items in the template are the macros E<.Pq Li \\&.Dd , \\&.Os , " "\\&.Dt>; the document date, the operating system the man page or subject " "source is developed or modified for, and the man page title E<.Pq Em in " "uppercase> along with the section of the manual the page belongs in. These " "macros identify the page, and are discussed below in E<.Sx TITLE MACROS>." msgstr "" #. type: Plain text #: man-pages/man7/mdoc.samples.7:517 msgid "" "The remaining items in the template are section headers E<.Pq Li \\&.Sh>; of " "which E<.Sx NAME>, E<.Sx SYNOPSIS> and E<.Sx DESCRIPTION> are mandatory. " "The headers are discussed in E<.Sx PAGE STRUCTURE DOMAIN>, after " "presentation of E<.Sx MANUAL DOMAIN>. Several content macros are used to " "demonstrate page layout macros; reading about content macros before page " "layout macros is recommended." msgstr "" #. type: Sh #: man-pages/man7/mdoc.samples.7:517 #, no-wrap msgid "TITLE MACROS" msgstr "" #. type: Plain text #: man-pages/man7/mdoc.samples.7:526 msgid "" "The title macros are the first portion of the page structure domain, but are " "presented first and separate for someone who wishes to start writing a man " "page yesterday. Three header macros designate the document title or manual " "page title, the operating system, and the date of authorship. These macros " "are one called once at the very beginning of the document and are used to " "construct the headers and footers only." msgstr "" #. type: It #: man-pages/man7/mdoc.samples.7:527 #, no-wrap msgid "Li \\&.Dt DOCUMENT_TITLE section# [volume]" msgstr "" #. .Cl #. USD UNIX User's Supplementary Documents #. .Cl #. PS1 UNIX Programmer's Supplementary Documents #. type: Plain text #: man-pages/man7/mdoc.samples.7:541 msgid "" "The document title is the subject of the man page and must be in E<.Tn " "CAPITALS> due to troff limitations. The section number may be 1,\\ ...,\\ " "8, and if it is specified, the volume title may be omitted. A volume title " "may be arbitrary or one of the following:" msgstr "" #. type: It #: man-pages/man7/mdoc.samples.7:543 #, no-wrap msgid "Li \"AMD UNIX Ancestral Manual Documents\"" msgstr "" #. type: It #: man-pages/man7/mdoc.samples.7:544 #, no-wrap msgid "Li \"SMM UNIX System Manager's Manual\"" msgstr "" #. type: It #: man-pages/man7/mdoc.samples.7:545 #, no-wrap msgid "Li \"URM UNIX Reference Manual\"" msgstr "" #. type: It #: man-pages/man7/mdoc.samples.7:546 #, no-wrap msgid "Li \"PRM UNIX Programmer's Manual\"" msgstr "" #. .Cl #. MMI UNIX Manual Master Index #. .Cl #. CON UNIX Contributed Software Manual #. .Cl #. LOC UNIX Local Manual #. type: Plain text #: man-pages/man7/mdoc.samples.7:562 msgid "" "The default volume labeling is E<.Li URM> for sections 1, 6, and 7; E<.Li " "SMM> for section 8; E<.Li PRM> for sections 2, 3, 4, and 5." msgstr "" #. type: It #: man-pages/man7/mdoc.samples.7:562 #, no-wrap msgid "Li \\&.Os operating_system release#" msgstr "" #. type: Plain text #: man-pages/man7/mdoc.samples.7:575 msgid "" "The name of the operating system should be the common acronym, for example, " "E<.Tn BSD> or E<.Tn FreeBSD> or E<.Tn ATT>. The release should be the " "standard release nomenclature for the system specified, for example, 4.3, 4." "3+Tahoe, V.3, V.4. Unrecognized arguments are displayed as given in the " "page footer. For instance, a typical footer might be:" msgstr "" #. type: Dl #: man-pages/man7/mdoc.samples.7:576 #, no-wrap msgid "\\&.Os 4.3BSD" msgstr "" #. type: Plain text #: man-pages/man7/mdoc.samples.7:579 msgid "or" msgstr "" #. type: Dl #: man-pages/man7/mdoc.samples.7:579 #, no-wrap msgid "\\&.Os FreeBSD 2.2" msgstr "" #. type: Plain text #: man-pages/man7/mdoc.samples.7:582 msgid "or for a locally produced set" msgstr "" #. type: Dl #: man-pages/man7/mdoc.samples.7:583 #, no-wrap msgid "\\&.Os CS Department" msgstr "" #. type: Plain text #: man-pages/man7/mdoc.samples.7:598 msgid "" "The Berkeley default, E<.Ql \\&.Os> without an argument, has been defined as " "E<.Tn BSD> in the site-specific file E<.Pa /usr/share/tmac/mdoc/doc-common>. " " It really should default to E<.Tn LOCAL>. Note, if the E<.Ql \\&.Os> macro " "is not present, the bottom left corner of the page will be ugly." msgstr "" #. type: It #: man-pages/man7/mdoc.samples.7:598 #, no-wrap msgid "Li \\&.Dd month day, year" msgstr "" #. type: Plain text #: man-pages/man7/mdoc.samples.7:600 msgid "The date should be written formally:" msgstr "" #. type: Dl #: man-pages/man7/mdoc.samples.7:602 #, no-wrap msgid "January 25, 1989" msgstr "" #. type: Sh #: man-pages/man7/mdoc.samples.7:604 #, no-wrap msgid "INTRODUCTION OF MANUAL AND GENERAL TEXT DOMAINS" msgstr "" #. type: Ss #: man-pages/man7/mdoc.samples.7:605 #, no-wrap msgid "What's in a name..." msgstr "" #. type: Plain text #: man-pages/man7/mdoc.samples.7:622 msgid "" "The manual domain macro names are derived from the day to day informal " "language used to describe commands, subroutines and related files. Slightly " "different variations of this language are used to describe the three " "different aspects of writing a man page. First, there is the description of " "E<.Nm \\-mdoc> macro request usage. Second is the description of a E<.Ux> " "command E<.Em with> E<.Nm \\-mdoc> macros and third, the description of a " "command to a user in the verbal sense; that is, discussion of a command in " "the text of a man page." msgstr "" #. type: Plain text #: man-pages/man7/mdoc.samples.7:627 msgid "" "In the first case, E<.Xr troff 1> macros are themselves a type of command; " "the general syntax for a troff command is:" msgstr "" #. type: Plain text #: man-pages/man7/mdoc.samples.7:629 #, no-wrap msgid "\\&.Va argument1 argument2 ... argument9\n" msgstr "" #. type: Plain text #: man-pages/man7/mdoc.samples.7:643 msgid "" "The E<.Ql \\&.Va> is a macro command or request, and anything following it " "is an argument to be processed. In the second case, the description of a E<." "Ux> command using the content macros is a bit more involved; a typical E<.Sx " "SYNOPSIS> command line might be displayed as:" msgstr "" #. type: Plain text #: man-pages/man7/mdoc.samples.7:647 #, no-wrap msgid "E<.Nm filter>\n" "E<.Op Fl flag>\n" "E<.Ar infile outfile>\n" msgstr "" #. type: Plain text #: man-pages/man7/mdoc.samples.7:667 msgid "" "Here, E<.Nm filter> is the command name and the bracketed string E<.Fl flag> " "is a E<.Em flag> argument designated as optional by the option brackets. In " "E<.Nm \\-mdoc> terms, E<.Ar infile> and E<.Ar outfile> are called E<.Em " "arguments>. The macros which formatted the above example:" msgstr "" #. type: Plain text #: man-pages/man7/mdoc.samples.7:671 #, no-wrap msgid "\\&.Nm filter\n" "\\&.Op \\&Fl flag\n" "\\&.Ar infile outfile\n" msgstr "" #. type: Plain text #: man-pages/man7/mdoc.samples.7:685 msgid "" "In the third case, discussion of commands and command syntax includes both " "examples above, but may add more detail. The arguments E<.Ar infile> and E<." "Ar outfile> from the example above might be referred to as E<.Em operands> " "or E<.Em file arguments>. Some command-line argument lists are quite long:" msgstr "" #. type: It #: man-pages/man7/mdoc.samples.7:686 #, no-wrap msgid "Nm make" msgstr "" #. type: Plain text #: man-pages/man7/mdoc.samples.7:699 msgid "" "E<.Op Fl eiknqrstv> E<.Op Fl D Ar variable> E<.Op Fl d Ar flags> E<.Op Fl f " "Ar makefile> E<.Bk -words> E<.Op Fl I Ar directory> E<.Ek> E<.Op Fl j Ar " "max_jobs> E<.Op Ar variable=value> E<.Bk -words> E<.Op Ar target ...> E<.Ek>" msgstr "" #. type: Plain text #: man-pages/man7/mdoc.samples.7:725 msgid "" "Here one might talk about the command E<.Nm make> and qualify the argument " "E<.Ar makefile>, as an argument to the flag, E<.Fl f>, or discuss the " "optional file operand E<.Ar target>. In the verbal context, such detail can " "prevent confusion, however the E<.Nm \\-mdoc> package does not have a macro " "for an argument E<.Em to> a flag. Instead the E<.Ql \\&Ar> argument macro " "is used for an operand or file argument like E<.Ar target> as well as an " "argument to a flag like E<.Ar variable>. The make command line was produced " "from:" msgstr "" #. type: Plain text #: man-pages/man7/mdoc.samples.7:737 #, no-wrap msgid "" "\\&.Nm make\n" "\\&.Op Fl eiknqrstv\n" "\\&.Op Fl D Ar variable\n" "\\&.Op Fl d Ar flags\n" "\\&.Op Fl f Ar makefile\n" "\\&.Op Fl I Ar directory\n" "\\&.Op Fl j Ar max_jobs\n" "\\&.Op Ar variable=value\n" "\\&.Bk -words\n" "\\&.Op Ar target ...\n" "\\&.Ek\n" msgstr "" #. type: Plain text #: man-pages/man7/mdoc.samples.7:745 msgid "" "The E<.Ql \\&.Bk> and E<.Ql \\&.Ek> macros are explained in E<.Sx Keeps>." msgstr "" #. type: Ss #: man-pages/man7/mdoc.samples.7:745 #, no-wrap msgid "General Syntax" msgstr "" #. type: Plain text #: man-pages/man7/mdoc.samples.7:768 msgid "" "The manual domain and general text domain macros share a similar syntax with " "a few minor deviations: E<.Ql \\&.Ar>, E<.Ql \\&.Fl>, E<.Ql \\&.Nm>, and E<." "Ql \\&.Pa> differ only when called without arguments; E<.Ql \\&.Fn> and E<." "Ql \\&.Xr> impose an order on their argument lists and the E<.Ql \\&.Op> and " "E<.Ql \\&.Fn> macros have nesting limitations. All content macros are " "capable of recognizing and properly handling punctuation, provided each " "punctuation character is separated by a leading space. If a request is " "given:" msgstr "" #. type: Dl #: man-pages/man7/mdoc.samples.7:769 #, no-wrap msgid "\\&.Li sptr, ptr)," msgstr "" #. type: Plain text #: man-pages/man7/mdoc.samples.7:772 man-pages/man7/mdoc.samples.7:782 msgid "The result is:" msgstr "" #. type: Dl #: man-pages/man7/mdoc.samples.7:773 #, no-wrap msgid "Li sptr, ptr)," msgstr "" #. type: Plain text #: man-pages/man7/mdoc.samples.7:778 msgid "" "The punctuation is not recognized and all is output in the literal font. If " "the punctuation is separated by a leading white space:" msgstr "" #. type: Dl #: man-pages/man7/mdoc.samples.7:779 #, no-wrap msgid "\\&.Li \"sptr , ptr ) ,\"" msgstr "" #. type: Dl #: man-pages/man7/mdoc.samples.7:783 #, no-wrap msgid "Li sptr , ptr ) ," msgstr "" #. type: Plain text #: man-pages/man7/mdoc.samples.7:787 msgid "" "The punctuation is now recognized and is output in the default font " "distinguishing it from the strings in literal font." msgstr "" #. type: Plain text #: man-pages/man7/mdoc.samples.7:796 msgid "" "To remove the special meaning from a punctuation character escape it with E<." "Ql \\e&>. E<.Xr Troff> is limited as a macro language, and has difficulty " "when presented with a string containing a member of the mathematical, " "logical or quotation set:" msgstr "" #. type: Plain text #: man-pages/man7/mdoc.samples.7:798 #, no-wrap msgid "\\&{+,\\-,/,*,\\&%,E,E,E=,E=,=,==,&,`,',\"}\n" msgstr "" #. type: Plain text #: man-pages/man7/mdoc.samples.7:810 msgid "" "The problem is that E<.Xr troff> may assume it is supposed to actually " "perform the operation or evaluation suggested by the characters. To prevent " "the accidental evaluation of these characters, escape them with E<.Ql \\e&>. " " Typical syntax is shown in the first content macro displayed below, E<.Ql " "\\&.Ad>." msgstr "" #. type: Sh #: man-pages/man7/mdoc.samples.7:810 #, no-wrap msgid "MANUAL DOMAIN" msgstr "" #. type: Ss #: man-pages/man7/mdoc.samples.7:811 #, no-wrap msgid "Address Macro" msgstr "" #. type: Plain text #: man-pages/man7/mdoc.samples.7:814 msgid "" "The address macro identifies an address construct of the form " "addr1[,addr2[,addr3]]." msgstr "" #. type: Dl #: man-pages/man7/mdoc.samples.7:815 #, no-wrap msgid "Usage: .Ad address ... \\*(Pu" msgstr "" #. type: It #: man-pages/man7/mdoc.samples.7:817 #, no-wrap msgid "Li \\&.Ad addr1" msgstr "" #. type: Plain text #: man-pages/man7/mdoc.samples.7:819 msgid "E<.Ad addr1>" msgstr "" #. type: It #: man-pages/man7/mdoc.samples.7:819 #, no-wrap msgid "Li \\&.Ad addr1\\ ." msgstr "" #. type: Plain text #: man-pages/man7/mdoc.samples.7:821 msgid "E<.Ad addr1>." msgstr "" #. type: It #: man-pages/man7/mdoc.samples.7:821 #, no-wrap msgid "Li \\&.Ad addr1\\ , file2" msgstr "" #. type: Plain text #: man-pages/man7/mdoc.samples.7:823 msgid "E<.Ad addr1 , file2>" msgstr "" #. type: It #: man-pages/man7/mdoc.samples.7:823 #, no-wrap msgid "Li \\&.Ad f1\\ , f2\\ , f3\\ :" msgstr "" #. type: Plain text #: man-pages/man7/mdoc.samples.7:825 msgid "E<.Ad f1 , f2 , f3>:" msgstr "" #. type: It #: man-pages/man7/mdoc.samples.7:825 #, no-wrap msgid "Li \\&.Ad addr\\ )\\ )\\ ," msgstr "" #. type: Plain text #: man-pages/man7/mdoc.samples.7:827 msgid "E<.Ad addr>))," msgstr "" #. type: Plain text #: man-pages/man7/mdoc.samples.7:834 msgid "" "It is an error to call E<.Ql \\&.Ad> without arguments. E<.Ql \\&.Ad> is " "callable by other macros and is parsed." msgstr "" #. type: Ss #: man-pages/man7/mdoc.samples.7:834 #, no-wrap msgid "Author Name" msgstr "" #. type: Plain text #: man-pages/man7/mdoc.samples.7:841 msgid "" "The E<.Ql \\&.An> macro is used to specify the name of the author of the " "item being documented, or the name of the author of the actual manual page. " "Any remaining arguments after the name information are assumed to be " "punctuation." msgstr "" #. type: Dl #: man-pages/man7/mdoc.samples.7:842 #, no-wrap msgid "Usage: .An author_name \\*(Pu" msgstr "" #. type: It #: man-pages/man7/mdoc.samples.7:844 #, no-wrap msgid "Li \\&.An Joe\\ Author" msgstr "" #. type: Plain text #: man-pages/man7/mdoc.samples.7:846 msgid "E<.An Joe Author>" msgstr "" #. type: It #: man-pages/man7/mdoc.samples.7:846 #, no-wrap msgid "Li \\&.An Joe\\ Author\\ ," msgstr "" #. type: Plain text #: man-pages/man7/mdoc.samples.7:848 msgid "E<.An Joe\\ Author>," msgstr "" #. type: It #: man-pages/man7/mdoc.samples.7:848 #, no-wrap msgid "Li \\&.An Joe\\ Author\\ \\&Aq\\ nobody@FreeBSD.ORG" msgstr "" #. type: Plain text #: man-pages/man7/mdoc.samples.7:850 msgid "E<.An Joe Author Aq nobody@FreeBSD.ORG>" msgstr "" #. type: It #: man-pages/man7/mdoc.samples.7:850 #, no-wrap msgid "Li \\&.An Joe\\ Author\\ )\\ )\\ ," msgstr "" #. type: Plain text #: man-pages/man7/mdoc.samples.7:852 msgid "E<.An Joe Author>))," msgstr "" #. type: Plain text #: man-pages/man7/mdoc.samples.7:861 msgid "" "The E<.Ql \\&.An> macro is parsed and is callable. It is an error to call " "E<.Ql \\&.An> without any arguments." msgstr "" #. type: Ss #: man-pages/man7/mdoc.samples.7:861 #, no-wrap msgid "Argument Macro" msgstr "" #. type: Plain text #: man-pages/man7/mdoc.samples.7:866 msgid "" "The E<.Ql \\&.Ar> argument macro may be used whenever a command-line " "argument is referenced." msgstr "" #. type: Dl #: man-pages/man7/mdoc.samples.7:867 #, no-wrap msgid "Usage: .Ar argument ... \\*(Pu" msgstr "" #. type: It #: man-pages/man7/mdoc.samples.7:869 #, no-wrap msgid "Li \\&.Ar" msgstr "" #. type: Plain text #: man-pages/man7/mdoc.samples.7:871 msgid "E<.Ar>" msgstr "" #. type: It #: man-pages/man7/mdoc.samples.7:871 #, no-wrap msgid "Li \\&.Ar file1" msgstr "" #. type: Plain text #: man-pages/man7/mdoc.samples.7:873 msgid "E<.Ar file1>" msgstr "" #. type: It #: man-pages/man7/mdoc.samples.7:873 #, no-wrap msgid "Li \\&.Ar file1\\ ." msgstr "" #. type: Plain text #: man-pages/man7/mdoc.samples.7:875 msgid "E<.Ar file1>." msgstr "" #. type: It #: man-pages/man7/mdoc.samples.7:875 #, no-wrap msgid "Li \\&.Ar file1 file2" msgstr "" #. type: Plain text #: man-pages/man7/mdoc.samples.7:877 msgid "E<.Ar file1 file2>" msgstr "" #. type: It #: man-pages/man7/mdoc.samples.7:877 #, no-wrap msgid "Li \\&.Ar f1 f2 f3\\ :" msgstr "" #. type: Plain text #: man-pages/man7/mdoc.samples.7:879 msgid "E<.Ar f1 f2 f3>:" msgstr "" #. type: It #: man-pages/man7/mdoc.samples.7:879 #, no-wrap msgid "Li \\&.Ar file\\ )\\ )\\ ," msgstr "" #. type: Plain text #: man-pages/man7/mdoc.samples.7:881 msgid "E<.Ar file>))," msgstr "" #. type: Plain text #: man-pages/man7/mdoc.samples.7:891 msgid "" "If E<.Ql \\&.Ar> is called without arguments, E<.Ql \\&Ar> is assumed. The " "E<.Ql \\&.Ar> macro is parsed and is callable." msgstr "" #. type: Ss #: man-pages/man7/mdoc.samples.7:891 #, no-wrap msgid "Configuration Declaration (section four only)" msgstr "" #. type: Plain text #: man-pages/man7/mdoc.samples.7:898 msgid "" "The E<.Ql \\&.Cd> macro is used to demonstrate a E<.Xr config 8> declaration " "for a device interface in a section four manual. This macro accepts quoted " "arguments (double quotes only)." msgstr "" #. type: It #: man-pages/man7/mdoc.samples.7:900 #, no-wrap msgid "Cd \"device le0 at scode?\"" msgstr "" #. type: Plain text #: man-pages/man7/mdoc.samples.7:903 msgid "produced by: E<.Ql \".Cd device le0 at scode?\">." msgstr "" #. type: Ss #: man-pages/man7/mdoc.samples.7:904 #, no-wrap msgid "Command Modifier" msgstr "" #. type: Plain text #: man-pages/man7/mdoc.samples.7:918 msgid "" "The command modifier is identical to the E<.Ql \\&.Fl> (flag) command with " "the exception the E<.Ql \\&.Cm> macro does not assert a dash in front of " "every argument. Traditionally flags are marked by the preceding dash, some " "commands or subsets of commands do not use them. Command modifiers may also " "be specified in conjunction with interactive commands such as editor " "commands. See E<.Sx Flags>." msgstr "" #. type: Ss #: man-pages/man7/mdoc.samples.7:918 #, no-wrap msgid "Defined Variables" msgstr "" #. type: Plain text #: man-pages/man7/mdoc.samples.7:922 msgid "" "A variable which is defined in an include file is specified by the macro E<." "Ql \\&.Dv>." msgstr "" #. type: Dl #: man-pages/man7/mdoc.samples.7:923 #, no-wrap msgid "Usage: .Dv defined_variable ... \\*(Pu" msgstr "" #. type: It #: man-pages/man7/mdoc.samples.7:925 #, no-wrap msgid "Li \".Dv MAXHOSTNAMELEN\"" msgstr "" #. type: Plain text #: man-pages/man7/mdoc.samples.7:927 msgid "E<.Dv MAXHOSTNAMELEN>" msgstr "" #. type: It #: man-pages/man7/mdoc.samples.7:927 #, no-wrap msgid "Li \".Dv TIOCGPGRP )\"" msgstr "" #. type: Plain text #: man-pages/man7/mdoc.samples.7:929 msgid "E<.Dv TIOCGPGRP>)" msgstr "" #. type: Plain text #: man-pages/man7/mdoc.samples.7:936 msgid "" "It is an error to call E<.Ql \\&.Dv> without arguments. E<.Ql \\&.Dv> is " "parsed and is callable." msgstr "" #. type: Ss #: man-pages/man7/mdoc.samples.7:936 #, no-wrap msgid "Errno's (Section two only)" msgstr "" #. type: Plain text #: man-pages/man7/mdoc.samples.7:948 msgid "" "The E<.Ql \\&.Er> errno macro specifies the error return value for section " "two library routines. The second example below shows E<.Ql \\&.Er> used " "with the E<.Ql \\&.Bq> general text domain macro, as it would be used in a " "section two manual page." msgstr "" #. type: Dl #: man-pages/man7/mdoc.samples.7:949 #, no-wrap msgid "Usage: .Er ERRNOTYPE ... \\*(Pu" msgstr "" #. type: It #: man-pages/man7/mdoc.samples.7:951 #, no-wrap msgid "Li \\&.Er ENOENT" msgstr "" #. type: Plain text #: man-pages/man7/mdoc.samples.7:953 msgid "E<.Er ENOENT>" msgstr "" #. type: It #: man-pages/man7/mdoc.samples.7:953 #, no-wrap msgid "Li \\&.Er ENOENT\\ )\\ ;" msgstr "" #. type: Plain text #: man-pages/man7/mdoc.samples.7:955 msgid "E<.Er ENOENT>);" msgstr "" #. type: It #: man-pages/man7/mdoc.samples.7:955 #, no-wrap msgid "Li \\&.Bq \\&Er ENOTDIR" msgstr "" #. type: Plain text #: man-pages/man7/mdoc.samples.7:957 msgid "E<.Bq Er ENOTDIR>" msgstr "" #. type: Plain text #: man-pages/man7/mdoc.samples.7:965 msgid "" "It is an error to call E<.Ql \\&.Er> without arguments. The E<.Ql \\&.Er> " "macro is parsed and is callable." msgstr "" #. type: Ss #: man-pages/man7/mdoc.samples.7:965 #, no-wrap msgid "Environment Variables" msgstr "" #. type: Plain text #: man-pages/man7/mdoc.samples.7:969 msgid "The E<.Ql \\&.Ev> macro specifies an environment variable." msgstr "" #. type: Dl #: man-pages/man7/mdoc.samples.7:970 #, no-wrap msgid "Usage: .Ev argument ... \\*(Pu" msgstr "" #. type: It #: man-pages/man7/mdoc.samples.7:972 #, no-wrap msgid "Li \\&.Ev DISPLAY" msgstr "" #. type: Plain text #: man-pages/man7/mdoc.samples.7:974 msgid "E<.Ev DISPLAY>" msgstr "" #. type: It #: man-pages/man7/mdoc.samples.7:974 #, no-wrap msgid "Li \\&.Ev PATH\\ ." msgstr "" #. type: Plain text #: man-pages/man7/mdoc.samples.7:976 msgid "E<.Ev PATH>." msgstr "" #. type: It #: man-pages/man7/mdoc.samples.7:976 #, no-wrap msgid "Li \\&.Ev PRINTER\\ )\\ )\\ ," msgstr "" #. type: Plain text #: man-pages/man7/mdoc.samples.7:978 msgid "E<.Ev PRINTER>))," msgstr "" #. type: Plain text #: man-pages/man7/mdoc.samples.7:986 msgid "" "It is an error to call E<.Ql \\&.Ev> without arguments. The E<.Ql \\&.Ev> " "macro is parsed and is callable." msgstr "" #. type: Ss #: man-pages/man7/mdoc.samples.7:986 #, no-wrap msgid "Function Argument" msgstr "" #. type: Plain text #: man-pages/man7/mdoc.samples.7:1005 msgid "" "The E<.Ql \\&.Fa> macro is used to refer to function arguments (parameters) " "outside of the E<.Sx SYNOPSIS> section of the manual or inside the E<.Sx " "SYNOPSIS> section should a parameter list be too long for the E<.Ql \\&.Fn> " "macro and the enclosure macros E<.Ql \\&.Fo> and E<.Ql \\&.Fc> must be used. " " E<.Ql \\&.Fa> may also be used to refer to structure members." msgstr "" #. type: Dl #: man-pages/man7/mdoc.samples.7:1006 #, no-wrap msgid "Usage: .Fa function_argument ... \\*(Pu" msgstr "" #. type: It #: man-pages/man7/mdoc.samples.7:1008 #, no-wrap msgid "Li \\&.Fa d_namlen\\ )\\ )\\ ," msgstr "" #. type: Plain text #: man-pages/man7/mdoc.samples.7:1010 msgid "E<.Fa d_namlen>))," msgstr "" #. type: It #: man-pages/man7/mdoc.samples.7:1010 #, no-wrap msgid "Li \\&.Fa iov_len" msgstr "" #. type: Plain text #: man-pages/man7/mdoc.samples.7:1012 msgid "E<.Fa iov_len>" msgstr "" #. type: Plain text #: man-pages/man7/mdoc.samples.7:1019 msgid "" "It is an error to call E<.Ql \\&.Fa> without arguments. E<.Ql \\&.Fa> is " "parsed and is callable." msgstr "" #. type: Ss #: man-pages/man7/mdoc.samples.7:1019 #, no-wrap msgid "Function Declaration" msgstr "" #. type: Plain text #: man-pages/man7/mdoc.samples.7:1030 msgid "" "The E<.Ql \\&.Fd> macro is used in the E<.Sx SYNOPSIS> section with section " "two or three functions. The E<.Ql \\&.Fd> macro does not call other macros " "and is not callable by other macros." msgstr "" #. type: Dl #: man-pages/man7/mdoc.samples.7:1031 #, no-wrap msgid "Usage: .Fd include_file (or defined variable)" msgstr "" #. type: Plain text #: man-pages/man7/mdoc.samples.7:1042 msgid "" "In the E<.Sx SYNOPSIS> section a E<.Ql \\&.Fd> request causes a line break " "if a function has already been presented and a break has not occurred. This " "leaves a nice vertical space in between the previous function call and the " "declaration for the next function." msgstr "" #. type: Ss #: man-pages/man7/mdoc.samples.7:1042 #, no-wrap msgid "Flags" msgstr "" #. type: Plain text #: man-pages/man7/mdoc.samples.7:1055 msgid "" "The E<.Ql \\&.Fl> macro handles command-line flags. It prepends a dash, E<." "Ql \\->, to the flag. For interactive command flags, which are not " "prepended with a dash, the E<.Ql \\&.Cm> (command modifier) macro is " "identical, but without the dash." msgstr "" #. type: Dl #: man-pages/man7/mdoc.samples.7:1056 #, no-wrap msgid "Usage: .Fl argument ... \\*(Pu" msgstr "" #. type: It #: man-pages/man7/mdoc.samples.7:1058 #, no-wrap msgid "Li \\&.Fl" msgstr "" #. type: Plain text #: man-pages/man7/mdoc.samples.7:1060 msgid "E<.Fl>" msgstr "" #. type: It #: man-pages/man7/mdoc.samples.7:1060 #, no-wrap msgid "Li \\&.Fl cfv" msgstr "" #. type: Plain text #: man-pages/man7/mdoc.samples.7:1062 msgid "E<.Fl cfv>" msgstr "" #. type: It #: man-pages/man7/mdoc.samples.7:1062 #, no-wrap msgid "Li \\&.Fl cfv\\ ." msgstr "" #. type: Plain text #: man-pages/man7/mdoc.samples.7:1064 msgid "E<.Fl cfv>." msgstr "" #. type: It #: man-pages/man7/mdoc.samples.7:1064 #, no-wrap msgid "Li \\&.Fl s v t" msgstr "" #. type: Plain text #: man-pages/man7/mdoc.samples.7:1066 msgid "E<.Fl s v t>" msgstr "" #. type: It #: man-pages/man7/mdoc.samples.7:1066 #, no-wrap msgid "Li \\&.Fl -\\ ," msgstr "" #. type: Plain text #: man-pages/man7/mdoc.samples.7:1068 msgid "E<.Fl ->," msgstr "" #. type: It #: man-pages/man7/mdoc.samples.7:1068 #, no-wrap msgid "Li \\&.Fl xyz\\ )\\ ," msgstr "" #. type: Plain text #: man-pages/man7/mdoc.samples.7:1070 msgid "E<.Fl xyz>)," msgstr "" #. type: Plain text #: man-pages/man7/mdoc.samples.7:1082 msgid "" "The E<.Ql \\&.Fl> macro without any arguments results in a dash representing " "I/I. Note that giving E<.Ql \\&.Fl> a single dash, will " "result in two dashes. The E<.Ql \\&.Fl> macro is parsed and is callable." msgstr "" #. type: Ss #: man-pages/man7/mdoc.samples.7:1082 #, no-wrap msgid "Functions (library routines)" msgstr "" #. type: Plain text #: man-pages/man7/mdoc.samples.7:1084 msgid "The .Fn macro is modeled on ANSI C conventions." msgstr "" #. type: Plain text #: man-pages/man7/mdoc.samples.7:1086 #, no-wrap msgid "Usage: .Fn [type] function [[type] parameters ... \\*(Pu]\n" msgstr "" #. type: It #: man-pages/man7/mdoc.samples.7:1088 #, no-wrap msgid "Li \"\\&.Fn getchar\"" msgstr "" #. type: Plain text #: man-pages/man7/mdoc.samples.7:1090 msgid "E<.Fn getchar>" msgstr "" #. type: It #: man-pages/man7/mdoc.samples.7:1090 #, no-wrap msgid "Li \"\\&.Fn strlen ) ,\"" msgstr "" #. type: Plain text #: man-pages/man7/mdoc.samples.7:1092 msgid "E<.Fn strlen>)," msgstr "" #. type: It #: man-pages/man7/mdoc.samples.7:1092 #, no-wrap msgid "Li \\&.Fn \"\\*qint align\\*q\" \"\\*qconst * char *sptrs\\*q\" ," msgstr "" #. type: Plain text #: man-pages/man7/mdoc.samples.7:1094 msgid "E<.Fn \"int align\" \"const * char *sptrs\">," msgstr "" #. type: Plain text #: man-pages/man7/mdoc.samples.7:1107 msgid "" "It is an error to call E<.Ql \\&.Fn> without any arguments. The E<.Ql \\&." "Fn> macro is parsed and is callable, note that any call to another macro " "signals the end of the E<.Ql \\&.Fn> call (it will close-parenthesis at that " "point)." msgstr "" #. type: Plain text #: man-pages/man7/mdoc.samples.7:1121 msgid "" "For functions that have more than eight parameters (and this is rare), the " "macros E<.Ql \\&.Fo> (function open) and E<.Ql \\&.Fc> (function close) " "may be used with E<.Ql \\&.Fa> (function argument) to get around the " "limitation. For example:" msgstr "" #. type: Plain text #: man-pages/man7/mdoc.samples.7:1133 #, no-wrap msgid "" "\\&.Fo \"int res_mkquery\"\n" "\\&.Fa \"int op\"\n" "\\&.Fa \"char *dname\"\n" "\\&.Fa \"int class\"\n" "\\&.Fa \"int type\"\n" "\\&.Fa \"char *data\"\n" "\\&.Fa \"int datalen\"\n" "\\&.Fa \"struct rrec *newrr\"\n" "\\&.Fa \"char *buf\"\n" "\\&.Fa \"int buflen\"\n" "\\&.Fc\n" msgstr "" #. type: Plain text #: man-pages/man7/mdoc.samples.7:1136 man-pages/man7/mdoc.samples.7:2480 msgid "Produces:" msgstr "" #. type: Plain text #: man-pages/man7/mdoc.samples.7:1148 #, no-wrap msgid "" "E<.Fo \"int res_mkquery\">\n" "E<.Fa \"int op\">\n" "E<.Fa \"char *dname\">\n" "E<.Fa \"int class\">\n" "E<.Fa \"int type\">\n" "E<.Fa \"char *data\">\n" "E<.Fa \"int datalen\">\n" "E<.Fa \"struct rrec *newrr\">\n" "E<.Fa \"char *buf\">\n" "E<.Fa \"int buflen\">\n" "E<.Fc>\n" msgstr "" #. type: Plain text #: man-pages/man7/mdoc.samples.7:1171 msgid "" "The E<.Ql \\&.Fo> and E<.Ql \\&.Fc> macros are parsed and are callable. In " "the E<.Sx SYNOPSIS> section, the function will always begin at the beginning " "of line. If there is more than one function presented in the E<.Sx " "SYNOPSIS> section and a function type has not been given, a line break will " "occur, leaving a nice vertical space between the current function name and " "the one prior. At the moment, E<.Ql \\&.Fn> does not check its word " "boundaries against troff line lengths and may split across a newline " "ungracefully. This will be fixed in the near future." msgstr "" #. type: Ss #: man-pages/man7/mdoc.samples.7:1171 #, no-wrap msgid "Function Type" msgstr "" #. type: Plain text #: man-pages/man7/mdoc.samples.7:1182 msgid "" "This macro is intended for the E<.Sx SYNOPSIS> section. It may be used " "anywhere else in the man page without problems, but its main purpose is to " "present the function type in kernel normal form for the E<.Sx SYNOPSIS> of " "sections two and three (it causes a line break allowing the function name to " "appear on the next line)." msgstr "" #. type: Dl #: man-pages/man7/mdoc.samples.7:1183 #, no-wrap msgid "Usage: .Ft type ... \\*(Pu" msgstr "" #. type: It #: man-pages/man7/mdoc.samples.7:1185 #, no-wrap msgid "Li \\&.Ft struct stat" msgstr "" #. type: Plain text #: man-pages/man7/mdoc.samples.7:1187 msgid "E<.Ft struct stat>" msgstr "" #. type: Plain text #: man-pages/man7/mdoc.samples.7:1192 msgid "The E<.Ql \\&.Ft> request is not callable by other macros." msgstr "" #. type: Ss #: man-pages/man7/mdoc.samples.7:1192 #, no-wrap msgid "Interactive Commands" msgstr "" #. type: Plain text #: man-pages/man7/mdoc.samples.7:1196 msgid "The E<.Ql \\&.Ic> macro designates an interactive or internal command." msgstr "" #. type: Dl #: man-pages/man7/mdoc.samples.7:1197 #, no-wrap msgid "Usage: .Ic argument ... \\*(Pu" msgstr "" #. type: It #: man-pages/man7/mdoc.samples.7:1199 #, no-wrap msgid "Li \\&.Ic :wq" msgstr "" #. type: Plain text #: man-pages/man7/mdoc.samples.7:1201 msgid "E<.Ic :wq>" msgstr "" #. type: It #: man-pages/man7/mdoc.samples.7:1201 #, no-wrap msgid "Li \\&.Ic do while {...}" msgstr "" #. type: Plain text #: man-pages/man7/mdoc.samples.7:1203 msgid "E<.Ic do while {...}>" msgstr "" #. type: It #: man-pages/man7/mdoc.samples.7:1203 #, no-wrap msgid "Li \\&.Ic setenv\\ , unsetenv" msgstr "" #. type: Plain text #: man-pages/man7/mdoc.samples.7:1205 msgid "E<.Ic setenv , unsetenv>" msgstr "" #. type: Plain text #: man-pages/man7/mdoc.samples.7:1213 msgid "" "It is an error to call E<.Ql \\&.Ic> without arguments. The E<.Ql \\&.Ic> " "macro is parsed and is callable." msgstr "" #. type: Ss #: man-pages/man7/mdoc.samples.7:1213 #, no-wrap msgid "Name Macro" msgstr "" #. type: Plain text #: man-pages/man7/mdoc.samples.7:1249 msgid "" "The E<.Ql \\&.Nm> macro is used for the document title or subject name. It " "has the peculiarity of remembering the first argument it was called with, " "which should always be the subject name of the page. When called without " "arguments, E<.Ql \\&.Nm> regurgitates this initial name for the sole purpose " "of making less work for the author. Note: a section two or three document " "function name is addressed with the E<.Ql \\&.Nm> in the E<.Sx NAME> " "section, and with E<.Ql \\&.Fn> in the E<.Sx SYNOPSIS> and remaining " "sections. For interactive commands, such as the E<.Ql while> command " "keyword in E<.Xr csh 1>, the E<.Ql \\&.Ic> macro should be used. While the " "E<.Ql \\&.Ic> is nearly identical to E<.Ql \\&.Nm>, it can not recall the " "first argument it was invoked with." msgstr "" #. type: Dl #: man-pages/man7/mdoc.samples.7:1250 #, no-wrap msgid "Usage: .Nm argument ... \\*(Pu" msgstr "" #. type: It #: man-pages/man7/mdoc.samples.7:1252 #, no-wrap msgid "Li \\&.Nm mdoc.sample" msgstr "" #. type: Plain text #: man-pages/man7/mdoc.samples.7:1254 msgid "E<.Nm mdoc.sample>" msgstr "" #. type: It #: man-pages/man7/mdoc.samples.7:1254 #, no-wrap msgid "Li \\&.Nm \\e-mdoc" msgstr "" #. type: Plain text #: man-pages/man7/mdoc.samples.7:1256 msgid "E<.Nm \\-mdoc>." msgstr "" #. type: It #: man-pages/man7/mdoc.samples.7:1256 #, no-wrap msgid "Li \\&.Nm foo\\ )\\ )\\ ," msgstr "" #. type: Plain text #: man-pages/man7/mdoc.samples.7:1258 msgid "E<.Nm foo>))," msgstr "" #. type: It #: man-pages/man7/mdoc.samples.7:1258 #, no-wrap msgid "Li \\&.Nm" msgstr "" #. type: Plain text #: man-pages/man7/mdoc.samples.7:1260 msgid "E<.Nm>" msgstr "" #. type: Plain text #: man-pages/man7/mdoc.samples.7:1265 msgid "The E<.Ql \\&.Nm> macro is parsed and is callable." msgstr "" #. type: Ss #: man-pages/man7/mdoc.samples.7:1265 #, no-wrap msgid "Options" msgstr "" #. type: Plain text #: man-pages/man7/mdoc.samples.7:1277 msgid "" "The E<.Ql \\&.Op> macro places option brackets around the any remaining " "arguments on the command line, and places any trailing punctuation outside " "the brackets. The macros E<.Ql \\&.Oc> and E<.Ql \\&.Oo> may be used across " "one or more lines." msgstr "" #. type: Dl #: man-pages/man7/mdoc.samples.7:1278 #, no-wrap msgid "Usage: .Op options ... \\*(Pu" msgstr "" #. type: It #: man-pages/man7/mdoc.samples.7:1280 #, no-wrap msgid "Li \\&.Op" msgstr "" #. type: Plain text #: man-pages/man7/mdoc.samples.7:1282 msgid "E<.Op>" msgstr "" #. type: It #: man-pages/man7/mdoc.samples.7:1282 #, no-wrap msgid "Li \".Op Fl k\"" msgstr "" #. type: Plain text #: man-pages/man7/mdoc.samples.7:1284 msgid "E<.Op Fl k>" msgstr "" #. type: It #: man-pages/man7/mdoc.samples.7:1284 #, no-wrap msgid "Li \".Op Fl k ) .\"" msgstr "" #. type: Plain text #: man-pages/man7/mdoc.samples.7:1286 msgid "E<.Op Fl k>)." msgstr "" #. type: It #: man-pages/man7/mdoc.samples.7:1286 #, no-wrap msgid "Li \".Op Fl k Ar kookfile\"" msgstr "" #. type: Plain text #: man-pages/man7/mdoc.samples.7:1288 msgid "E<.Op Fl k Ar kookfile>" msgstr "" #. type: It #: man-pages/man7/mdoc.samples.7:1288 #, no-wrap msgid "Li \".Op Fl k Ar kookfile ,\"" msgstr "" #. type: Plain text #: man-pages/man7/mdoc.samples.7:1290 msgid "E<.Op Fl k Ar kookfile>," msgstr "" #. type: It #: man-pages/man7/mdoc.samples.7:1290 #, no-wrap msgid "Li \".Op Ar objfil Op Ar corfil\"" msgstr "" #. type: Plain text #: man-pages/man7/mdoc.samples.7:1292 msgid "E<.Op Ar objfil Op Ar corfil>" msgstr "" #. type: It #: man-pages/man7/mdoc.samples.7:1292 #, no-wrap msgid "Li \".Op Fl c Ar objfil Op Ar corfil ,\"" msgstr "" #. type: Plain text #: man-pages/man7/mdoc.samples.7:1294 msgid "E<.Op Fl c Ar objfil Op Ar corfil>," msgstr "" #. type: It #: man-pages/man7/mdoc.samples.7:1294 #, no-wrap msgid "Li \\&.Op word1 word2" msgstr "" #. type: Plain text #: man-pages/man7/mdoc.samples.7:1296 msgid "E<.Op word1 word2>" msgstr "" #. type: Plain text #: man-pages/man7/mdoc.samples.7:1303 msgid "The E<.Ql \\&.Oc> and E<.Ql \\&.Oo> macros:" msgstr "" #. type: Plain text #: man-pages/man7/mdoc.samples.7:1309 #, no-wrap msgid "" "\\&.Oo\n" "\\&.Op \\&Fl k \\&Ar kilobytes\n" "\\&.Op \\&Fl i \\&Ar interval\n" "\\&.Op \\&Fl c \\&Ar count\n" "\\&.Oc\n" msgstr "" #. type: Plain text #: man-pages/man7/mdoc.samples.7:1317 msgid "" "Produce: E<.Oo> E<.Op Fl k Ar kilobytes> E<.Op Fl i Ar interval> E<.Op Fl c " "Ar count> E<.Oc>" msgstr "" #. type: Plain text #: man-pages/man7/mdoc.samples.7:1324 msgid "" "The macros E<.Ql \\&.Op>, E<.Ql \\&.Oc> and E<.Ql \\&.Oo> are parsed and are " "callable." msgstr "" #. type: Ss #: man-pages/man7/mdoc.samples.7:1324 #, no-wrap msgid "Pathnames" msgstr "" #. type: Plain text #: man-pages/man7/mdoc.samples.7:1328 msgid "The E<.Ql \\&.Pa> macro formats pathnames or filenames." msgstr "" #. type: Dl #: man-pages/man7/mdoc.samples.7:1329 #, no-wrap msgid "Usage: .Pa pathname \\*(Pu" msgstr "" #. type: It #: man-pages/man7/mdoc.samples.7:1331 #, no-wrap msgid "Li \\&.Pa /usr/share" msgstr "" #. type: Plain text #: man-pages/man7/mdoc.samples.7:1333 msgid "E<.Pa /usr/share>" msgstr "" #. type: It #: man-pages/man7/mdoc.samples.7:1333 #, no-wrap msgid "Li \\&.Pa /tmp/fooXXXXX\\ )\\ ." msgstr "" #. type: Plain text #: man-pages/man7/mdoc.samples.7:1335 msgid "E<.Pa /tmp/fooXXXXX>)." msgstr "" #. type: Plain text #: man-pages/man7/mdoc.samples.7:1340 msgid "The E<.Ql \\&.Pa> macro is parsed and is callable." msgstr "" #. type: Ss #: man-pages/man7/mdoc.samples.7:1340 #, no-wrap msgid "Variables" msgstr "" #. type: Plain text #: man-pages/man7/mdoc.samples.7:1342 msgid "Generic variable reference:" msgstr "" #. type: Dl #: man-pages/man7/mdoc.samples.7:1343 #, no-wrap msgid "Usage: .Va variable ... \\*(Pu" msgstr "" #. type: It #: man-pages/man7/mdoc.samples.7:1345 #, no-wrap msgid "Li \\&.Va count" msgstr "" #. type: Plain text #: man-pages/man7/mdoc.samples.7:1347 msgid "E<.Va count>" msgstr "" #. type: It #: man-pages/man7/mdoc.samples.7:1347 #, no-wrap msgid "Li \\&.Va settimer ," msgstr "" #. type: Plain text #: man-pages/man7/mdoc.samples.7:1349 msgid "E<.Va settimer>," msgstr "" #. type: It #: man-pages/man7/mdoc.samples.7:1349 #, no-wrap msgid "Li \\&.Va int\\ *prt\\ )\\ :" msgstr "" #. type: Plain text #: man-pages/man7/mdoc.samples.7:1351 msgid "E<.Va int\\ *prt>):" msgstr "" #. type: It #: man-pages/man7/mdoc.samples.7:1351 #, no-wrap msgid "Li \\&.Va char\\ s\\ ]\\ )\\ )\\ ," msgstr "" #. type: Plain text #: man-pages/man7/mdoc.samples.7:1353 msgid "E<.Va char\\ s>]))," msgstr "" #. type: Plain text #: man-pages/man7/mdoc.samples.7:1361 msgid "" "It is an error to call E<.Ql \\&.Va> without any arguments. The E<.Ql \\&." "Va> macro is parsed and is callable." msgstr "" #. type: Ss #: man-pages/man7/mdoc.samples.7:1361 #, no-wrap msgid "Manual Page Cross References" msgstr "" #. type: Plain text #: man-pages/man7/mdoc.samples.7:1369 msgid "" "The E<.Ql \\&.Xr> macro expects the first argument to be a manual page name, " "and the second argument, if it exists, to be either a section page number or " "punctuation. Any remaining arguments are assumed to be punctuation." msgstr "" #. type: Dl #: man-pages/man7/mdoc.samples.7:1370 #, no-wrap msgid "Usage: .Xr man_page [1,...,8] \\*(Pu" msgstr "" #. type: It #: man-pages/man7/mdoc.samples.7:1372 #, no-wrap msgid "Li \\&.Xr mdoc" msgstr "" #. type: Plain text #: man-pages/man7/mdoc.samples.7:1374 msgid "E<.Xr mdoc>" msgstr "" #. type: It #: man-pages/man7/mdoc.samples.7:1374 #, no-wrap msgid "Li \\&.Xr mdoc\\ ," msgstr "" #. type: Plain text #: man-pages/man7/mdoc.samples.7:1376 msgid "E<.Xr mdoc>," msgstr "" #. type: It #: man-pages/man7/mdoc.samples.7:1376 #, no-wrap msgid "Li \\&.Xr mdoc 7" msgstr "" #. type: Plain text #: man-pages/man7/mdoc.samples.7:1378 msgid "E<.Xr mdoc 7>" msgstr "" #. type: It #: man-pages/man7/mdoc.samples.7:1378 #, no-wrap msgid "Li \\&.Xr mdoc 7\\ )\\ )\\ ," msgstr "" #. type: Plain text #: man-pages/man7/mdoc.samples.7:1380 msgid "E<.Xr mdoc 7>))," msgstr "" #. type: Plain text #: man-pages/man7/mdoc.samples.7:1389 msgid "" "The E<.Ql \\&.Xr> macro is parsed and is callable. It is an error to call " "E<.Ql \\&.Xr> without any arguments." msgstr "" #. type: Sh #: man-pages/man7/mdoc.samples.7:1389 #, no-wrap msgid "GENERAL TEXT DOMAIN" msgstr "" #. type: Ss #: man-pages/man7/mdoc.samples.7:1390 #, no-wrap msgid "AT&T Macro" msgstr "" #. type: Plain text #: man-pages/man7/mdoc.samples.7:1393 #, no-wrap msgid "Usage: .At [v6 | v7 | 32v | V.1 | V.4] ... \\*(Pu\n" msgstr "" #. type: It #: man-pages/man7/mdoc.samples.7:1395 #, no-wrap msgid "Li .At" msgstr "" #. type: Plain text #: man-pages/man7/mdoc.samples.7:1397 msgid "E<.At>" msgstr "" #. type: It #: man-pages/man7/mdoc.samples.7:1397 #, no-wrap msgid "Li \".At v6 .\"" msgstr "" #. type: Plain text #: man-pages/man7/mdoc.samples.7:1399 msgid "E<.At v6>." msgstr "" #. type: Plain text #: man-pages/man7/mdoc.samples.7:1409 msgid "" "The E<.Ql \\&.At> macro is E<.Em not> parsed and E<.Em not> callable It " "accepts at most two arguments." msgstr "" #. type: Ss #: man-pages/man7/mdoc.samples.7:1409 #, no-wrap msgid "BSD Macro" msgstr "" #. type: Dl #: man-pages/man7/mdoc.samples.7:1410 #, no-wrap msgid "Usage: .Bx [Version/release] ... \\*(Pu" msgstr "" #. type: It #: man-pages/man7/mdoc.samples.7:1412 #, no-wrap msgid "Li .Bx" msgstr "" #. type: Plain text #: man-pages/man7/mdoc.samples.7:1414 msgid "E<.Bx>" msgstr "" #. type: It #: man-pages/man7/mdoc.samples.7:1414 #, no-wrap msgid "Li \".Bx 4.3 .\"" msgstr "" #. type: Plain text #: man-pages/man7/mdoc.samples.7:1416 msgid "E<.Bx 4.3>." msgstr "" #. type: Plain text #: man-pages/man7/mdoc.samples.7:1421 msgid "The E<.Ql \\&.Bx> macro is parsed and is callable." msgstr "" #. type: Ss #: man-pages/man7/mdoc.samples.7:1421 #, no-wrap msgid "FreeBSD Macro" msgstr "" #. type: Plain text #: man-pages/man7/mdoc.samples.7:1424 #, no-wrap msgid "Usage: .Fx Version.release ... \\*(Pu\n" msgstr "" #. type: It #: man-pages/man7/mdoc.samples.7:1426 #, no-wrap msgid "Li \".Fx 2.2 .\"" msgstr "" #. type: Plain text #: man-pages/man7/mdoc.samples.7:1428 msgid "E<.Fx 2.2>." msgstr "" #. type: Plain text #: man-pages/man7/mdoc.samples.7:1438 msgid "" "The E<.Ql \\&.Fx> macro is E<.Em not> parsed and E<.Em not> callable It " "accepts at most two arguments." msgstr "" #. type: Ss #: man-pages/man7/mdoc.samples.7:1438 #, no-wrap msgid "UNIX Macro" msgstr "" #. type: Dl #: man-pages/man7/mdoc.samples.7:1439 #, no-wrap msgid "Usage: .Ux ... \\*(Pu" msgstr "" #. type: It #: man-pages/man7/mdoc.samples.7:1441 #, no-wrap msgid "Li .Ux" msgstr "" #. type: Plain text #: man-pages/man7/mdoc.samples.7:1443 msgid "E<.Ux>" msgstr "" #. type: Plain text #: man-pages/man7/mdoc.samples.7:1448 msgid "The E<.Ql \\&.Ux> macro is parsed and is callable." msgstr "" #. type: Ss #: man-pages/man7/mdoc.samples.7:1448 #, no-wrap msgid "Enclosure and Quoting Macros" msgstr "" #. type: Plain text #: man-pages/man7/mdoc.samples.7:1470 msgid "" "The concept of enclosure is similar to quoting. The object being to enclose " "one or more strings between a pair of characters like quotes or parentheses. " " The terms quoting and enclosure are used interchangeably throughout this " "document. Most of the one line enclosure macros end in small letter E<.Ql " "q> to give a hint of quoting, but there are a few irregularities. For each " "enclosure macro there is also a pair of open and close macros which end in " "small letters E<.Ql o> and E<.Ql c> respectively. These can be used across " "one or more lines of text and while they have nesting limitations, the one " "line quote macros can be used inside of them." msgstr "" #. type: Plain text #: man-pages/man7/mdoc.samples.7:1483 #, no-wrap msgid "" "E<.Em \" Quote Close Open Function Result\">\n" "\\&.Aq .Ac .Ao Angle Bracket Enclosure EstringE\n" "\\&.Bq .Bc .Bo Bracket Enclosure [string]\n" "\\&.Dq .Dc .Do Double Quote ``string''\n" " .Ec .Eo Enclose String (in XX) XXstringXX\n" "\\&.Pq .Pc .Po Parenthesis Enclosure (string)\n" "\\&.Ql Quoted Literal `st' or string\n" "\\&.Qq .Qc .Qo Straight Double Quote \"string\"\n" "\\&.Sq .Sc .So Single Quote `string'\n" msgstr "" #. type: Plain text #: man-pages/man7/mdoc.samples.7:1494 msgid "" "Except for the irregular macros noted below, all of the quoting macros are " "parsed and callable. All handle punctuation properly, as long as it is " "presented one character at a time and separated by spaces. The quoting " "macros examine opening and closing punctuation to determine whether it comes " "before or after the enclosing string This makes some nesting possible." msgstr "" #. type: It #: man-pages/man7/mdoc.samples.7:1495 #, no-wrap msgid "Li \\&.Ec , \\&.Eo" msgstr "" #. type: Plain text #: man-pages/man7/mdoc.samples.7:1498 msgid "" "These macros expect the first argument to be the opening and closing strings " "respectively." msgstr "" #. type: It #: man-pages/man7/mdoc.samples.7:1498 #, no-wrap msgid "Li \\&.Ql" msgstr "" #. type: Plain text #: man-pages/man7/mdoc.samples.7:1511 msgid "" "The quoted literal macro behaves differently for E<.Xr troff> than E<.Xr " "nroff>. If formatted with E<.Xr nroff>, a quoted literal is always quoted. " "If formatted with troff, an item is quoted only if the width of the item is " "less than three constant width characters. This is to make short strings " "more visible where the font change to literal (constant width) is less " "noticeable." msgstr "" #. type: It #: man-pages/man7/mdoc.samples.7:1511 #, no-wrap msgid "Li \\&.Pf" msgstr "" #. type: Plain text #: man-pages/man7/mdoc.samples.7:1513 msgid "The prefix macro is not callable, but it is parsed:" msgstr "" #. type: It #: man-pages/man7/mdoc.samples.7:1514 #, no-wrap msgid "Li \".Pf ( Fa name2\"" msgstr "" #. type: Plain text #: man-pages/man7/mdoc.samples.7:1517 msgid "becomes E<.Pf ( Fa name2>." msgstr "" #. type: Plain text #: man-pages/man7/mdoc.samples.7:1522 msgid "" "The E<.Ql \\&.Ns> (no space) macro performs the analogous suffix function." msgstr "" #. type: Plain text #: man-pages/man7/mdoc.samples.7:1526 msgid "Examples of quoting:" msgstr "" #. type: It #: man-pages/man7/mdoc.samples.7:1527 #, no-wrap msgid "Li \\&.Aq" msgstr "" #. type: Plain text #: man-pages/man7/mdoc.samples.7:1529 msgid "E<.Aq>" msgstr "" #. type: It #: man-pages/man7/mdoc.samples.7:1529 #, no-wrap msgid "Li \\&.Aq \\&Ar ctype.h\\ )\\ ," msgstr "" #. type: Plain text #: man-pages/man7/mdoc.samples.7:1531 msgid "E<.Aq Ar ctype.h>)," msgstr "" #. type: It #: man-pages/man7/mdoc.samples.7:1531 #, no-wrap msgid "Li \\&.Bq" msgstr "" #. type: Plain text #: man-pages/man7/mdoc.samples.7:1533 msgid "E<.Bq>" msgstr "" #. type: It #: man-pages/man7/mdoc.samples.7:1533 #, no-wrap msgid "Li \\&.Bq \\&Em Greek \\&, French \\&." msgstr "" #. type: Plain text #: man-pages/man7/mdoc.samples.7:1535 msgid "E<.Bq Em Greek , French>." msgstr "" #. type: It #: man-pages/man7/mdoc.samples.7:1535 #, no-wrap msgid "Li \\&.Dq" msgstr "" #. type: Plain text #: man-pages/man7/mdoc.samples.7:1537 msgid "E<.Dq>" msgstr "" #. type: It #: man-pages/man7/mdoc.samples.7:1537 #, no-wrap msgid "Li \".Dq string abc .\"" msgstr "" #. type: Plain text #: man-pages/man7/mdoc.samples.7:1539 msgid "E<.Dq string abc>." msgstr "" #. type: It #: man-pages/man7/mdoc.samples.7:1539 #, no-wrap msgid "Li \".Dq \\'^[A-Z]\\'\"" msgstr "" #. type: Plain text #: man-pages/man7/mdoc.samples.7:1541 msgid "E<.Dq \\'^[A-Z]\\'>" msgstr "" #. type: It #: man-pages/man7/mdoc.samples.7:1541 #, no-wrap msgid "Li \"\\&.Ql man mdoc\"" msgstr "" #. type: Plain text #: man-pages/man7/mdoc.samples.7:1543 msgid "E<.Ql man mdoc>" msgstr "" #. type: It #: man-pages/man7/mdoc.samples.7:1543 #, no-wrap msgid "Li \\&.Qq" msgstr "" #. type: Plain text #: man-pages/man7/mdoc.samples.7:1545 msgid "E<.Qq>" msgstr "" #. type: It #: man-pages/man7/mdoc.samples.7:1545 #, no-wrap msgid "Li \"\\&.Qq string ) ,\"" msgstr "" #. type: Plain text #: man-pages/man7/mdoc.samples.7:1547 msgid "E<.Qq string>)," msgstr "" #. type: It #: man-pages/man7/mdoc.samples.7:1547 #, no-wrap msgid "Li \"\\&.Qq string Ns ),\"" msgstr "" #. type: Plain text #: man-pages/man7/mdoc.samples.7:1549 msgid "E<.Qq string Ns ),>" msgstr "" #. type: It #: man-pages/man7/mdoc.samples.7:1549 #, no-wrap msgid "Li \\&.Sq" msgstr "" #. type: Plain text #: man-pages/man7/mdoc.samples.7:1551 msgid "E<.Sq>" msgstr "" #. type: It #: man-pages/man7/mdoc.samples.7:1551 #, no-wrap msgid "Li \"\\&.Sq string\"" msgstr "" #. type: Plain text #: man-pages/man7/mdoc.samples.7:1553 msgid "E<.Sq string>" msgstr "" #. type: Plain text #: man-pages/man7/mdoc.samples.7:1570 msgid "" "For a good example of nested enclosure macros, see the E<.Ql \\&.Op> option " "macro. It was created from the same underlying enclosure macros as those " "presented in the list above. The E<.Ql \\&.Xo> and E<.Ql \\&.Xc> extended " "argument list macros were also built from the same underlying routines and " "are a good example of E<.Nm \\-mdoc> macro usage at its worst." msgstr "" #. type: Ss #: man-pages/man7/mdoc.samples.7:1570 #, no-wrap msgid "No\\-Op or Normal Text Macro" msgstr "" #. type: Plain text #: man-pages/man7/mdoc.samples.7:1578 msgid "" "The macro E<.Ql \\&.No> is a hack for words in a macro command line which " "should E<.Em not> be formatted and follows the conventional syntax for " "content macros." msgstr "" #. type: Ss #: man-pages/man7/mdoc.samples.7:1578 #, no-wrap msgid "No Space Macro" msgstr "" #. type: Plain text #: man-pages/man7/mdoc.samples.7:1584 msgid "" "The E<.Ql \\&.Ns> macro eliminates unwanted spaces in between macro requests." " It is useful for old style argument lists where there is no space between " "the flag and argument:" msgstr "" #. type: It #: man-pages/man7/mdoc.samples.7:1585 #, no-wrap msgid "Li \".Op Fl I Ns Ar directory\"" msgstr "" #. type: Plain text #: man-pages/man7/mdoc.samples.7:1588 msgid "produces E<.Op Fl I Ns Ar directory>" msgstr "" #. type: Plain text #: man-pages/man7/mdoc.samples.7:1599 msgid "" "Note: the E<.Ql \\&.Ns> macro always invokes the E<.Ql \\&.No> macro after " "eliminating the space unless another macro name follows it. The macro E<.Ql " "\\&.Ns> is parsed and is callable." msgstr "" #. type: Ss #: man-pages/man7/mdoc.samples.7:1599 #, no-wrap msgid "Section Cross References" msgstr "" #. type: Plain text #: man-pages/man7/mdoc.samples.7:1605 msgid "" "The E<.Ql \\&.Sx> macro designates a reference to a section header within " "the same document. It is parsed and is callable." msgstr "" #. type: It #: man-pages/man7/mdoc.samples.7:1607 #, no-wrap msgid "Li \\&.Sx FILES" msgstr "" #. type: Plain text #: man-pages/man7/mdoc.samples.7:1609 msgid "E<.Sx FILES>" msgstr "" #. type: Ss #: man-pages/man7/mdoc.samples.7:1610 #, no-wrap msgid "References and Citations" msgstr "" #. type: Plain text #: man-pages/man7/mdoc.samples.7:1614 msgid "" "The following macros make a modest attempt to handle references. At best, " "the macros make it convenient to manually drop in a subset of refer style " "references." msgstr "" #. type: It #: man-pages/man7/mdoc.samples.7:1616 #, no-wrap msgid "Li .Rs" msgstr "" #. type: Plain text #: man-pages/man7/mdoc.samples.7:1621 msgid "" "Reference Start. Causes a line break and begins collection of reference " "information until the reference end macro is read." msgstr "" #. type: It #: man-pages/man7/mdoc.samples.7:1621 #, no-wrap msgid "Li .Re" msgstr "" #. type: Plain text #: man-pages/man7/mdoc.samples.7:1624 msgid "Reference End. The reference is printed." msgstr "" #. type: It #: man-pages/man7/mdoc.samples.7:1624 #, no-wrap msgid "Li .%A" msgstr "" #. type: Plain text #: man-pages/man7/mdoc.samples.7:1626 msgid "Reference author name, one name per invocation." msgstr "" #. type: It #: man-pages/man7/mdoc.samples.7:1626 #, no-wrap msgid "Li .%B" msgstr "" #. type: Plain text #: man-pages/man7/mdoc.samples.7:1628 msgid "Book title." msgstr "" #. type: It #: man-pages/man7/mdoc.samples.7:1628 #, no-wrap msgid "Li .\\&%C" msgstr "" #. type: Plain text #: man-pages/man7/mdoc.samples.7:1630 msgid "City/place." msgstr "" #. type: It #: man-pages/man7/mdoc.samples.7:1630 #, no-wrap msgid "Li .\\&%D" msgstr "" #. type: Plain text #: man-pages/man7/mdoc.samples.7:1632 msgid "Date." msgstr "" #. type: It #: man-pages/man7/mdoc.samples.7:1632 #, no-wrap msgid "Li .%J" msgstr "" #. type: Plain text #: man-pages/man7/mdoc.samples.7:1634 msgid "Journal name." msgstr "" #. type: It #: man-pages/man7/mdoc.samples.7:1634 #, no-wrap msgid "Li .%N" msgstr "" #. type: Plain text #: man-pages/man7/mdoc.samples.7:1636 msgid "Issue number." msgstr "" #. type: It #: man-pages/man7/mdoc.samples.7:1636 #, no-wrap msgid "Li .%O" msgstr "" #. type: Plain text #: man-pages/man7/mdoc.samples.7:1638 msgid "Optional information." msgstr "" #. type: It #: man-pages/man7/mdoc.samples.7:1638 #, no-wrap msgid "Li .%P" msgstr "" #. type: Plain text #: man-pages/man7/mdoc.samples.7:1640 msgid "Page number." msgstr "" #. type: It #: man-pages/man7/mdoc.samples.7:1640 #, no-wrap msgid "Li .%R" msgstr "" #. type: Plain text #: man-pages/man7/mdoc.samples.7:1642 msgid "Report name." msgstr "" #. type: It #: man-pages/man7/mdoc.samples.7:1642 #, no-wrap msgid "Li .%T" msgstr "" #. type: Plain text #: man-pages/man7/mdoc.samples.7:1644 msgid "Title of article." msgstr "" #. type: It #: man-pages/man7/mdoc.samples.7:1644 #, no-wrap msgid "Li .%V" msgstr "" #. type: Plain text #: man-pages/man7/mdoc.samples.7:1646 msgid "Volume(s)." msgstr "" #. type: Plain text #: man-pages/man7/mdoc.samples.7:1657 msgid "" "The macros beginning with E<.Ql %> are not callable, and are parsed only for " "the trade name macro which returns to its caller. (And not very predictably " "at the moment either.) The purpose is to allow trade names to be pretty " "printed in E<.Xr troff Ns / Ns Xr ditroff> output." msgstr "" #. type: Ss #: man-pages/man7/mdoc.samples.7:1657 #, no-wrap msgid "Return Values" msgstr "" #. type: Plain text #: man-pages/man7/mdoc.samples.7:1663 msgid "" "The E<.Ql \\&.Rv> macro generates text for use in the E<.Sx RETURN VALUE> " "section." msgstr "" #. type: Dl #: man-pages/man7/mdoc.samples.7:1664 #, no-wrap msgid "Usage: .Rv [-std function]" msgstr "" #. type: Plain text #: man-pages/man7/mdoc.samples.7:1668 msgid "E<.Ql \\&.Rv -std atexit> will generate the following text:" msgstr "" #. fake section 3 to avoid error message from Rv #. .ds cH 3 #. type: ds section #: man-pages/man7/mdoc.samples.7:1671 #, no-wrap msgid "3" msgstr "" #. and back to 7 again #. .ds cH 7 #. type: Plain text #: man-pages/man7/mdoc.samples.7:1675 msgid "E<.Rv -std atexit>" msgstr "" #. type: ds section #: man-pages/man7/mdoc.samples.7:1675 #, no-wrap msgid "7" msgstr "" #. type: Plain text #: man-pages/man7/mdoc.samples.7:1680 msgid "The E<.Fl std> option is valid only for manual page sections 2 and 3." msgstr "" #. type: Ss #: man-pages/man7/mdoc.samples.7:1680 #, no-wrap msgid "Trade Names (or Acronyms and Type Names)" msgstr "" #. type: Plain text #: man-pages/man7/mdoc.samples.7:1683 msgid "" "The trade name macro is generally a small caps macro for all uppercase words " "longer than two characters." msgstr "" #. type: Dl #: man-pages/man7/mdoc.samples.7:1684 #, no-wrap msgid "Usage: .Tn symbol ... \\*(Pu" msgstr "" #. type: It #: man-pages/man7/mdoc.samples.7:1686 #, no-wrap msgid "Li \\&.Tn DEC" msgstr "" #. type: Plain text #: man-pages/man7/mdoc.samples.7:1688 msgid "E<.Tn DEC>" msgstr "" #. type: It #: man-pages/man7/mdoc.samples.7:1688 #, no-wrap msgid "Li \\&.Tn ASCII" msgstr "" #. type: Plain text #: man-pages/man7/mdoc.samples.7:1690 msgid "E<.Tn ASCII>" msgstr "" #. type: Plain text #: man-pages/man7/mdoc.samples.7:1696 msgid "The E<.Ql \\&.Tn> macro is parsed and is callable by other macros." msgstr "" #. type: Ss #: man-pages/man7/mdoc.samples.7:1696 #, no-wrap msgid "Extended Arguments" msgstr "" #. type: Plain text #: man-pages/man7/mdoc.samples.7:1708 msgid "" "The E<.Ql \\&.Xo> and E<.Ql \\&.Xc> macros allow one to extend an argument " "list on a macro boundary. Argument lists cannot be extended within a macro " "which expects all of its arguments on one line such as E<.Ql \\&.Op>." msgstr "" #. type: Plain text #: man-pages/man7/mdoc.samples.7:1712 msgid "" "Here is an example of E<.Ql \\&.Xo> using the space mode macro to turn " "spacing off:" msgstr "" #. type: Plain text #: man-pages/man7/mdoc.samples.7:1718 #, no-wrap msgid "" "\\&.Sm off\n" "\\&.It Xo Sy I Ar operation\n" "\\&.No \\een Ar count No \\een\n" "\\&.Xc\n" "\\&.Sm on\n" msgstr "" #. type: Plain text #: man-pages/man7/mdoc.samples.7:1721 man-pages/man7/mdoc.samples.7:1742 man-pages/man7/mdoc.samples.7:1766 msgid "Produces" msgstr "" #. type: Plain text #: man-pages/man7/mdoc.samples.7:1724 man-pages/man7/mdoc.samples.7:1745 #, no-wrap msgid "E<.Sm off>\n" msgstr "" #. type: It #: man-pages/man7/mdoc.samples.7:1724 #, no-wrap msgid "Xo Sy I Ar operation" msgstr "" #. type: Plain text #: man-pages/man7/mdoc.samples.7:1728 #, no-wrap msgid "E<.No \\en Ar count No \\en>\n" "E<.Xc>\n" "E<.Sm on>\n" msgstr "" #. type: Plain text #: man-pages/man7/mdoc.samples.7:1732 msgid "Another one:" msgstr "" #. type: Plain text #: man-pages/man7/mdoc.samples.7:1739 #, no-wrap msgid "" "\\&.Sm off\n" "\\&.It Cm S No \\&/ Ar old_pattern Xo\n" "\\&.No \\&/ Ar new_pattern\n" "\\&.No \\&/ Op Cm g\n" "\\&.Xc\n" "\\&.Sm on\n" msgstr "" #. type: It #: man-pages/man7/mdoc.samples.7:1745 #, no-wrap msgid "Cm S No \\&/ Ar old_pattern Xo" msgstr "" #. type: Plain text #: man-pages/man7/mdoc.samples.7:1750 #, no-wrap msgid "E<.No \\&/ Ar new_pattern>\n" "E<.No \\&/ Op Cm g>\n" "E<.Xc>\n" "E<.Sm on>\n" msgstr "" #. type: Plain text #: man-pages/man7/mdoc.samples.7:1757 msgid "" "Another example of E<.Ql \\&.Xo> and using enclosure macros: Test the value " "of a variable." msgstr "" #. type: Plain text #: man-pages/man7/mdoc.samples.7:1763 #, no-wrap msgid "" "\\&.It Xo\n" "\\&.Ic .ifndef\n" "\\&.Oo \\e&! Oc Ns Ar variable\n" "\\&.Op Ar operator variable ...\n" "\\&.Xc\n" msgstr "" #. type: It #: man-pages/man7/mdoc.samples.7:1768 #, no-wrap msgid "Xo" msgstr "" #. type: Plain text #: man-pages/man7/mdoc.samples.7:1773 #, no-wrap msgid "" "E<.Ic .ifndef>\n" "E<.Oo \\&! Oc Ns Ar variable>\n" "E<.Op Ar operator variable ...>\n" "E<.Xc>\n" msgstr "" #. type: Plain text #: man-pages/man7/mdoc.samples.7:1811 msgid "" "All of the above examples have used the E<.Ql \\&.Xo> macro on the argument " "list of the E<.Ql \\&.It> (list-item) macro. The extend macros are not " "used very often, and when they are it is usually to extend the list-item " "argument list. Unfortunately, this is also where the extend macros are the " "most finicky. In the first two examples, spacing was turned off; in the " "third, spacing was desired in part of the output but not all of it. To make " "these macros work in this situation make sure the E<.Ql \\&.Xo> and E<.Ql " "\\&.Xc> macros are placed as shown in the third example. If the E<.Ql \\&." "Xo> macro is not alone on the E<.Ql \\&.It> argument list, spacing will be " "unpredictable. The E<.Ql \\&.Ns> (no space macro) must not occur as the " "first or last macro on a line in this situation. Out of 900 manual pages " "(about 1500 actual pages) currently released with E<.Bx> only fifteen use " "the E<.Ql \\&.Xo> macro." msgstr "" #. type: Sh #: man-pages/man7/mdoc.samples.7:1811 #, no-wrap msgid "PAGE STRUCTURE DOMAIN" msgstr "" #. type: Ss #: man-pages/man7/mdoc.samples.7:1812 #, no-wrap msgid "Section Headers" msgstr "" #. type: Plain text #: man-pages/man7/mdoc.samples.7:1825 msgid "" "The first three E<.Ql \\&.Sh> section header macros list below are required " "in every man page. The remaining section headers are recommended at the " "discretion of the author writing the manual page. The E<.Ql \\&.Sh> macro " "can take up to nine arguments. It is parsed and but is not callable." msgstr "" #. type: It #: man-pages/man7/mdoc.samples.7:1826 #, no-wrap msgid "\\&.Sh NAME" msgstr "" #. type: Plain text #: man-pages/man7/mdoc.samples.7:1846 msgid "" "The E<.Ql \\&.Sh NAME> macro is mandatory. If not specified, the headers, " "footers and page layout defaults will not be set and things will be rather " "unpleasant. The E<.Sx NAME> section consists of at least three items. The " "first is the E<.Ql \\&.Nm> name macro naming the subject of the man page. " "The second is the Name Description macro, E<.Ql \\&.Nd>, which separates the " "subject name from the third item, which is the description. The description " "should be the most terse and lucid possible, as the space available is small." "" msgstr "" #. type: It #: man-pages/man7/mdoc.samples.7:1846 #, no-wrap msgid "\\&.Sh SYNOPSIS" msgstr "" #. type: Plain text #: man-pages/man7/mdoc.samples.7:1878 msgid "" "The E<.Sx SYNOPSIS> section describes the typical usage of the subject of a " "man page. The macros required are either E<.Ql \".Nm\">, E<.Ql \".Cd\">, E<." "Ql \".Fn\">, (and possibly E<.Ql \".Fo\">, E<.Ql \".Fc\">, E<.Ql \".Fd\">, " "E<.Ql \".Ft\"> macros). The function name macro E<.Ql \".Fn\"> is required " "for manual page sections 2 and 3, the command and general name macro E<.Ql " "\\&.Nm> is required for sections 1, 5, 6, 7, 8. Section 4 manuals require a " "E<.Ql \".Nm\">, E<.Ql \".Fd\"> or a E<.Ql \".Cd\"> configuration device " "usage macro. Several other macros may be necessary to produce the synopsis " "line as shown below:" msgstr "" #. type: Plain text #: man-pages/man7/mdoc.samples.7:1885 #, no-wrap msgid "E<.Nm cat>\n" "E<.Op Fl benstuv>\n" "E<.Op Fl>\n" "E<.Ar>\n" msgstr "" #. type: Plain text #: man-pages/man7/mdoc.samples.7:1888 msgid "The following macros were used:" msgstr "" #. type: Dl #: man-pages/man7/mdoc.samples.7:1889 #, no-wrap msgid "\\&.Nm cat" msgstr "" #. type: Dl #: man-pages/man7/mdoc.samples.7:1890 #, no-wrap msgid "\\&.Op \\&Fl benstuv" msgstr "" #. type: Dl #: man-pages/man7/mdoc.samples.7:1891 #, no-wrap msgid "\\&.Op \\&Fl" msgstr "" #. type: Dl #: man-pages/man7/mdoc.samples.7:1892 #, no-wrap msgid "\\&.Ar" msgstr "" #. type: Plain text #: man-pages/man7/mdoc.samples.7:1903 msgid "" "E<.Sy Note>: The macros E<.Ql \\&.Op>, E<.Ql \\&.Fl>, and E<.Ql \\&.Ar> " "recognize the pipe bar character E<.Ql \\*(Ba>, so a command line such as:" msgstr "" #. type: Dl #: man-pages/man7/mdoc.samples.7:1904 #, no-wrap msgid ".Op Fl a | Fl b" msgstr "" #. type: Plain text #: man-pages/man7/mdoc.samples.7:1913 msgid "" "will not go orbital. E<.Xr Troff> normally interprets a \\*(Ba as a special " "operator. See E<.Sx PREDEFINED STRINGS> for a usable \\*(Ba character in " "other situations." msgstr "" #. type: It #: man-pages/man7/mdoc.samples.7:1914 #, no-wrap msgid "\\&.Sh DESCRIPTION" msgstr "" #. type: Plain text #: man-pages/man7/mdoc.samples.7:1931 msgid "" "In most cases the first text in the E<.Sx DESCRIPTION> section is a brief " "paragraph on the command, function or file, followed by a lexical list of " "options and respective explanations. To create such a list, the E<.Ql \\&." "Bl> begin-list, E<.Ql \\&.It> list-item and E<.Ql \\&.El> end-list macros " "are used (see E<.Sx Lists and Columns> below)." msgstr "" #. type: Plain text #: man-pages/man7/mdoc.samples.7:1940 msgid "" "The following E<.Ql \\&.Sh> section headers are part of the preferred manual " "page layout and must be used appropriately to maintain consistency. They " "are listed in the order in which they would be used." msgstr "" #. type: It #: man-pages/man7/mdoc.samples.7:1941 #, no-wrap msgid "\\&.Sh ENVIRONMENT" msgstr "" #. type: Plain text #: man-pages/man7/mdoc.samples.7:1947 msgid "" "The E<.Sx ENVIRONMENT> section should reveal any related environment " "variables and clues to their behavior and/or usage." msgstr "" #. type: It #: man-pages/man7/mdoc.samples.7:1947 #, no-wrap msgid "\\&.Sh EXAMPLES" msgstr "" #. type: Plain text #: man-pages/man7/mdoc.samples.7:1954 msgid "" "There are several ways to create examples. See the E<.Sx EXAMPLES> section " "below for details." msgstr "" #. type: It #: man-pages/man7/mdoc.samples.7:1954 #, no-wrap msgid "\\&.Sh FILES" msgstr "" #. type: Plain text #: man-pages/man7/mdoc.samples.7:1961 msgid "" "Files which are used or created by the man page subject should be listed via " "the E<.Ql \\&.Pa> macro in the E<.Sx FILES> section." msgstr "" #. type: It #: man-pages/man7/mdoc.samples.7:1961 #, no-wrap msgid "\\&.Sh SEE ALSO" msgstr "" #. type: Plain text #: man-pages/man7/mdoc.samples.7:1975 msgid "" "References to other material on the man page topic and cross references to " "other relevant man pages should be placed in the E<.Sx SEE ALSO> section. " "Cross references are specified using the E<.Ql \\&.Xr> macro. Cross " "references in the E<.Sx SEE ALSO> section should be sorted by section " "number, and then placed in alphabetical order and comma separated. For " "example:" msgstr "" #. type: Plain text #: man-pages/man7/mdoc.samples.7:1980 msgid "E<.Xr ls 1>, E<.Xr ps 1>, E<.Xr group 5>, E<.Xr passwd 5>." msgstr "" #. type: Plain text #: man-pages/man7/mdoc.samples.7:1984 msgid "At this time E<.Xr refer 1> style references are not accommodated." msgstr "" #. type: It #: man-pages/man7/mdoc.samples.7:1984 #, no-wrap msgid "\\&.Sh CONFORMING TO" msgstr "" #. type: Plain text #: man-pages/man7/mdoc.samples.7:1996 msgid "" "If the command, library function or file adheres to a specific " "implementation such as E<.St -p1003.2> or E<.St -ansiC> this should be noted " "here. If the command does not adhere to any standard, its history should be " "noted in the E<.Sx HISTORY> section." msgstr "" #. type: It #: man-pages/man7/mdoc.samples.7:1996 #, no-wrap msgid "\\&.Sh HISTORY" msgstr "" #. type: Plain text #: man-pages/man7/mdoc.samples.7:1999 msgid "" "Any command which does not adhere to any specific standards should be " "outlined historically in this section." msgstr "" #. type: It #: man-pages/man7/mdoc.samples.7:1999 #, no-wrap msgid "\\&.Sh AUTHORS" msgstr "" #. type: Plain text #: man-pages/man7/mdoc.samples.7:2001 msgid "Credits, if need be, should be placed here." msgstr "" #. type: It #: man-pages/man7/mdoc.samples.7:2001 #, no-wrap msgid "\\&.Sh DIAGNOSTICS" msgstr "" #. type: Plain text #: man-pages/man7/mdoc.samples.7:2003 msgid "Diagnostics from a command should be placed in this section." msgstr "" #. type: It #: man-pages/man7/mdoc.samples.7:2003 #, no-wrap msgid "\\&.Sh ERRORS" msgstr "" #. type: Plain text #: man-pages/man7/mdoc.samples.7:2009 msgid "" "Specific error handling, especially from library functions (man page " "sections 2 and 3) should go here. The E<.Ql \\&.Er> macro is used to " "specify an errno." msgstr "" #. type: It #: man-pages/man7/mdoc.samples.7:2009 #, no-wrap msgid "\\&.Sh BUGS" msgstr "" #. type: Plain text #: man-pages/man7/mdoc.samples.7:2011 msgid "Blatant problems with the topic go here..." msgstr "" #. type: Plain text #: man-pages/man7/mdoc.samples.7:2017 msgid "" "User specified E<.Ql \\&.Sh> sections may be added, for example, this " "section was set with:" msgstr "" #. type: Plain text #: man-pages/man7/mdoc.samples.7:2019 #, no-wrap msgid "\\&.Sh PAGE STRUCTURE DOMAIN\n" msgstr "" #. type: Ss #: man-pages/man7/mdoc.samples.7:2020 #, no-wrap msgid "Paragraphs and Line Spacing." msgstr "" #. type: It #: man-pages/man7/mdoc.samples.7:2022 #, no-wrap msgid "\\&.Pp" msgstr "" #. type: Plain text #: man-pages/man7/mdoc.samples.7:2038 msgid "" "The E<.Ql \\&.Pp> paragraph command may be used to specify a line space " "where necessary. The macro is not necessary after a E<.Ql \\&.Sh> or E<.Ql " "\\&.Ss> macro or before a E<.Ql \\&.Bl> macro. (The E<.Ql \\&.Bl> macro " "asserts a vertical distance unless the -compact flag is given)." msgstr "" #. This worked with version one, need to redo for version three #. .Pp #. .Ds I #. .Cw (ax+bx+c) \ is\ produced\ by\ \& #. .\".Cw (ax+bx+c) \&.Va_by_) \&_and_\& \&[?/]m_b1_e1_f1[?/]\& #. .Cl Cx \t\t #. .Li \&.Cx\ ( #. .Cx #. .Cl Cx \t\t #. .Li \&.Va ax #. .Cx #. .Cl Cx \t\t #. .Li \&.Sy \+ #. .Cx #. .Cl Cx \&(\& #. .Va ax #. .Cx + #. .Va by #. .Cx + #. .Va c ) #. .Cx \t #. .Em is produced by #. .Cx \t #. .Li \&.Va by #. .Cx #. .Cl Cx \t\t #. .Li \&.Sy \+ #. .Cx #. .Cl Cx \t\t #. .Li \&.Va c ) #. .Cx #. .Cl Cx \t\t #. .Li \&.Cx #. .Cx #. .Cw #. .De #. .Pp #. This example shows the same equation in a different format. #. The spaces #. around the #. .Li \&+ #. signs were forced with #. .Li \e : #. .Pp #. .Ds I #. .Cw (ax\ +\ bx\ +\ c) \ is\ produced\ by\ \& #. .\".Cw (ax+bx+c) \&.Va_by_) \&_and_\& \&[?/]m_b1_e1_f1[?/]\& #. .Cl Cx \t\t #. .Li \&.Cx\ ( #. .Cx #. .Cl Cx \t\t #. .Li \&.Va a #. .Cx #. .Cl Cx \t\t #. .Li \&.Sy x #. .Cx #. .Cl Cx \t\t #. .Li \&.Cx \e\ +\e\ \e& #. .Cx #. .Cl Cx \&(\& #. .Va a #. .Sy x #. .Cx \ +\ \& #. .Va b #. .Sy y #. .Cx \ +\ \& #. .Va c ) #. .Cx \t #. .Em is produced by #. .Cl Cx \t\t #. .Li \&.Va b #. .Cx #. .Cl Cx \t\t #. .Li \&.Sy y #. .Cx #. .Cl Cx \t\t #. .Li \&.Cx \e\ +\e\ \e& #. .Cx #. .Cl Cx \t\t #. .Li \&.Va c ) #. .Cx #. .Cl Cx \t\t #. .Li \&.Cx #. .Cx #. .Cw #. .De #. .Pp #. The incantation below was #. lifted from the #. .Xr adb 1 #. manual page: #. .Pp #. .Ds I #. .Cw \&[?/]m_b1_e1_f1[?/]\& is\ produced\ by #. .Cl Cx \t\t #. .Li \&.Cx Op Sy ?/ #. .Cx #. .Cl Cx \t\t #. .Li \&.Nm m #. .Cx #. .Cl Cx Op Sy ?/ #. .Nm m #. .Ad \ b1 e1 f1 #. .Op Sy ?/ #. .Cx \t #. .Em is produced by #. .Cx \t #. .Li \&.Ar \e\ b1 e1 f1 #. .Cx #. .Cl Cx \t\t #. .Li \&.Op Sy ?/ #. .Cx #. .Cl Cx \t\t #. .Li \&.Cx #. .Cx #. .Cw #. .De #. .Pp #. type: Ss #: man-pages/man7/mdoc.samples.7:2157 #, no-wrap msgid "Keeps" msgstr "" #. type: Plain text #: man-pages/man7/mdoc.samples.7:2186 msgid "" "The only keep that is implemented at this time is for words. The macros are " "E<.Ql \\&.Bk> (begin-keep) and E<.Ql \\&.Ek> (end-keep). The only option " "that E<.Ql \\&.Bk> accepts is E<.Fl words> and is useful for preventing line " "breaks in the middle of options. In the example for the make command-line " "arguments (see E<.Sx What's in a name>), the keep prevented E<.Xr nroff> " "from placing up the flag and the argument on separate lines. (Actually, the " "option macro used to prevent this from occurring, but was dropped when the " "decision (religious) was made to force right justified margins in E<.Xr " "troff> as options in general look atrocious when spread across a sparse line." " More work needs to be done with the keep macros, a E<.Fl line> option " "needs to be added.)" msgstr "" #. type: Ss #: man-pages/man7/mdoc.samples.7:2186 #, no-wrap msgid "Examples and Displays" msgstr "" #. type: Plain text #: man-pages/man7/mdoc.samples.7:2198 msgid "" "There are five types of displays, a quickie one line indented display E<.Ql " "\\&.D1>, a quickie one line literal display E<.Ql \\&.Dl>, and a block " "literal, block filled and block ragged which use the E<.Ql \\&.Bd> begin-" "display and E<.Ql \\&.Ed> end-display macros." msgstr "" #. type: It #: man-pages/man7/mdoc.samples.7:2200 #, no-wrap msgid "Li \\&.D1" msgstr "" #. type: Plain text #: man-pages/man7/mdoc.samples.7:2203 msgid "" "(D-one) Display one line of indented text. This macro is parsed, but it is " "not callable." msgstr "" #. type: Dl #: man-pages/man7/mdoc.samples.7:2204 #, no-wrap msgid "Fl ldghfstru" msgstr "" #. type: Plain text #: man-pages/man7/mdoc.samples.7:2208 msgid "The above was produced by: E<.Li \\&.Dl Fl ldghfstru>." msgstr "" #. type: It #: man-pages/man7/mdoc.samples.7:2208 #, no-wrap msgid "Li \\&.Dl" msgstr "" #. type: Plain text #: man-pages/man7/mdoc.samples.7:2223 msgid "" "(D-ell) Display one line of indented E<.Em literal> text. The E<.Ql \\&." "Dl> example macro has been used throughout this file. It allows the indent " "(display) of one line of text. Its default font is set to constant width " "(literal) however it is parsed and will recognized other macros. It is not " "callable however." msgstr "" #. type: Dl #: man-pages/man7/mdoc.samples.7:2224 #, no-wrap msgid "% ls -ldg /usr/local/bin" msgstr "" #. type: Plain text #: man-pages/man7/mdoc.samples.7:2228 msgid "The above was produced by E<.Li \\&.Dl % ls -ldg /usr/local/bin>." msgstr "" #. type: It #: man-pages/man7/mdoc.samples.7:2228 #, no-wrap msgid "Li \\&.Bd" msgstr "" #. type: Plain text #: man-pages/man7/mdoc.samples.7:2239 msgid "" "Begin-display. The E<.Ql \\&.Bd> display must be ended with the E<.Ql \\&." "Ed> macro. Displays may be nested within displays and lists. E<.Ql \\&.Bd> " "has the following syntax:" msgstr "" #. type: Dl #: man-pages/man7/mdoc.samples.7:2240 #, no-wrap msgid ".Bd display-type [-offset offset_value] [-compact]" msgstr "" #. type: Plain text #: man-pages/man7/mdoc.samples.7:2245 msgid "" "The display-type must be one of the following four types and may have an " "offset specifier for indentation: E<.Ql \\&.Bd>." msgstr "" #. type: It #: man-pages/man7/mdoc.samples.7:2248 #, no-wrap msgid "Fl ragged" msgstr "" #. type: Plain text #: man-pages/man7/mdoc.samples.7:2251 msgid "" "Display a block of text as typed, right (and left) margin edges are left " "ragged." msgstr "" #. type: It #: man-pages/man7/mdoc.samples.7:2251 #, no-wrap msgid "Fl filled" msgstr "" #. type: Plain text #: man-pages/man7/mdoc.samples.7:2255 msgid "" "Display a filled (formatted) block. The block of text is formatted (the " "edges are filled \\- not left unjustified)." msgstr "" #. type: It #: man-pages/man7/mdoc.samples.7:2255 #, no-wrap msgid "Fl literal" msgstr "" #. type: Plain text #: man-pages/man7/mdoc.samples.7:2258 msgid "" "Display a literal block, useful for source code or simple tabbed or spaced " "text." msgstr "" #. type: It #: man-pages/man7/mdoc.samples.7:2258 #, no-wrap msgid "Fl file Ar file_name" msgstr "" #. type: Plain text #: man-pages/man7/mdoc.samples.7:2267 msgid "" "The filename following the E<.Fl file> flag is read and displayed. Literal " "mode is asserted and tabs are set at 8 constant width character intervals, " "however any E<.Xr troff/ Ns Nm \\-mdoc> commands in file will be processed." msgstr "" #. type: It #: man-pages/man7/mdoc.samples.7:2267 #, no-wrap msgid "Fl offset Ar string" msgstr "" #. type: Plain text #: man-pages/man7/mdoc.samples.7:2273 msgid "" "If E<.Fl offset> is specified with one of the following strings, the string " "is interpreted to indicate the level of indentation for the forthcoming " "block of text:" msgstr "" #. type: It #: man-pages/man7/mdoc.samples.7:2275 #, no-wrap msgid "Ar left" msgstr "" #. type: Plain text #: man-pages/man7/mdoc.samples.7:2279 msgid "" "Align block on the current left margin, this is the default mode of E<.Ql " "\\&.Bd>." msgstr "" #. type: It #: man-pages/man7/mdoc.samples.7:2279 #, no-wrap msgid "Ar center" msgstr "" #. type: Plain text #: man-pages/man7/mdoc.samples.7:2284 msgid "" "Supposedly center the block. At this time unfortunately, the block merely " "gets left aligned about an imaginary center margin." msgstr "" #. type: It #: man-pages/man7/mdoc.samples.7:2284 #, no-wrap msgid "Ar indent" msgstr "" #. type: Plain text #: man-pages/man7/mdoc.samples.7:2293 msgid "" "Indents by one default indent value or tab. The default indent value is " "also used for the E<.Ql \\&.D1> display so one is guaranteed the two types " "of displays will line up. This indent is normally set to 6n or about two " "thirds of an inch (six constant width characters)." msgstr "" #. type: It #: man-pages/man7/mdoc.samples.7:2293 #, no-wrap msgid "Ar indent-two" msgstr "" #. type: Plain text #: man-pages/man7/mdoc.samples.7:2295 msgid "Indents two times the default indent value." msgstr "" #. type: It #: man-pages/man7/mdoc.samples.7:2295 #, no-wrap msgid "Ar right" msgstr "" #. type: Plain text #: man-pages/man7/mdoc.samples.7:2303 msgid "" "This E<.Em left> aligns the block about two inches from the right side of " "the page. This macro needs work and perhaps may never do the right thing by " "E<.Xr troff>." msgstr "" #. type: It #: man-pages/man7/mdoc.samples.7:2304 #, no-wrap msgid ".Ed" msgstr "" #. type: Plain text #: man-pages/man7/mdoc.samples.7:2306 msgid "End-display." msgstr "" #. type: Ss #: man-pages/man7/mdoc.samples.7:2307 #, no-wrap msgid "Font Modes" msgstr "" #. type: Plain text #: man-pages/man7/mdoc.samples.7:2309 msgid "" "There are five macros for changing the appearance of the manual page text:" msgstr "" #. type: It #: man-pages/man7/mdoc.samples.7:2310 #, no-wrap msgid "\\&.Em" msgstr "" #. type: Plain text #: man-pages/man7/mdoc.samples.7:2315 msgid "" "Text may be stressed or emphasized with the E<.Ql \\&.Em> macro. The usual " "font for emphasis is italic." msgstr "" #. type: Dl #: man-pages/man7/mdoc.samples.7:2316 #, no-wrap msgid "Usage: .Em argument ... \\*(Pu" msgstr "" #. type: It #: man-pages/man7/mdoc.samples.7:2318 #, no-wrap msgid "Li \".Em does not\"" msgstr "" #. type: Plain text #: man-pages/man7/mdoc.samples.7:2320 msgid "E<.Em does not>" msgstr "" #. type: It #: man-pages/man7/mdoc.samples.7:2320 #, no-wrap msgid "Li \".Em exceed 1024 .\"" msgstr "" #. type: Plain text #: man-pages/man7/mdoc.samples.7:2322 msgid "E<.Em exceed 1024>." msgstr "" #. type: It #: man-pages/man7/mdoc.samples.7:2322 #, no-wrap msgid "Li \".Em vide infra ) ) ,\"" msgstr "" #. type: Plain text #: man-pages/man7/mdoc.samples.7:2324 msgid "E<.Em vide infra>))," msgstr "" #. type: Plain text #: man-pages/man7/mdoc.samples.7:2332 msgid "" "The E<.Ql \\&.Em> macro is parsed and is callable. It is an error to call " "E<.Ql \\&.Em> without arguments." msgstr "" #. type: It #: man-pages/man7/mdoc.samples.7:2332 #, no-wrap msgid "\\&.Li" msgstr "" #. type: Plain text #: man-pages/man7/mdoc.samples.7:2338 msgid "" "The E<.Ql \\&.Li> literal macro may be used for special characters, variable " "constants, anything which should be displayed as it would be typed." msgstr "" #. type: Dl #: man-pages/man7/mdoc.samples.7:2339 #, no-wrap msgid "Usage: .Li argument ... \\*(Pu" msgstr "" #. type: It #: man-pages/man7/mdoc.samples.7:2341 #, no-wrap msgid "Li \\&.Li \\een" msgstr "" #. type: Plain text #: man-pages/man7/mdoc.samples.7:2343 msgid "E<.Li \\en>" msgstr "" #. type: It #: man-pages/man7/mdoc.samples.7:2343 #, no-wrap msgid "Li \\&.Li M1 M2 M3\\ ;" msgstr "" #. type: Plain text #: man-pages/man7/mdoc.samples.7:2345 msgid "E<.Li M1 M2 M3>;" msgstr "" #. type: It #: man-pages/man7/mdoc.samples.7:2345 #, no-wrap msgid "Li \\&.Li cntrl-D\\ )\\ ," msgstr "" #. type: Plain text #: man-pages/man7/mdoc.samples.7:2347 msgid "E<.Li cntrl-D>)," msgstr "" #. type: It #: man-pages/man7/mdoc.samples.7:2347 #, no-wrap msgid "Li \\&.Li 1024\\ ..." msgstr "" #. type: Plain text #: man-pages/man7/mdoc.samples.7:2349 msgid "E<.Li 1024 ...>" msgstr "" #. type: Plain text #: man-pages/man7/mdoc.samples.7:2354 msgid "The E<.Ql \\&.Li> macro is parsed and is callable." msgstr "" #. type: It #: man-pages/man7/mdoc.samples.7:2354 #, no-wrap msgid "\\&.Sy" msgstr "" #. type: Plain text #: man-pages/man7/mdoc.samples.7:2357 msgid "" "The symbolic emphasis macro is generally a boldface macro in either the " "symbolic sense or the traditional English usage." msgstr "" #. type: Dl #: man-pages/man7/mdoc.samples.7:2358 #, no-wrap msgid "Usage: .Sy symbol ... \\*(Pu" msgstr "" #. type: It #: man-pages/man7/mdoc.samples.7:2360 #, no-wrap msgid "Li \\&.Sy Important Notice" msgstr "" #. type: Plain text #: man-pages/man7/mdoc.samples.7:2362 msgid "E<.Sy Important Notice>" msgstr "" #. type: Plain text #: man-pages/man7/mdoc.samples.7:2369 msgid "" "The E<.Ql \\&.Sy> macro is parsed and is callable. Arguments to E<.Ql \\&." "Sy> may be quoted." msgstr "" #. type: It #: man-pages/man7/mdoc.samples.7:2370 #, no-wrap msgid "Li \\&.Bf" msgstr "" #. type: Plain text #: man-pages/man7/mdoc.samples.7:2380 msgid "" "Begin font mode. The E<.Ql \\&.Bf> font mode must be ended with the E<.Ql " "\\&.Ef> macro. Font modes may be nested within other font modes. E<.Ql \\&." "Bf> has the following syntax:" msgstr "" #. type: Dl #: man-pages/man7/mdoc.samples.7:2381 #, no-wrap msgid ".Bf font-mode" msgstr "" #. type: Plain text #: man-pages/man7/mdoc.samples.7:2385 msgid "The font-mode must be one of the following three types: E<.Ql \\&.Bf>." msgstr "" #. type: It #: man-pages/man7/mdoc.samples.7:2387 #, no-wrap msgid "Sy \\&Em | Fl emphasis" msgstr "" #. type: Plain text #: man-pages/man7/mdoc.samples.7:2391 msgid "" "Same as if the E<.Ql \\&.Em> macro was used for the entire block of text." msgstr "" #. type: It #: man-pages/man7/mdoc.samples.7:2391 #, no-wrap msgid "Sy \\&Li | Fl literal" msgstr "" #. type: Plain text #: man-pages/man7/mdoc.samples.7:2395 msgid "" "Same as if the E<.Ql \\&.Li> macro was used for the entire block of text." msgstr "" #. type: It #: man-pages/man7/mdoc.samples.7:2395 #, no-wrap msgid "Sy \\&Sy | Fl symbolic" msgstr "" #. type: Plain text #: man-pages/man7/mdoc.samples.7:2399 msgid "" "Same as if the E<.Ql \\&.Sy> macro was used for the entire block of text." msgstr "" #. type: It #: man-pages/man7/mdoc.samples.7:2400 #, no-wrap msgid ".Ef" msgstr "" #. type: Plain text #: man-pages/man7/mdoc.samples.7:2402 msgid "End font mode." msgstr "" #. type: Ss #: man-pages/man7/mdoc.samples.7:2403 #, no-wrap msgid "Tagged Lists and Columns" msgstr "" #. type: Plain text #: man-pages/man7/mdoc.samples.7:2417 msgid "" "There are several types of lists which may be initiated with the E<.Ql \"." "Bl\"> begin-list macro. Items within the list are specified with the E<.Ql " "\".It\"> item macro and each list must end with the E<.Ql \".El\"> macro. " "Lists may be nested within themselves and within displays. Columns may be " "used inside of lists, but lists are unproven inside of columns." msgstr "" #. type: Plain text #: man-pages/man7/mdoc.samples.7:2432 msgid "" "In addition, several list attributes may be specified such as the width of a " "tag, the list offset, and compactness (blank lines between items allowed or " "disallowed). Most of this document has been formatted with a tag style list " "E<.Pq Fl tag>. For a change of pace, the list-type used to present the list-" "types is an over-hanging list E<.Pq Fl ohang>. This type of list is quite " "popular with E<.Tn TeX> users, but might look a bit funny after having read " "many pages of tagged lists. The following list types are accepted by E<.Ql " "\".Bl\">:" msgstr "" #. type: It #: man-pages/man7/mdoc.samples.7:2434 #, no-wrap msgid "Fl bullet" msgstr "" #. type: It #: man-pages/man7/mdoc.samples.7:2435 #, no-wrap msgid "Fl item" msgstr "" #. type: It #: man-pages/man7/mdoc.samples.7:2436 #, no-wrap msgid "Fl enum" msgstr "" #. type: Plain text #: man-pages/man7/mdoc.samples.7:2446 msgid "" "These three are the simplest types of lists. Once the E<.Ql \".Bl\"> macro " "has been given, items in the list are merely indicated by a line consisting " "solely of the E<.Ql \".It\"> macro. For example, the source text for a " "simple enumerated list would look like:" msgstr "" #. type: Plain text #: man-pages/man7/mdoc.samples.7:2455 #, no-wrap msgid "" "\\&.Bl -enum -compact\n" "\\&.It\n" "\\&Item one goes here.\n" "\\&.It\n" "\\&And item two here.\n" "\\&.It\n" "\\&Lastly item three goes here.\n" "\\&.El\n" msgstr "" #. type: Plain text #: man-pages/man7/mdoc.samples.7:2459 msgid "The results:" msgstr "" #. type: Plain text #: man-pages/man7/mdoc.samples.7:2463 msgid "Item one goes here." msgstr "" #. type: Plain text #: man-pages/man7/mdoc.samples.7:2465 msgid "And item two here." msgstr "" #. type: Plain text #: man-pages/man7/mdoc.samples.7:2467 msgid "Lastly item three goes here." msgstr "" #. type: Plain text #: man-pages/man7/mdoc.samples.7:2470 msgid "A simple bullet list construction:" msgstr "" #. type: Plain text #: man-pages/man7/mdoc.samples.7:2477 #, no-wrap msgid "" "\\&.Bl -bullet -compact\n" "\\&.It\n" "\\&Bullet one goes here.\n" "\\&.It\n" "\\&Bullet two here.\n" "\\&.El\n" msgstr "" #. type: Plain text #: man-pages/man7/mdoc.samples.7:2483 msgid "Bullet one goes here." msgstr "" #. type: Plain text #: man-pages/man7/mdoc.samples.7:2485 msgid "Bullet two here." msgstr "" #. type: It #: man-pages/man7/mdoc.samples.7:2488 #, no-wrap msgid "Fl tag" msgstr "" #. type: It #: man-pages/man7/mdoc.samples.7:2489 #, no-wrap msgid "Fl diag" msgstr "" #. type: It #: man-pages/man7/mdoc.samples.7:2490 #, no-wrap msgid "Fl hang" msgstr "" #. type: It #: man-pages/man7/mdoc.samples.7:2491 #, no-wrap msgid "Fl ohang" msgstr "" #. type: It #: man-pages/man7/mdoc.samples.7:2492 #, no-wrap msgid "Fl inset" msgstr "" #. type: Plain text #: man-pages/man7/mdoc.samples.7:2512 msgid "" "These list-types collect arguments specified with the E<.Ql \\&.It> macro " "and create a label which may be E<.Em inset> into the forthcoming text, E<." "Em hanged> from the forthcoming text, E<.Em overhanged> from above and not " "indented or E<.Em tagged>. This list was constructed with the E<.Ql \\&Fl " "ohang> list-type. The E<.Ql \\&.It> macro is parsed only for the inset, " "hang and tag list-types and is not callable. Here is an example of inset " "labels:" msgstr "" #. type: It #: man-pages/man7/mdoc.samples.7:2514 #, no-wrap msgid "Em Tag" msgstr "" #. type: Plain text #: man-pages/man7/mdoc.samples.7:2517 msgid "" "The tagged list (also called a tagged paragraph) is the most common type of " "list used in the Berkeley manuals." msgstr "" #. type: It #: man-pages/man7/mdoc.samples.7:2517 #, no-wrap msgid "Em Diag" msgstr "" #. type: Plain text #: man-pages/man7/mdoc.samples.7:2521 msgid "" "Diag lists create section four diagnostic lists and are similar to inset " "lists except callable macros are ignored." msgstr "" #. type: It #: man-pages/man7/mdoc.samples.7:2521 #, no-wrap msgid "Em Hang" msgstr "" #. type: Plain text #: man-pages/man7/mdoc.samples.7:2523 msgid "Hanged labels are a matter of taste." msgstr "" #. type: It #: man-pages/man7/mdoc.samples.7:2523 #, no-wrap msgid "Em Ohang" msgstr "" #. type: Plain text #: man-pages/man7/mdoc.samples.7:2525 msgid "Overhanging labels are nice when space is constrained." msgstr "" #. type: It #: man-pages/man7/mdoc.samples.7:2525 #, no-wrap msgid "Em Inset" msgstr "" #. type: Plain text #: man-pages/man7/mdoc.samples.7:2530 msgid "" "Inset labels are useful for controlling blocks of paragraphs and are " "valuable for converting E<.Nm \\-mdoc> manuals to other formats." msgstr "" #. type: Plain text #: man-pages/man7/mdoc.samples.7:2533 msgid "Here is the source text which produced the above example:" msgstr "" #. type: Plain text #: man-pages/man7/mdoc.samples.7:2552 #, no-wrap msgid "" "\\&.Bl -inset -offset indent\n" "\\&.It Em Tag\n" "\\&The tagged list (also called a tagged paragraph) is the\n" "\\&most common type of list used in the Berkeley manuals.\n" "\\&.It Em Diag\n" "\\&Diag lists create section four diagnostic lists\n" "\\&and are similar to inset lists except callable\n" "\\¯os are ignored.\n" "\\&.It Em Hang\n" "\\&Hanged labels are a matter of taste.\n" "\\&.It Em Ohang\n" "\\&Overhanging labels are nice when space is constrained.\n" "\\&.It Em Inset\n" "\\&Inset labels are useful for controlling blocks of\n" "\\¶graphs and are valuable for converting\n" "\\&.Nm \\-mdoc\n" "\\&manuals to other formats.\n" "\\&.El\n" msgstr "" #. type: Plain text #: man-pages/man7/mdoc.samples.7:2555 msgid "Here is a hanged list with two items:" msgstr "" #. type: It #: man-pages/man7/mdoc.samples.7:2556 #, no-wrap msgid "Em Hanged" msgstr "" #. type: Plain text #: man-pages/man7/mdoc.samples.7:2559 msgid "" "labels appear similar to tagged lists when the label is smaller than the " "label width." msgstr "" #. type: It #: man-pages/man7/mdoc.samples.7:2559 #, no-wrap msgid "Em Longer hanged list labels" msgstr "" #. type: Plain text #: man-pages/man7/mdoc.samples.7:2562 msgid "blend in to the paragraph unlike tagged paragraph labels." msgstr "" #. type: Plain text #: man-pages/man7/mdoc.samples.7:2565 msgid "And the unformatted text which created it:" msgstr "" #. type: Plain text #: man-pages/man7/mdoc.samples.7:2574 #, no-wrap msgid "" "\\&.Bl -hang -offset indent\n" "\\&.It Em Hanged\n" "\\&labels appear similar to tagged lists when the\n" "\\&label is smaller than the label width.\n" "\\&.It Em Longer hanged list labels\n" "\\&blend in to the paragraph unlike\n" "\\&tagged paragraph labels.\n" "\\&.El\n" msgstr "" #. type: Plain text #: man-pages/man7/mdoc.samples.7:2578 msgid "" "The tagged list which follows uses an optional width specifier to control " "the width of the tag." msgstr "" #. type: It #: man-pages/man7/mdoc.samples.7:2580 #, no-wrap msgid "SL" msgstr "" #. type: Plain text #: man-pages/man7/mdoc.samples.7:2582 msgid "sleep time of the process (seconds blocked)" msgstr "" #. type: It #: man-pages/man7/mdoc.samples.7:2582 #, no-wrap msgid "PAGEIN" msgstr "" #. type: Plain text #: man-pages/man7/mdoc.samples.7:2587 msgid "" "number of disk E<.Tn I/O Ns 's> resulting from references by the process to " "pages not loaded in core." msgstr "" #. type: It #: man-pages/man7/mdoc.samples.7:2587 #, no-wrap msgid "UID" msgstr "" #. type: Plain text #: man-pages/man7/mdoc.samples.7:2589 msgid "numerical user-id of process owner" msgstr "" #. type: It #: man-pages/man7/mdoc.samples.7:2589 #, no-wrap msgid "PPID" msgstr "" #. type: Plain text #: man-pages/man7/mdoc.samples.7:2592 msgid "" "numerical ID of parent of process process priority (nonpositive when in " "noninterruptible wait)" msgstr "" #. type: Plain text #: man-pages/man7/mdoc.samples.7:2595 msgid "The raw text:" msgstr "" #. type: Plain text #: man-pages/man7/mdoc.samples.7:2610 #, no-wrap msgid "" "\\&.Bl -tag -width \"PAGEIN\" -compact -offset indent\n" "\\&.It SL\n" "\\&sleep time of the process (seconds blocked)\n" "\\&.It PAGEIN\n" "\\&number of disk\n" "\\&.Tn I/O Ns 's\n" "\\&resulting from references\n" "\\&by the process to pages not loaded in core.\n" "\\&.It UID\n" "\\&numerical user ID of process owner\n" "\\&.It PPID\n" "\\&numerical ID of parent of process process priority\n" "\\&(nonpositive when in noninterruptible wait)\n" "\\&.El\n" msgstr "" #. type: Plain text #: man-pages/man7/mdoc.samples.7:2613 msgid "Acceptable width specifiers:" msgstr "" #. type: It #: man-pages/man7/mdoc.samples.7:2614 #, no-wrap msgid "Fl width Ar \\&Fl" msgstr "" #. type: Plain text #: man-pages/man7/mdoc.samples.7:2623 msgid "" "sets the width to the default width for a flag. All callable macros have a " "default width value. The E<.Ql \\&.Fl>, value is presently set to ten " "constant width characters or about five sixth of an inch." msgstr "" #. type: It #: man-pages/man7/mdoc.samples.7:2623 #, no-wrap msgid "Fl width Ar 24n" msgstr "" #. type: Plain text #: man-pages/man7/mdoc.samples.7:2629 msgid "" "sets the width to 24 constant width characters or about two inches. The E<." "Ql n> is absolutely necessary for the scaling to work correctly." msgstr "" #. type: It #: man-pages/man7/mdoc.samples.7:2629 #, no-wrap msgid "Fl width Ar ENAMETOOLONG" msgstr "" #. type: Plain text #: man-pages/man7/mdoc.samples.7:2632 msgid "sets width to the constant width length of the string given." msgstr "" #. type: It #: man-pages/man7/mdoc.samples.7:2632 #, no-wrap msgid "Fl width Ar \"\\*qint mkfifo\\*q\"" msgstr "" #. type: Plain text #: man-pages/man7/mdoc.samples.7:2635 msgid "again, the width is set to the constant width of the string given." msgstr "" #. type: Plain text #: man-pages/man7/mdoc.samples.7:2649 msgid "" "If a width is not specified for the tag list type, the first time E<.Ql \\&." "It> is invoked, an attempt is made to determine an appropriate width. If " "the first argument to E<.Ql \".It\"> is a callable macro, the default width " "for that macro will be used as if the macro name had been supplied as the " "width. However, if another item in the list is given with a different " "callable macro name, a new and nested list is assumed." msgstr "" #. type: Sh #: man-pages/man7/mdoc.samples.7:2649 #, no-wrap msgid "PREDEFINED STRINGS" msgstr "" #. type: Plain text #: man-pages/man7/mdoc.samples.7:2661 msgid "" "The following strings are predefined as may be used by preceding with the " "troff string interpreting sequence E<.Ql \\&\\e*(xx> where E<.Em xx> is the " "name of the defined string or as E<.Ql \\&\\e*x> where E<.Em x> is the name " "of the string. The interpreting sequence may be used any where in the text." msgstr "" #. type: It #: man-pages/man7/mdoc.samples.7:2663 #, no-wrap msgid "Sy \"String Nroff Troff\"" msgstr "" #. type: It #: man-pages/man7/mdoc.samples.7:2664 #, no-wrap msgid "Li E= Ta \\&E\\&= Ta \\*(E=" msgstr "" #. type: It #: man-pages/man7/mdoc.samples.7:2665 #, no-wrap msgid "Li E= Ta \\&E\\&= Ta \\*(E=" msgstr "" #. type: It #: man-pages/man7/mdoc.samples.7:2666 #, no-wrap msgid "Li Rq Ta '' Ta \\*(Rq" msgstr "" #. type: It #: man-pages/man7/mdoc.samples.7:2667 #, no-wrap msgid "Li Lq Ta `` Ta \\*(Lq" msgstr "" #. type: It #: man-pages/man7/mdoc.samples.7:2668 #, no-wrap msgid "Li ua Ta ^ Ta \\*(ua" msgstr "" #. type: It #: man-pages/man7/mdoc.samples.7:2669 #, no-wrap msgid "Li aa Ta ' Ta \\*(aa" msgstr "" #. type: It #: man-pages/man7/mdoc.samples.7:2670 #, no-wrap msgid "Li ga Ta \\` Ta \\*(ga" msgstr "" #. .It Li "sL" Ta ` Ta \*(sL #. .It Li "sR" Ta ' Ta \*(sR #. type: It #: man-pages/man7/mdoc.samples.7:2673 #, no-wrap msgid "Li q Ta \\(dq Ta \\*q" msgstr "" #. type: It #: man-pages/man7/mdoc.samples.7:2674 #, no-wrap msgid "Li Pi Ta pi Ta \\*(Pi" msgstr "" #. type: It #: man-pages/man7/mdoc.samples.7:2675 #, no-wrap msgid "Li Ne Ta != Ta \\*(Ne" msgstr "" #. type: It #: man-pages/man7/mdoc.samples.7:2676 #, no-wrap msgid "Li Le Ta E= Ta \\*(Le" msgstr "" #. type: It #: man-pages/man7/mdoc.samples.7:2677 #, no-wrap msgid "Li Ge Ta E= Ta \\*(Ge" msgstr "" #. type: It #: man-pages/man7/mdoc.samples.7:2678 #, no-wrap msgid "Li Lt Ta E Ta \\*(Gt" msgstr "" #. type: It #: man-pages/man7/mdoc.samples.7:2679 #, no-wrap msgid "Li Gt Ta E Ta \\*(Lt" msgstr "" #. type: It #: man-pages/man7/mdoc.samples.7:2680 #, no-wrap msgid "Li Pm Ta +- Ta \\*(Pm" msgstr "" #. type: It #: man-pages/man7/mdoc.samples.7:2681 #, no-wrap msgid "Li If Ta infinity Ta \\*(If" msgstr "" #. type: It #: man-pages/man7/mdoc.samples.7:2682 #, no-wrap msgid "Li Na Ta I Ta \\*(Na" msgstr "" #. type: It #: man-pages/man7/mdoc.samples.7:2683 #, no-wrap msgid "Li Ba Ta \\&| Ta \\*(Ba" msgstr "" #. type: Plain text #: man-pages/man7/mdoc.samples.7:2692 msgid "" "E<.Sy Note>: The string named E<.Ql q> should be written as E<.Ql \\e*q> " "since it is only one char." msgstr "" #. type: Sh #: man-pages/man7/mdoc.samples.7:2692 #, no-wrap msgid "DIAGNOSTICS" msgstr "" #. type: Plain text #: man-pages/man7/mdoc.samples.7:2725 msgid "" "The debugging facilities for E<.Nm \\-mdoc> are limited, but can help detect " "subtle errors such as the collision of an argument name with an internal " "register or macro name. (A what?) A register is an arithmetic storage " "class for E<.Xr troff> with a one or two character name. All registers " "internal to E<.Nm \\-mdoc> for E<.Xr troff> and E<.Xr ditroff> are two " "characters and of the form Eupper_caseEElower_caseE such as " "E<.Ql \\&Ar>, Elower_caseEEupper_caseE as E<.Ql \\&aR> or " "Eupper or lower letterEEdigitE as E<.Ql \\&C\\&1>. And " "adding to the muddle, E<.Xr troff> has its own internal registers all of " "which are either two lowercase characters or a dot plus a letter or " "metacharacter character. In one of the introduction examples, it was shown " "how to prevent the interpretation of a macro name with the escape sequence " "E<.Ql \\e&>. This is sufficient for the internal register names also." msgstr "" #. Every callable macro name has a corresponding register #. of the same name (). #. There are also specific registers which have #. been used for stacks and arrays and are listed in the #. .Sx Appendix . #. .Bd -ragged -offset 4n #. [A-Z][a-z] registers corresponding to macro names (example ``Ar'') #. [a-z][A-Z] registers corresponding to macro names (example ``aR'') #. C[0-9] argument types (example C1) #. O[0-9] offset stack (displays) #. h[0-9] horizontal spacing stack (lists) #. o[0-9] offset (stack) (lists) #. t[0-9] tag stack (lists) #. v[0-9] vertical spacing stack (lists) #. w[0-9] width tag/label stack #. .Ed #. .Pp #. type: Plain text #: man-pages/man7/mdoc.samples.7:2764 msgid "" "If a nonescaped register name is given in the argument list of a request, " "unpredictable behavior will occur. In general, any time huge portions of " "text do not appear where expected in the output, or small strings such as " "list tags disappear, chances are there is a misunderstanding about an " "argument type in the argument list. Your mother never intended for you to " "remember this evil stuff - so here is a way to find out whether or not your " "arguments are valid: The E<.Ql \\&.Db> (debug) macro displays the " "interpretation of the argument list for most macros. Macros such as the E<." "Ql \\&.Pp> (paragraph) macro do not contain debugging information. All of " "the callable macros do, and it is strongly advised whenever in doubt, turn " "on the E<.Ql \\&.Db> macro." msgstr "" #. type: Dl #: man-pages/man7/mdoc.samples.7:2765 #, no-wrap msgid "Usage: \\&.Db [on | off]" msgstr "" #. type: Plain text #: man-pages/man7/mdoc.samples.7:2774 msgid "" "An example of a portion of text with the debug macro placed above and below " "an artificially created problem (a flag argument E<.Ql \\&aC> which should " "be E<.Ql \\e&aC> in order to work):" msgstr "" #. type: Plain text #: man-pages/man7/mdoc.samples.7:2778 #, no-wrap msgid "\\&.Db on\n" "\\&.Op Fl aC Ar file )\n" "\\&.Db off\n" msgstr "" #. type: Plain text #: man-pages/man7/mdoc.samples.7:2781 msgid "The resulting output:" msgstr "" #. type: Plain text #: man-pages/man7/mdoc.samples.7:2796 #, no-wrap msgid "" "DEBUGGING ON\n" "DEBUG(argv) MACRO: `.Op' Line #: 2\n" " Argc: 1 Argv: `Fl' Length: 2\n" " Space: `' Class: Executable\n" " Argc: 2 Argv: `aC' Length: 2\n" " Space: `' Class: Executable\n" " Argc: 3 Argv: `Ar' Length: 2\n" " Space: `' Class: Executable\n" " Argc: 4 Argv: `file' Length: 4\n" " Space: ` ' Class: String\n" " Argc: 5 Argv: `)' Length: 1\n" " Space: ` ' Class: Closing Punctuation or suffix\n" " MACRO REQUEST: .Op Fl aC Ar file )\n" "DEBUGGING OFF\n" msgstr "" #. type: Plain text #: man-pages/man7/mdoc.samples.7:2823 msgid "" "The first line of information tells the name of the calling macro, here E<." "Ql \\&.Op>, and the line number it appears on. If one or more files are " "involved (especially if text from another file is included), the line number " "may be bogus. If there is only one file, it should be accurate. The second " "line gives the argument count, the argument E<.Pq Ql \\&Fl> and its length. " "If the length of an argument is two characters, the argument is tested to " "see if it is executable (unfortunately, any register which contains a " "nonzero value appears executable). The third line gives the space allotted " "for a class, and the class type. The problem here is the argument aC should " "not be executable. The four types of classes are string, executable, " "closing punctuation and opening punctuation. The last line shows the entire " "argument list as it was read. In this next example, the offending E<.Ql " "\\&aC> is escaped:" msgstr "" #. type: Plain text #: man-pages/man7/mdoc.samples.7:2827 #, no-wrap msgid "\\&.Db on\n" "\\&.Em An escaped \\e&aC\n" "\\&.Db off\n" msgstr "" #. type: Plain text #: man-pages/man7/mdoc.samples.7:2839 #, no-wrap msgid "" "DEBUGGING ON\n" "DEBUG(fargv) MACRO: `.Em' Line #: 2\n" " Argc: 1 Argv: `An' Length: 2\n" " Space: ` ' Class: String\n" " Argc: 2 Argv: `escaped' Length: 7\n" " Space: ` ' Class: String\n" " Argc: 3 Argv: `aC' Length: 2\n" " Space: ` ' Class: String\n" " MACRO REQUEST: .Em An escaped &aC\n" "DEBUGGING OFF\n" msgstr "" #. type: Plain text #: man-pages/man7/mdoc.samples.7:2849 msgid "" "The argument E<.Ql \\e&aC> shows up with the same length of 2 as the E<.Ql " "\\e&> sequence produces a zero width, but a register named E<.Ql \\e&aC> was " "not found and the type classified as string." msgstr "" #. type: Plain text #: man-pages/man7/mdoc.samples.7:2851 msgid "" "Other diagnostics consist of usage statements and are self explanatory." msgstr "" #. type: Sh #: man-pages/man7/mdoc.samples.7:2851 #, no-wrap msgid "GROFF, TROFF AND NROFF" msgstr "" #. type: Plain text #: man-pages/man7/mdoc.samples.7:2856 msgid "" "The E<.Nm \\-mdoc> package does not need compatibility mode with E<.Xr " "groff>." msgstr "" #. type: Plain text #: man-pages/man7/mdoc.samples.7:2874 msgid "" "The package inhibits page breaks, and the headers and footers which normally " "occur at those breaks with E<.Xr nroff>, to make the manual more efficient " "for viewing on-line. At the moment, E<.Xr groff> with E<.Fl T Ns Ar ascii> " "does eject the imaginary remainder of the page at end of file. The " "inhibiting of the page breaks makes E<.Xr nroff Ns 'd> files unsuitable for " "hardcopy. There is a register named E<.Ql \\&cR> which can be set to zero " "in the site dependent style file E<.Pa /usr/src/share/tmac/doc-nroff> to " "restore the old style behavior." msgstr "" #. type: Sh #: man-pages/man7/mdoc.samples.7:2874 #, no-wrap msgid "FILES" msgstr "" #. type: It #: man-pages/man7/mdoc.samples.7:2876 #, no-wrap msgid "Pa /usr/share/tmac/doc.tmac" msgstr "" #. type: Plain text #: man-pages/man7/mdoc.samples.7:2878 msgid "manual macro package" msgstr "" #. type: It #: man-pages/man7/mdoc.samples.7:2878 #, no-wrap msgid "Pa /usr/share/misc/mdoc.template" msgstr "" #. type: Plain text #: man-pages/man7/mdoc.samples.7:2880 msgid "template for writing a man page" msgstr "" #. type: It #: man-pages/man7/mdoc.samples.7:2880 #, no-wrap msgid "Pa /usr/share/examples/mdoc/*" msgstr "" #. type: Plain text #: man-pages/man7/mdoc.samples.7:2882 msgid "several example man pages" msgstr "" #. type: Sh #: man-pages/man7/mdoc.samples.7:2883 #, no-wrap msgid "BUGS" msgstr "" #. type: Plain text #: man-pages/man7/mdoc.samples.7:2890 msgid "" "Undesirable hyphenation on the dash of a flag argument is not yet resolved, " "and causes occasional mishaps in the E<.Sx DESCRIPTION> section. (line " "break on the hyphen)." msgstr "" #. type: Plain text #: man-pages/man7/mdoc.samples.7:2892 msgid "Predefined strings are not declared in documentation." msgstr "" #. type: Plain text #: man-pages/man7/mdoc.samples.7:2894 msgid "Section 3f has not been added to the header routines." msgstr "" #. type: Plain text #: man-pages/man7/mdoc.samples.7:2899 msgid "E<.Ql \\&.Nm> font should be changed in E<.Sx NAME> section." msgstr "" #. type: Plain text #: man-pages/man7/mdoc.samples.7:2906 msgid "" "E<.Ql \\&.Fn> needs to have a check to prevent splitting up if the line " "length is too short. Occasionally it separates the last parenthesis, and " "sometimes looks ridiculous if a line is in fill mode." msgstr "" #. type: Plain text #: man-pages/man7/mdoc.samples.7:2911 msgid "" "The method used to prevent header and footer page breaks (other than the " "initial header and footer) when using nroff occasionally places an unsightly " "partially filled line (blank) at the would be bottom of the page." msgstr "" #. Note what happens if the parameter list overlaps a newline #. boundary. #. to make sure a line boundary is crossed: #. .Bd -literal #. \&.Fn struct\e\ dictionarytable\e\ *dictionarylookup struct\e\ dictionarytable\e\ *tab[] #. .Ed #. .Pp #. produces, nudge nudge, #. .Fn struct\ dictionarytable\ *dictionarylookup char\ *h struct\ dictionarytable\ *tab[] , #. .Fn struct\ dictionarytable\ *dictionarylookup char\ *h struct\ dictionarytable\ *tab[] , #. nudge #. .Fn struct\ dictionarytable\ *dictionarylookup char\ *h struct\ dictionarytable\ *tab[] . #. .Pp #. If double quotes are used, for example: #. .Bd -literal #. \&.Fn \*qstruct dictionarytable *dictionarylookup\*q \*qchar *h\*q \*qstruct dictionarytable *tab[]\*q #. .Ed #. .Pp #. produces, nudge nudge, #. .Fn "struct dictionarytable *dictionarylookup" "char *h" "struct dictionarytable *tab[]" , #. nudge #. .Fn "struct dictionarytable *dictionarylookup" "char *h" "struct dictionarytable *tab[]" , #. nudge #. .Fn "struct dictionarytable *dictionarylookup" "char *h" "struct dictionarytable *tab[]" . #. .Pp #. Not a pretty sight... #. In a paragraph, a long parameter containing unpaddable spaces as #. in the former example will cause #. .Xr troff #. to break the line and spread #. the remaining words out. #. The latter example will adjust nicely to #. justified margins, but may break in between an argument and its #. declaration. #. In #. .Xr nroff #. the right margin adjustment is normally ragged and the problem is #. not as severe. #. type: Plain text #: man-pages/man7/mdoc.samples.7:2952 msgid "" "The list and display macros to not do any keeps and certainly should be able " "to." msgstr "" #. type: Sh #: man-pages/man7/mdoc.samples.7:2952 #, no-wrap msgid "SEE ALSO" msgstr "" #. type: Plain text #: man-pages/man7/mdoc.samples.7:2957 msgid "E<.Xr man 1>, E<.Xr troff 1>, E<.Xr groff_mdoc 7>, E<.Xr mdoc 7>" msgstr "" #. type: Sh #: man-pages/man7/mdoc.samples.7:2957 #, no-wrap msgid "COLOPHON" msgstr "" #. type: Plain text #: man-pages/man7/mdoc.samples.7:2965 msgid "" "This page is part of release 3.70 of the Linux E<.Em man-pages> project. A " "description of the project, information about reporting bugs, and the latest " "version of this page, can be found at \\%http://www.kernel.org/doc/man\\-" "pages/." msgstr ""