Provided by: manpages-ja_0.5.0.0.20110915-1_all bug

TROFF

     -mdoc  man -mdoc troff(1)
      troff(1)  9 -mdoc  9  (  )  (  )

     -mdoc  '.' () '.Op' 'Fl' 'Ar'

           [-s bytes]          .Op Fl s Ar bytes
           [Fl s Ar bytes]     .Op \&Fl s \&Ar bytes

      'Fl' 'Ar' mdoc(7) -mdoc

       9 '.Fn' ANSI C  2 int foo

      2 : AT&T troff groff

           Cd     ( 4 SYNOPSIS)
           Bl     ()
           Em
           Fn     ( 2  4)
           It
           Li
           Sy
           %B
           %J
           %O
           %R     ()
           %T

      '\' '\' 1 troff

           fetch(char *str)   '.Fn fetch char\ *str'

           fetch(char *str)   '.Fn fetch "char *str"'

      '\' '.Fn'  3

           fetch(char, *str)
      '\n' '\' '\e' ( '\en' )

MAN

     man /usr/share/misc/mdoc.template /usr/share/examples/mdoc  man

           .\"  man
           .Dd  ,
           .Os  [/]
           .Dt  [] []
           .Sh NAME
           .Nm
           .Nd  1
           .Sh SYNOPSIS
           .Sh DESCRIPTION
           .\"
           .\"
           .\" .Sh IMPLEMENTATION NOTES
           .\"  2, 3, 9
           .\"
           .\" .Sh RETURN VALUE
           .\"  1, 6, 7, 8, 9
           .\" .Sh ENVIRONMENT
           .\" .Sh FILES
           .\" .Sh EXAMPLES
           .\"  1, 6, 7, 8, 9
           .\"     (() fprintf/stderr
           .\"      )
           .\" .Sh DIAGNOSTICS
           .\" .Sh COMPATIBILITY
           .\"  2, 3, 9
           .\"
           .\" .Sh ERRORS
           .\" .Sh SEE ALSO
           .\" .Sh STANDARDS
           .\" .Sh HISTORY
           .\" .Sh AUTHORS
           .\" .Sh BUGS

      (.Dd, .Os, .Dt) man () man

      (.Sh) NAME SYNOPSIS DESCRIPTION
     .Dt   []
              man troff   1, ..., 9

             FreeBSD :

                   1      FreeBSD General Commands Manual
                   2      FreeBSD System Calls Manaul
                   3      FreeBSD Library Calls Manual
                   4      FreeBSD Kernel Interfaces Manual
                   5      FreeBSD File Formats Manual
                   6      FreeBSD Games Manual
                   7      FreeBSD Miscellaneous Information Manual
                   8      FreeBSD System Manager's Manual
                   9      FreeBSD Kernel Developers Guide

                   AMD    UNIX Ancestral Manual Documents
                   SMM    UNIX System Manager's Manual
                   URM    UNIX Reference Manual
                   PRM    UNIX Programmer's Manual

               1, 6, 7 URM  8 SMM  2, 3, 4, 5 PRM

     .Os      () BSD FreeBSD ATT 4.3, 4.3+Tahoe, V.3, V.4

                   .Os 4.3BSD

                   .Os FreeBSD 2.2

                   .Os CS Department

             Berkeley '.Os' /usr/share/tmac/mdoc/doc-common BSD LOCAL '.Os'

     .Dd  ,

                   January 25, 1989

   ...?
       man 3 -mdoc 2 -mdoc UNIX 3 man

      troff(1) troff

           .Va argument1 argument2 ... argument9

     '.Va' 2 UNIX SYNOPSIS

           filter [-flag] infile outfile

      filter -flag  -mdoc infile outfile

           .Nm filter
           .Op Fl flag
           .Ar infile outfile

     3 infile outfile

           make  [-eiknqrstv] [-D variable] [-d flags] [-f makefile]
                 [-I directory] [-j max_jobs] [variable=value] [target ...]

      make makefile -f target -mdoc  target 'Ar' variable  make

           .Nm make
           .Op Fl eiknqrstv
           .Op Fl D Ar variable
           .Op Fl d Ar flags
           .Op Fl f Ar makefile
           .Op Fl I Ar directory
           .Op Fl j Ar max_jobs
           .Op Ar variable=value
           .Bk -words
           .Op Ar target ...
           .Ek

      '.Bk' '.Ek'

      '.Ar', '.Fl', '.Nm', '.Pa' '.Fn' '.Xr' '.Op' '.Fn'

           .Li sptr, ptr),

           sptr, ptr),

           .Li sptr , ptr ) ,

           sptr, ptr),

     '\&' troff

                 {+,-,/,*,%,<,>,<=,>=,=,==,&,`,',"}
      addr1[,addr2[,addr3]]

           : .Ad address ...
                   .Ad addr1    addr1
                   .Ad addr1 .  addr1.
                   .Ad addr1 , file2
                                addr1, file2
                   .Ad f1 , f2 , f3 :
                                f1, f2, f3:
                   .Ad addr ) ) ,
                                addr)),

     '.Ad' '.Ad'

     '.An'

           : .An author_name
                   .An Joe Author
                                  Joe Author
                   .An Joe Author ,
                                  Joe Author,
                   .An Joe Author Aq nobody@FreeBSD.ORG
                                  Joe Author <nobody@FreeBSD.ORG>
                   .An Joe Author ) ) ,
                                  Joe Author)),

     '.An' '.An'

     AUTHORS '.An'

           .An -nosplit

           .An -split

      '.Ar'

           : .Ar argument ...
                    .Ar          file ...
                    .Ar file1    file1
                    .Ar file1 .  file1.
                    .Ar file1 file2
                                 file1 file2
                    .Ar f1 f2 f3 :
                                 f1 f2 f3:
                    .Ar file ) ) ,
                                 file)),

     '.Ar' 'file ...' '.Ar'

    ( 4 )
     '.Cd'  4 config(8)  (2 )

           device le0 at scode?   '.Cd device le0 at scode?'

      '.Cm' '.Fl' ()

      '.Dv'

           : .Dv defined_variable ...
                   .Dv MAXHOSTNAMELEN
                                   MAXHOSTNAMELEN
                   .Dv TIOCGPGRP )
                                   TIOCGPGRP)

     '.Dv' '.Dv'

   errno ( 2 )
      '.Er'  2  2 '.Er' '.Bq' ( 2 )

           : .Er ERRNOTYPE ...
                   .Er ENOENT
                              ENOENT
                   .Er ENOENT ) ;
                              ENOENT);
                   .Bq Er ENOTDIR
                              [ENOTDIR]

     '.Er' '.Er'

     '.Ev'

           : .Ev argument ...
                   .Ev DISPLAY
                               DISPLAY
                   .Ev PATH .  PATH.
                   .Ev PRINTER ) ) ,
                               PRINTER)),

     '.Ev' '.Ev'

     '.Fa'  () SYNOPSIS SYNOPSIS '.Fn' '.Fo' '.Fc' '.Fa'

           : .Fa function_argument ...
                   .Fa d_namlen ) ) ,
                                   d_namlen)),
                   .Fa iov_len     iov_len

     '.Fa' '.Fa'

     '.Fd' SYNOPSIS  2  3 '.Fd'

           : .Fd include_file (or defined variable)

     SYNOPSIS '.Fd'

     '.Fl' '-' '.Cm' ()

           : .Fl argument ...
                   .Fl          -
                   .Fl cfv      -cfv
                   .Fl cfv .    -cfv.
                   .Fl s v t    -s -v -t
                   .Fl - ,      --,
                   .Fl xyz ) ,  -xyz),

      '.Fl' / '.Fl' 2 '.Fl'

    ()
     '.Fn'  ANSI C

     : .Fn [type] function [[type] parameters ... ]
     .Fn getchar                              getchar()
     .Fn strlen ) ,                           strlen()),
     .Fn "int align" "const * char *sptrs",   int align(const * char *sptrs),

     '.Fn' '.Fn' '.Fn' ()
           .Ft int
           .Fo res_mkquery
           .Fa "int op"
           .Fa "char *dname"
           .Fa "int class"
           .Fa "int type"
           .Fa "char *data"
           .Fa "int datalen"
           .Fa "struct rrec *newrr"
           .Fa "char *buf"
           .Fa "int buflen"
           .Fc

           int   res_mkquery(int op,   char *dname,    int class,    int type,
           char *data, int datalen, struct rrec *newrr, char *buf, int buflen)

     '.Fo' '.Fc' SYNOPSIS SYNOPSIS '.Fn'  troff

      SYNOPSIS man  2  3 SYNOPSIS ()

           : .Ft type ...
                   .Ft struct stat  struct stat

     '.Ft'

     '.Ic'

           : .Ic argument ...
                   .Ic :wq             :wq
                   .Ic do while {...}  do while {...}
                   .Ic setenv , unsetenv
                                       setenv, unsetenv

     '.Ic' '.Ic'

     '.Lb'

           : .Lb argument ...

     '.Lb' :

           libc         Standard C Library (libc, -lc)
           libc_r       library ``libc_r''
           libcalendar  library ``libcalendar''
           libcam       library ``libcam''
           libcompat    Compatibility Library (libcompat, -lcompat)
           libcrypt     Crypt Library (libcrypt, -lcrypt)
           libdevstat   library ``libdevstat''
           libdisk      library ``libdisk''
           libedit      Command Line Editor Library (libedit, -ledit)
           libfetch     library ``libfetch''
           libipsec     IPsec Policy Control Library (libipsec, -lipsec)
           libipx       library ``libipx''
           libkvm       Kernel Data Access Library (libkvm, -lkvm)
           libm         Math Library (libm, -lm)
           libmd        library ``libmd''
           libnetgraph  library ``libnetgraph''
           libposix1e   library ``libposix1e''
           libskey      library ``libskey''
           libusb       library ``libusb''
           libutil      System Utilities Library (libutil, -lutil)
           libvgl       library ``libvgl''

     '.Nm' '.Nm' :  2  3 NAME '.Nm' SYNOPSIS '.Fn' csh(1) 'while' '.Ic' '.Ic'
     '.Nm'

           : .Nm argument ...
                   .Nm mdoc.sample
                                mdoc.sample
                   .Nm \-mdoc   -mdoc.
                   .Nm foo ) ) ,
                                foo)),
                   .Nm          mdoc.samples

     '.Nm'

     '.Op' '.Oc' '.Oo'

           : .Op options ...
           .Op                    []
           .Op Fl k               [-k]
           .Op Fl k ) .           [-k]).
           .Op Fl k Ar kookfile   [-k kookfile]
           .Op Fl k Ar kookfile ,
                                  [-k kookfile],
           .Op Ar objfil Op Ar corfil
                                  [objfil [corfil]]
           .Op Fl c Ar objfil Op Ar corfil ,
                                  [-c objfil [corfil]],
           .Op word1 word2        [word1 word2]

     '.Oc' '.Oo' :

           .Oo
           .Op Fl k Ar kilobytes
           .Op Fl i Ar interval
           .Op Fl c Ar count
           .Oc

     : [[-k kilobytes] [-i interval] [-c count]]

     '.Op' '.Oc' '.Oo'

     '.Pa'

           : .Pa pathname
                   .Pa /usr/share   /usr/share
                   .Pa /tmp/fooXXXXX ) .
                                    /tmp/fooXXXXX).

     '.Pa'

     '.St'

           : .St abbreviature

      ``/'' :
           -ansiC          ANSI X3.159-1989 (``ANSI C89'')
           -ansiC-89       ANSI X3.159-1989 (``ANSI C89'')
           -ieee754        IEEE Std 754-1985
           -iso8802-3      ISO/IEC 8802-3:1989
           -isoC           ISO/IEC 9899:1990 (``ISO C90'')
           -isoC-99        ISO/IEC 9899:1999 (``ISO C99'')
           -p1003.1        IEEE Std 1003.1 (``POSIX.1'')
           -p1003.1-88     IEEE Std 1003.1-1988 (``POSIX.1'')
           -p1003.1-90     ISO/IEC 9945-1:1990 (``POSIX.1'')
           -p1003.1-96     ISO/IEC 9945-1:1996 (``POSIX.1'')
           -p1003.1b-93    IEEE Std 1003.1b-1993 (``POSIX.1'')
           -p1003.1g-2000  IEEE Std 1003.1g-2000 (``POSIX.1'')
           -p1003.2        IEEE Std 1003.2 (``POSIX.2'')
           -p1003.2-92     IEEE Std 1003.2-1992 (``POSIX.2'')
           -susv2          Version 2 of the Single UNIX Specification
                           (``SUSv2'')
           -xpg3           X/Open Portability Guide Issue 3 (``XPG3'')
           -xpg4           X/Open Portability Guide Issue 4 (``XPG4'')
           -xpg4.2         X/Open Portability Guide Issue 4, Version 2
                           (``XPG4.2'')

           : .Va variable ...
                   .Va count   count
                   .Va settimer,
                               settimer,
                   .Va int *prt ) :
                               int *prt):
                   .Va char s ] ) ) ,
                               char s])),

     '.Va' '.Va'

     '.Xr'

           : .Xr man_page [1,...,9]
                   .Xr mdoc    mdoc
                   .Xr mdoc ,  mdoc,
                   .Xr mdoc 7  mdoc(7)
                   .Xr mdoc 7 ) ) ,
                               mdoc(7))),

     '.Xr' '.Xr'

   AT&T
           : .At [v6 | v7 | 32v | V.1 | V.4] ...
                   .At                    AT&T UNIX
                   .At v6 .               Version 6 AT&T UNIX.

     '.At'    2

   BSD
           : .Bx [Version/release] ...
                   .Bx       BSD
                   .Bx 4.3 .
                             4.3BSD.

     '.Bx'

   FreeBSD/NetBSD/OpenBSD
           : .Fx [ Version.release ] ...
                   .Fx 2.2 .      FreeBSD 2.2.

           : .Nx [ Version.release ] ...
                   .Nx 1.4 .     NetBSD 1.4.

           : .Ox [ Version.release ] ...
                   .Ox 2.5 .      OpenBSD 2.5.

     '.Fx', '.Nx', '.Ox'  2

   UNIX
           : .Ux ...
                   .Ux         UNIX

     '.Ux'

   /
      1  1  (quote) 'q' 'o' 'c'  1  1

           .Aq .Ac .Ao     <>
           .Bq .Bc .Bo     []
           .Dq .Dc .Do 2   ``''
               .Ec .Eo  (XX)      XXXX
           .Pq .Pc .Po     ()
           .Ql             `st'
           .Qq .Qc .Qo  2  ""
           .Sq .Sc .So 1   `'

      (: )

     .Ec, .Eo

     .Ql        troff nroff nroff troff  3  ()

     .Pf

                     .Pf ( Fa name2
                               (name2

               '.Ns' ()

     :
           .Aq                   <>
           .Aq Ar ctype.h ) ,    <ctype.h>),
           .Bq                   []
           .Bq Em Greek , French .
                                 [Greek, French].
           .Dq                   ``''
           .Dq string abc .      ``string abc''.
           .Dq '^[A-Z]'          ``'^[A-Z]'''
           .Ql man mdoc          'man mdoc'
           .Qq                   ""
           .Qq string ) ,        "string"),
           .Qq string Ns ),      "string),"
           .Sq                   ''
           .Sq string            'string'

      '.Op' '.Xo' '.Xc' -mdoc

   no-op
     '.No'

     '.Ns'

           .Op Fl I Ns Ar directory
                             [-Idirectory]

     : '.Ns' '.No' '.Ns'

     '.Sx'

                   .Sx FILES     FILES

           .Rs
           .Re
           .%A     1
           .%B
           .%C      /
           .%D
           .%J
           .%N
           .%O
           .%P
           .%R
           .%T
           .%V

     '%' () troff/ditroff

     '.Rv' RETURN VALUE

           : .Rv [-std function]

     '.Rv -std atexit'

     The atexit() function returns the value 0 if successful; otherwise the
     value -1 is returned and the global variable errno is set to indicate the
     error.

     -std  2  3

    ()
      2

           : .Tn symbol ...
                   .Tn DEC
                          DEC
                   .Tn ASCII
                          ASCII

     '.Tn'

     '.Xo' '.Xc' '.Op'  1

      '.Xo'

           .Sm off
           .It Xo Sy I Ar operation
           .No \en Ar count No \en
           .Xc
           .Sm on

           Ioperation\ncount\n

     :

           .Sm off
           .It Cm S No / Ar old_pattern Xo
           .No / Ar new_pattern
           .No / Op Cm g
           .Xc
           .Sm on

           S/old_pattern/new_pattern/[g]

      '.Xo' :

           .It Xo
           .Ic .ifndef
           .Oo \&! Oc Ns Ar variable
           .Op Ar operator variable ...
           .Xc

           .ifndef [!]variable [operator variable ...]

      '.It' () '.Xo'  2 3 '.Xo' '.Xc'  3 '.Xo' '.It' '.Ns' () BSD  900  ( 1500
     )  15 '.Xo'

      3 '.Sh'  man '.Sh'  9

     .Sh NAME  '.Sh NAME (: )' NAME  3 '.Nm' man 2 '.Nd'  3

     .Sh SYNOPSIS
               SYNOPSIS (: )  man '.Nm', '.Cd', '.Fn' ( '.Fo', '.Fc', '.Fd',
               '.Ft' ) '.Fn'  2  3 '.Nm'  1, 5, 6, 7, 8  4 '.Nm' '.Fd' '.Cd'

                     cat [-benstuv] [-] file ...

                     .Nm cat
                     .Op Fl benstuv
                     .Op Fl
                     .Ar

               : '.Op', '.Fl', '.Ar' '|'

                     .Op Fl a | Fl b

                troff  |  |

     .Sh DESCRIPTION
               DESCRIPTION (: ) '.Bl' '.It' '.El'  (  )

      '.Sh'

     .Sh ENVIRONMENT (: )
       ENVIRONMENT

     .Sh EXAMPLES (: )

     .Sh FILES (: )
       man FILES '.Pa'

     .Sh SEE ALSO (: )
       SEE ALSO  man  man '.Xr' SEE ALSO

       ls(1), ps(1), group(5), passwd(5)

        refer(1)

     .Sh STANDARDS (: )
        IEEE Std 1003.2 (``POSIX.2'') ANSI X3.159-1989 (``ANSI C89'') HISTORY

     .Sh HISTORY (: )

     .Sh AUTHORS (: )
        '.An'

     .Sh DIAGNOSTICS (: )

     .Sh ERRORS (: )
        (man  2, 3, 9) '.Er'  errno

     .Sh BUGS (: )

      '.Sh'

                   .Sh

     .Pp     '.Pp' '.Sh' '.Ss' '.Bl' ( '.Bl'  -compact )

      '.Bk' () '.Ek' () '.Bk' -words  ( ...? ) nroff ( troff  () -line )

      5  1 '.D1'  1 '.Dl' '.Bd' '.Ed'

     .D1    (D-)  1

                  -ldghfstru

             .D1 Fl ldghfstru

     .Dl    (D-)   1 '.Dl'  1  ()  ()

                  % ls -ldg /usr/local/bin

             .Dl % ls -ldg /usr/local/bin

     .Bd     '.Bd' '.Ed' '.Bd'

                  .Bd  [-offset ] [-compact]

             4  1 '.Bd'

            -ragged    ()
            -filled   () ()
            -literal

            -file    -file  8 troff/-mdoc
            -offset
                     -offset

                     left         '.Bd'
                     center
                     indent       '.D1'  2  6n  2/3  ( 6 )
                     indent-two   2
                     right        2  troff

     .Ed

      5

     .Em     '.Em'

                  : .Em argument ...
                          .Em does not   does not
                          .Em exceed 1024 .
                                         exceed 1024.
                          .Em vide infra ) ) ,
                                         vide infra)),

            '.Em' '.Em'

     .Li     '.Li'

                  : .Li argument ...
                          .Li \en    \n
                          .Li M1 M2 M3 ;
                                     M1 M2 M3;
                          .Li cntrl-D ) ,
                                     cntrl-D),
                          .Li 1024 ...
                                     1024 ...

            '.Li'

     .Sy

                  : .Sy symbol ...
                          .Sy Important Notice
                                             Important Notice

            '.Sy' '.Sy'

     .Bf     '.Bf' '.Ef' '.Bf'

                  .Bf

             3

            Em | -emphasis     '.Em'
            Li | -literal      '.Li'
            Sy | -symbolic     '.Sy'

     .Ef

      '.Bl' '.It' '.El'

      () (-tag) (-ohang) TeX tag '.Bl'

     -bullet
     -item
     -enum
      3 '.Bl' '.It'

                 .Bl -enum -compact
                 .It

                 .It

                 .It

                 .El

               1.
               2.
               3.

      bullet

                 .Bl -bullet -compact
                 .It
                  bullet
                 .It
                  bullet
                 .El

               +o    bullet
               +o    bullet

     -tag
     -diag
     -hang
     -ohang
     -inset
      '.It' inset hang ohang () tag '-ohang' '.It'  inset, hang, tag  inset

           tag tag  (tag ) Berkely

           diag ()  4 inset

           hang hang

           ohang ohang

           inset inset -mdoc

           .Bl -inset -offset indent
           .It Em tag
           tag  (tag )
           Berkely
           .It Em diag ()
            4
           inset
           .It Em hang
           hang
           .It Em ohang
           ohang
           .It Em inset
           inset
           .Nm -mdoc

           .El

      2  hang

           hang      tag

            hang   tag

           .Bl -hang -offset indent
           .It Em hang

            tag
           .It Em  hang
           tag

           .El

           SL       sleep  ()
           PAGEIN   I/O
           UID     ID
           PPID    ID ()

           .Bl -tag -width "PAGEIN" -compact -offset indent
           .It SL
            sleep  ()
           .It PAGEIN

           .Tn I/O

           .It UID
           ID
           .It PPID
           ID
           ()
           .El

           -width Fl      '.Fl'  10  5/6

           -width 24n     24  2 'n'

           -width ENAMETOOLONG

           -width "int mkfifo"

      '.It' '.It'

      troff '\*(xx' '\*x' xx x

                Nroff     Troff
           <=   <=        <=
           >=   >=        >=
           Rq   ''        ''
           Lq   ``        ``
           ua   ^         ^
           aa   '         '
           ga   `         `
           q    "         "
           Pi   pi        pi
           Ne   !=        !=
           Le   <=        <=
           Ge   >=        >=
           Lt   <         >
           Gt   >         <
           Pm   +-        +-
           If   infinity  infinity
           Na   NaN       NaN
           Ba   |         |

     : 'q' 1 '\*q'

     -mdoc (A ?)  troff 1  2 troff ditroff -mdoc 'Ar' 2  <><> 'aR'  <><> 'C1'
     <><> troff  2  1 '\&'

      '.Db' () '.Pp' () '.Db'

           : .Db [on | off]

      ( 'aC' '\&aC' )

           .Db on
           .Op Fl aC Ar file )
           .Db off

           DEBUGGING ON
           DEBUG(argv) MACRO: `.Op'  Line #: 2
                   Argc: 1  Argv: `Fl'  Length: 2
                   Space: `'  Class: Executable
                   Argc: 2  Argv: `aC'  Length: 2
                   Space: `'  Class: Executable
                   Argc: 3  Argv: `Ar'  Length: 2
                   Space: `'  Class: Executable
                   Argc: 4  Argv: `file'  Length: 4
                   Space: ` '  Class: String
                   Argc: 5  Argv: `)'  Length: 1
                   Space: ` '  Class: Closing Punctuation or suffix
                   MACRO REQUEST: .Op Fl aC Ar file )
           DEBUGGING OFF

      '.Op' ()  1 2 ('Fl')  2 () 3  aC  4 'aC'

           .Db on
           .Em An escaped \&aC
           .Db off

           DEBUGGING ON
           DEBUG(fargv) MACRO: `.Em'  Line #: 2
                   Argc: 1  Argv: `An'  Length: 2
                   Space: ` '  Class: String
                   Argc: 2  Argv: `escaped'  Length: 7
                   Space: ` '  Class: String
                   Argc: 3  Argv: `aC'  Length: 2
                   Space: ` '  Class: String
                   MACRO REQUEST: .Em An escaped &aC
           DEBUGGING OFF

     '\&'  0 '\&aC'  2 '\&aC'

GROFF, TROFF, NROFF

     -mdoc groff

      nroff -Tascii groff nroff /usr/src/share/tmac/doc-nroff  0 'cR'

     /usr/share/tmac/doc.tmac
     /usr/share/misc/mdoc.template
                                   man
     /usr/share/examples/mdoc/*    man

      3f

     '.Nm' NAME

     '.Fn'