:man| Alphabetical   Categories   About us 
 
GROFF_MDOC (7) | Miscellanea | Unix Manual Pages | :man▋

NAME

groff_mdoc - reference for groff’s mdoc implementation

CONTENTS

Synopsis
Description
Conventions
Addresses
Errno’s
Flags
Literals
Names
Options
Pathnames
Standards
Variables
Symbolics
Mathematical Symbols
Keeps
Diagnostics
Files
Bugs

SYNOPSIS

groff-m doc

DESCRIPTION

A complete reference for writing Unix manual pages with the -mdoc macro package; a content -based and domain -based formatting package for GNU troff(1). Its predecessor, the -man(7) package, addressed page layout leaving the manipulation of fonts and other typesetting details to the individual author. In -mdoc, page layout macros make up the "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 Unix 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. Hopefully, the consistency gained across the manual set will provide easier translation to future documentation tools.

Throughout the Unix manual pages, a manual entry is simply referred to as a man page, regardless of actual length and without sexist intention.

"GETTING STARTED"

The material presented in the remainder of this document is outlined as follows:
  1. "TROFF IDIOSYNCRASIES"
    "Macro Usage"
    "Passing Space Characters in an Argument"
    "Trailing Blank Space Characters"
    "Escaping Special Characters"
    "Other Possible Pitfalls"
  2. "A MANUAL PAGE TEMPLATE"
  3. "CONVENTIONS"
  4. "TITLE MACROS"
  5. "INTRODUCTION OF MANUAL AND GENERAL TEXT DOMAINS"
    "What’s in a Name" ...
    "General Syntax"
  6. "MANUAL DOMAIN"
    "Addresses"
    "Author Name"
    "Arguments"
    "Configuration Declarations (Section Four Only)"
    "Command Modifiers"
    "Defined Variables"
    "Errno’s"
    "Environment Variables"
    "Flags"
    "Function Declarations"
    "Function Types"
    "Functions (Library Routines)"
    "Function Arguments"
    "Return Values"
    "Exit Status"
    "Interactive Commands"
    "Library Names"
    "Literals"
    "Names"
    "Options"
    "Pathnames"
    "Standards"
    "Variable Types"
    "Variables"
    "Manual Page Cross References"
  7. "GENERAL TEXT DOMAIN"
    "AT&T Macro"
    "BSD Macro"
    "NetBSD Macro"
    "FreeBSD Macro"
    "OpenBSD Macro"
    "BSD/OS Macro"
    "UNIX Macro"
    "Emphasis Macro"
    "Font Mode"
    "Enclosure and Quoting Macros"
    "No-Op or Normal Text Macro"
    "No-Space Macro"
    "Section Cross References"
    "Symbolics"
    "Mathematical Symbols"
    "References and Citations"
    "Trade Names (or Acronyms and Type Names)"
    "Extended Arguments"
  8. "PAGE STRUCTURE DOMAIN"
    "Section Headers"
    "Subsection Headers"
    "Paragraphs and Line Spacing"
    "Keeps"
    "Examples and Displays"
    "Lists and Columns"
  9. "MISCELLANEOUS MACROS"
  10. "PREDEFINED STRINGS"
  11. "DIAGNOSTICS"
  12. "FORMATTING WITH GROFF, TROFF, AND NROFF"
  13. "FILES"
  14. "SEE ALSO"
  15. "BUGS"

 
Created by Blin Media, 2008-2013