Welcome to Linux Knowledge Base and Tutorial
"The place where you learn linux"
International Rescue Committe

 Create an AccountHome | Submit News | Your Account  

Tutorial Menu
Linux Tutorial Home
Table of Contents

· Introduction to Operating Systems
· Linux Basics
· Working with the System
· Shells and Utilities
· Editing Files
· Basic Administration
· The Operating System
· The X Windowing System
· The Computer Itself
· Networking
· System Monitoring
· Solving Problems
· Security
· Installing and Upgrading
· Linux and Windows

Man Pages
Linux Topics
Test Your Knowledge

Site Menu
Site Map
Copyright Info
Terms of Use
Privacy Info
Masthead / Impressum
Your Account

Private Messages

News Archive
Submit News
User Articles
Web Links


The Web

Who's Online
There are currently, 78 guest(s) and 0 member(s) that are online.

You are an Anonymous user. You can register for free by clicking here




     The -mdoc package is a set of content-based and domain-based macros used
     to format the BSD man pages.  The macro names and their meanings are
     listed below for quick reference; for a detailed explanation on using the
     package, see the tutorial sampler mdoc.samples(7).

     Note that this is not the usual macro package for Linux documentation,
     although it is used for documentation of several widely-used programs;
     see man(7).

     The macros are described in two groups, the first includes the structural
     and physical page layout macros.  The second contains the manual and gen­
     eral text domain macros which differentiate the -mdoc package from other
     troff formatting packages.


   Title Macros
     To create a valid manual page, these three macros, in this order, are
     .Dd   Month day, year                       Document date.
     .Dt   DOCUMENT_TITLE [section] [volume]     Title, in upper case.
     .Os   OPERATING_SYSTEM [version/release]    Operating system (BSD).

   Page Layout Macros
     Section headers, paragraph breaks, lists and displays.
     .Sh   Section Headers.  Valid headers, in the order of presentation:
           NAME           Name section, should include the `.Nm' or `.Fn' and
                          the `.Nd' macros.
           SYNOPSIS       Usage.
           DESCRIPTION    General description, should include options and
           RETURN VALUES  Sections two and three function calls.
           ENVIRONMENT    Describe environment variables.
           FILES          Files associated with the subject.
           EXAMPLES       Examples and suggestions.
           DIAGNOSTICS    Normally used for section four device interface
           ERRORS         Sections two and three error and signal handling.
           SEE ALSO       Cross references and citations.
           CONFORMING TO  Conformance to standards if applicable.
           HISTORY        If a standard is not applicable, the history of the
                          subject should be given.
           BUGS           Gotchas and caveats.
           other          Customized headers may be added at the authors dis­
     .Ss   Subsection Headers.
     .Pp   Paragraph Break.  Vertical space (one line).
     .D1   (D-one) Display-one Indent and display one text line.
     .Dl   (D-ell) Display-one literal.  Indent and display one line of lit­
           eral text.
     .Bd   Begin-display block.  Display options:
     .Bl   Begin-list.  Create lists or columns. Options:
                 -bullet    Bullet Item List
                 -item      Unlabeled List
                 -enum      Enumerated List
                 -tag       Tag Labeled List
                 -diag      Diagnostic List
                 -hang      Hanging Labeled List
                 -ohang     Overhanging Labeled List
                 -inset     Inset or Run-on Labeled List
                 -offset    (All lists.) See `.Bd' begin-display above.
                 -width     (-tag and -hang lists only.)  See `.Bd'.
                 -compact   (All lists.)  Suppresses blank lines.
     .El   End-list.
     .It   List item.


     The manual and general text domain macros are special in that most of
     them are parsed for callable macros for example:

           .Op Fl s Ar file   Produces [-s file]

     In this example, the option enclosure macro `.Op' is parsed, and calls
     the callable content macro `Fl' which operates on the argument `s' and
     then calls the callable content macro `Ar' which operates on the argument
     `file'.  Some macros may be callable, but are not parsed and vice versa.
     These macros are indicated in the parsed and callable columns below.

     Unless stated, manual domain macros share a common syntax:

           .Va argument [ . , ; : ( ) [ ] argument ... ]

     Note: Opening and closing punctuation characters are only recognized as
     such if they are presented one at a time.  The string `),' is not recog­
     nized as punctuation and will be output with a leading white space and in
     what ever font the calling macro uses.  The argument list `] ) ,' is rec­
     ognized as three sequential closing punctuation characters and a leading
     white space is not output between the characters and the previous argu­
     ment (if any).  The special meaning of a punctuation character may be
     escaped with the string `\&'.  For example the following string,

           .Ar file1 , file2 , file3 ) .   Produces file1, file2, file3).

   Manual Domain Macros
     Name    Parsed    Callable     Description
     Ad      Yes       Yes          Address. (This macro may be deprecated.)
     An      Yes       Yes          Author name.
     Ar      Yes       Yes          Command line argument.
     Cd      No        No           Configuration declaration (section four
     Cm      Yes       Yes          Command line argument modifier.
     Vt      Yes       Yes          Variable type (Fortran only).
     Xr      Yes       Yes          Manual Page Cross Reference.

   General Text Domain Macros
     Name    Parsed    Callable     Description
     %A      Yes       No           Reference author.
     %B      Yes       Yes          Reference book title.
     %C      No        No           Reference place of publishing (city).
     %D      No        No           Reference date.
     %J      Yes       Yes          Reference journal title.
     %N      No        No           Reference issue number.
     %O      No        No           Reference optional information.
     %P      No        No           Reference page number(s).
     %R      No        No           Reference report Name.
     %T      Yes       Yes          Reference article title.
     %V      No        No           Reference volume.
     Ac      Yes       Yes          Angle close quote.
     Ao      Yes       Yes          Angle open quote.
     Ap      Yes       Yes          Apostrophe.
     Aq      Yes       Yes          Angle quote.
     At      No        No           AT&T UNIX
     Bc      Yes       Yes          Bracket close quote.
     Bf      No        No           Begin font mode.
     Bo      Yes       Yes          Bracket open quote.
     Bq      Yes       Yes          Bracket quote.
     Bx      Yes       Yes          BSD.
     Db      No        No           Debug (default is "off")
     Dc      Yes       Yes          Double close quote.
     Do      Yes       Yes          Double open quote.
     Dq      Yes       Yes          Double quote.
     Ec      Yes       Yes          Enclose string close quote.
     Ef      No        No           End font mode.
     Em      Yes       Yes          Emphasis (traditional English).
     Eo      Yes       Yes          Enclose string open quote.
     Fx      No        No           FreeBSD operating system
     No      Yes       Yes          Normal text (no-op).
     Ns      Yes       Yes          No space.
     Pc      Yes       Yes          Parenthesis close quote.
     Pf      Yes       No           Prefix string.
     Po      Yes       Yes          Parenthesis open quote.
     Pq      Yes       Yes          Parentheses quote.
     Qc      Yes       Yes          Straight Double close quote.
     Ql      Yes       Yes          Quoted literal.
     Qo      Yes       Yes          Straight Double open quote.
     Qq      Yes       Yes          Straight Double quote.
     Re      No        No           Reference end.
     Rs      No        No           Reference start.
     Rv      No        No           Return values (sections two and three
     Sc      Yes       Yes          Single close quote.
     So      Yes       Yes          Single open quote.
     Sq      Yes       Yes          Single quote.
     enclosure macros (`.Fo', `.Fc') are irregular.  The extended list macros
     are used when the number of macro arguments would exceed the troff limi­
     tation of nine arguments.

     The macros UR (starting a URI/URL hypertext reference), UE (ending one),
     and UN (identifying a target for a reference) are also available.  See
     man(7) for more information on these macros.


     For site specific configuration of the macro package, see the file


     tmac.doc          Manual and general text domain macros.
     tmac.doc-common   Common structural macros and definitions.
     tmac.doc-nroff    Site dependent nroff style file.
     tmac.doc-ditroff  Site dependent troff style file.
     tmac.doc-syms     Special defines (such as the standards macro).


     mdoc.samples(7), man(7)

Linux                            July 11, 1999                           Linux



Security Code
Security Code
Type Security Code

Don't have an account yet? You can create one. As a registered user you have some advantages like theme manager, comments configuration and post comments with your name.

Help if you can!

Amazon Wish List

Did You Know?
You can help in many different ways.


Tell a Friend About Us

Bookmark and Share

Web site powered by PHP-Nuke

Is this information useful? At the very least you can help by spreading the word to your favorite newsgroups, mailing lists and forums.
All logos and trademarks in this site are property of their respective owner. The comments are property of their posters. Articles are the property of their respective owners. Unless otherwise stated in the body of the article, article content (C) 1994-2013 by James Mohr. All rights reserved. The stylized page/paper, as well as the terms "The Linux Tutorial", "The Linux Server Tutorial", "The Linux Knowledge Base and Tutorial" and "The place where you learn Linux" are service marks of James Mohr. All rights reserved.
The Linux Knowledge Base and Tutorial may contain links to sites on the Internet, which are owned and operated by third parties. The Linux Tutorial is not responsible for the content of any such third-party site. By viewing/utilizing this web site, you have agreed to our disclaimer, terms of use and privacy policy. Use of automated download software ("harvesters") such as wget, httrack, etc. causes the site to quickly exceed its bandwidth limitation and are therefore expressly prohibited. For more details on this, take a look here

PHP-Nuke Copyright © 2004 by Francisco Burzi. This is free software, and you may redistribute it under the GPL. PHP-Nuke comes with absolutely no warranty, for details, see the license.
Page Generation: 0.08 Seconds