mdoc.samples

中文man手册

è¿ä¸ª ç¤ºèæç¨ ç¨äº ç¼å BSD æåé¡µ (manual page), å® ä½¿ç¨äº -mdoc å®å®ä¹å, è¿æ¯ä¸ª åºäºåå®¹ å åºäºå®å (domain-base) ç æ ¼å¼åå, äº¤ç± troff(1) å¤ç. å®ç åèº« -man(7) å, å®ä¹äº é¡µé¢å¸å± (page layout), ä½æ¯ æ è¯¸å¦ åä½æ§å¶ å å¶ä» æç ç»è çç»äº æ¯ä¸ä¸ª ä½è. å¨ -mdoc åé, é¡µé¢å¸å±å® ææäº é¡µç»æå®å (page structure domain) å® ç± æ é¢, å°èé¦é¨, æ¾ç¤º (displays) å åè¡¨ å® ç»æ. è¿äº åºæ¬é¡¹ç® å½±å æ£æ å¨ æ ¼å¼åé¡µä¸ ç ç©çä½ç½®. ä½ä¸º é¡µç»æå®å ç è¡¥å, è¿é è¿ å®ä¹äº å¦å¤ ä¸¤ä¸ª å®å, æåå®å å åºæ¬æ£æå®å. åºæ¬æ£æå®å å®ä¹äº ä¸äº å®, æ§è¡ ä¾å¦ å¼æ æ æåå¼ºè° ä¹ç±»çä»»å¡. æåå®å å®ä¹çå® æ¯ éæ£å¼ æ¥å¸¸ç¨è¯ ç åé, ç¨äº æè¿° å½ä»¤, ä¾ç¨ å ç¸å³ç BSD æä»¶. æåå®åé ç å® ç¨æ¥å¤ç å½ä»¤å, å½ä»¤è¡åæ°åéé¡¹, å½æ°åç§°, å½æ°åæ°, è·¯å¾, åé, ä»¥å å° å¶ä»æåé¡µ ç åç§ ç. è¿äº åé¡¹ çæ ä¸º ä½è å æåé¡µç æªæ¥ç¨æ· è®¾ç½®ç å¼. å¸æ ä» æåéä¸ è·å¾ç ä¸è´æ§ è½å¤ä¸º å°æ¥ç ææ¡£å·¥å· æä¾ æ´ç®åç è½¬æ¢.

ä» æ´ä¸ªç Unix æåé¡µ ä¸ æ¥ç, æ¯ä¸ª æåé¡¹ å¯ä»¥ ç®åç çè§£ä¸º ä¸ä¸ª man page, ä¸ç¨ æ³¨æ å®ç å®éé¿åº¦, ä¹æ²¡æ æ§å«æ§è§ æå¾. (è¯æ³¨: å¯è½æ¯åå³è¯, man page...ç·äººé¡µ)

å¼å§ GETTING STARTED

TROFF ç¹æ§

æåé¡µçç»æåæ

æåé¡µçæ¨¡æ¿.

æ é¢å®.

æåå®åååºæ¬æ£æå®åçä»ç».

åç§°èå ....
åºæ¬è¯æ³.

æåå®å

å°å.
ä½èåå.
åæ°.
éç½®å£°æ (ä»ç¨äºæåç¬¬åé¨å).
å½ä»¤ä¿®é¥°.
å·²å®ä¹çåé.
Errno’s (ä»ç¨äºæåç¬¬äºé¨å).
ç¯å¢åé.
å½æ°åæ°.
å½æ°å£°æ.
æ å¿ (Flags).
å½æ° (åºä¾ç¨).
å½æ°ç±»å.
äº¤äºå½ä»¤.
åç§°.
éé¡¹.
è·¯å¾.
åé.
åç§.
6.

åºæ¬æ£æå®å

é¡µç»æå®å

å°èé¦é¨.
æ®µè½åç©ºè¡.
ä¿æ (Keeps).
æ¾ç¤º.
åä½æ¨¡å¼ (å é, åæå Symbolic).
åè¡¨åæ .

é¢å®ä¹ä¸²

è¯æ

10.

ç¨ GROFF, TROFF å NROFF æ ¼å¼å

11.

èè« BUGS

TROFF ç¹æ§

ä½¿ç¨ -mdoc å®å ç ç®ç æ¯ ç®å åæåé¡µ ç è¿ç¨. çè®ºä¸è®², è¦ä½¿ç¨ -mdoc ä¸ä¸å® è¦ å¦ä¹ troff(1) ç éèç»è; ç¶è, æäº éå¶ æ æ³åé¿, æå¥½ æå®ä»¬ æå¹³. èä¸ ä½ åºè¯¥ ç¥é, è¿ä¸ª å®å ç éåº¦ æ¯è¾ æ¢.

å®çç¨æ³ Macro Usage

[-s bytes]

æ¥èª .Op Fl s Ar bytes

[Fl s Ar bytes]

æ¥èª .Op \&Fl s \&Ar bytes

è¿éç åç¬¦ä¸² ‘Fl’ å ‘Ar’ æ²¡æ è¢«è§£éæ å®. å¨ è¿ç¯ææ¡£ å ç¸åºç å¿«éåèæå mdoc(7) ä¸, åæ°åè¡¨ æ å¯è°ç¨åæ° åæ ç å® ç§°ä¸º å·²åæ, å¯ä»¥ ä» åæ°åè¡¨ è°ç¨ ç å® ç§°ä¸º å¯è°ç¨. è¿é ç¨ç æ¯è¯ ’åæ’ å¯è½æ¯ä¸ª ææ¯å¤±è¯¯, å ä¹ ææç -mdoc å® é½ è¢«åæ, æ¢ ç¨å® æ å¯è°ç¨å®, å æ æ è°ç¨ å¶ä»å®ç è½å, æ¾å¾ å¾ç¬¨æ.

å¨åæ°ä¸ä¼ éç©ºæ ¼ç¬¦ Passing Space Characters in an Argument

éç½®å£°æ (æåç¬¬åé¨å “æ¦è¦ SYNOPSIS”)

åè¡¨å¼å§ (æå®å®½åº¦ç)

å éæå

å½æ° (æåç¬¬äº, åé¨å)

åè¡¨é¡¹

åæ

Symbolic text

ä¹¦é¢

æåå

åèéæ³¨

æ¥åé¢ç®(å¨åèæä»¶ä¸)

å¨ä¹¦ç±ææåä¸çé¢ç®

fetch(char *str)

æ¥èª ‘.Fn fetch char\ *str’

fetch(char *str)

ä¹å¯ä»¥æ¥èª ‘.Fn fetch "char *str"’

å¦æ å¿½ç¥ ‘\’ æ å¼å·, ‘.Fn’ å® ä¼è®¤ä¸º æ ä¸ä¸ªåæ°, ç»æ æä¸º:

fetch(char, *str)

å°¾é¨çç©ºç½ç¬¦ Trailing Blank Space Characters

Troff å¯è½ è¢« è¡å°¾ç ç©ºç½ç¬¦ æä¹±, å®çé²èè§å æ¯ æ¶é¤ ææ ä½äºè¡æ« ç ç©ºç½ç¬¦. å¦æ åæ å¨ è¡æ« å ä¸ ç©ºç½ç¬¦, å¯ä»¥ ç¨ ç¡¬ç©ºæ ¼ç¬¦ å ‘\&’ è½¬ä¹åç¬¦. ä¾å¦, ‘string\ \&’.

è½¬ä¹ç¹æ®åç¬¦ Escaping Special Characters

ç¹æ®åç¬¦, å¦ æ¢è¡ç¬¦ ‘\n’, æ¯ éè¿ ç¨ ‘\e’ æ¿æ¢ ‘\’ (e.g.ä¾å¦ ‘\en’) ä¿çä½ åææ .

æåé¡µç»æåæ THE ANATOMY OF A MAN PAGE

æåé¡µ å¯ä»¥ å¾å®¹æç éè¿ æ¨¡æ¿ æå»º, æ¨¡æ¿ æ¾å¨ /usr/share/misc/mdoc.template. å¦å¤ å¨ /usr/share/examples/mdoc ç®å½ä¸ æä¸äº æåé¡µ ç ä¾å.

æåé¡µçæ¨¡æ¿ A manual page template

.\" ææçæåé¡µé½è¦æ±æä¸é¢çåå®¹
.Dd æ æ¥, å¹´Month day, year
.Os æä½ç³»ç» [çæ¬/åè¡å·]
.Dt ææ¡£æ é¢ [æåèå·][å·]
.Sh åç§° NAME
.Nm åç§° name
.Nd å¯¹åç§°çç®åæè¿° one line description of name
.Sh æ»è§ SYNOPSIS
.Sh æè¿° DESCRIPTION
.\" åé¢çåå®¹åæ¶æ³¨éåå¯ä»¥ç¨å¨ä½ éè¦çä»»ä½å°æ¹.
.\" ç´§æ¥ççè¿æ¡å½ä»¤ç¨äºæåç¬¬äºåç¬¬ä¸é¨å, å½æ°çè¿åå¼.
.\" .Sh è¿åå¼ RETURN VALUES
.\" ä¸é¢çå½ä»¤ç¨äºæåç¬¬1, 6, 7, 8é¨å.
.\" .Sh ç¯å¢ ENVIRONMENT
.\" .Sh æä»¶ FILES
.\" .Sh ç¤ºä¾ EXAMPLES
.\" ä¸é¢çå½ä»¤ç¨äºæåç¬¬1, 6, 7, 8é¨å
.\" (å¨shellä¸çå½ä»¤è¿åå¼åæ åéè¯¯ç±»åçè¯æ)
.\" .Sh è¯æ DIAGNOSTICS
.\" ä¸é¢çå½ä»¤ç¨äºæåç¬¬äºåç¬¬ä¸é¨åä¸çéè¯¯åä¿¡å·å¤ç.
.\" .Sh éè¯¯ ERRORS
.\" .Sh å¦è§ SEE ALSO
.\" .Sh éµå¾ª CONFORMING TO
.\" .Sh åå² HISTORY
.\" .Sh ä½è AUTHORS
.\" .Sh BUGS

æ¨¡æ¿ä¸ ç ç¬¬ä¸ä¸ªé¨å æ¯ (.Dd, .Os, .Dt) å®; ææ¡£æ¥æ, æåæå¶åå®¹ éå¯¹ç æä½ç³»ç», æåé¡µçæ é¢ ((å¤§å)) å è¯¥æåé¡µ æå±çè (é¨åå·). è¿äºå® ç¡®è®¤åæ è¯äº è¿ä¸ªæåé¡µ. å¨ åé¢ç “æ é¢å® TITLE MACROS” å° ç»§ç» è®¨è®º.

è¿ä¸ª æ¨¡æ¿ä¸ ç å¶ä½é¨å æ¯ å°èé¦é¨ (section header) (.Sh); å¶ä¸ “åç§° NAME”, “æ»è§ SYNOPSIS” å “æè¿° DESCRIPTION” æ¯ å¿ä¸å¯å°ç. è¿äº é¦é¨ å¨ “é¡µç»æå®å” ä¸ è®¨è®º ( ä»ç»å® “æåå” ä¹å ) . æä¸äº åå®¹å® è¢«ç¨æ¥ ç¤ºè é¡µé¢å¸å±å®; å»ºè®® æ¥è§¦ é¡µé¢å¸å±å® å åçç åå®¹å®.

æ é¢å® TITLE MACROS

.Dt ææ¡£æ é¢ æååº# [å·]

ææ¡£æ é¢ æ¯ æåé¡µç ä¸»é¢, ç±äº troff ç éå¶, å¿é¡» å¤§å. æåèå· (é¨åå·) ä»äº 1, ..., 8, å¦æ ææäº æåèå·, å¯ä»¥ å¿½ç¥ å·æ . å·æ ç¨ ä¸å æ è¯ç ä¸ä¸ª æ ä»»æä¸ª:

	AMD	UNIX åå²éççæåææ¡£ Ancestral Manual Documents
	SMM	UNIX ç³»ç»ç®¡çåæå System Manager’s Manual
	URM	UNIX åèæå Reference Manual
	PRM	UNIX ç¨åºåæå Programmer’s Manual

ç¼ºççå·æ URM ä»£è¡¨ æååº 1, 6, and 7; SMM ä»£è¡¨ æååº 8; PRM ä»£è¡¨ æååº 2, 3, 4, and 5.

.Os æä½ç³»ç» åè¡å·#

æä½ç³»ç» ç åå å¯è½ æ¯ ç¼©å, å BSD æ FreeBSD æ ATT. åè¡å· åºè¯¥ æ¯ ç³»ç» ä¸ç¨ç æ ååè¡æ¯è¯, å 4.3, 4.3+Tahoe, V.3, V.4. è¯å«ä¸åºç åæ° å°± ç§åæ · æ¾ç¤ºå¨ é¡µè. ä¾å¦, å¸åçé¡µè å¯è½æ¯:

.Os BSD 4.3

.Os FreeBSD 2.2

æè è±¡ è®¢å¶çäº§å

.Os CS Department

ä½ä¸º ä¼¯åå©çç¼ºçè®¾ç½®, ä¸å¸¦ åæ° ç ‘.Os’ å®ä¹ä¸º BSD (æå®å¨æä»¶ /usr/share/tmac/mdoc/doc-common ä¸). ä½ åºè¯¥ æç¼ºçå¼ è®¾æ æ¬æº. æ³¨æ, å¦æ ä¸è®¾ç½® ‘.Os’ å®, é¡µé¢çå·¦ä¸è§ ä¼ å¾é¾ç.

.Dd æ æ¥, å¹´ (month day, year)

æ¥æ åºå½ åç æ£è§ç¹:

January 25, 1989

æåå®å å åºæ¬æ£æå®åçä»ç»

åç§°èå What’s in a name...

.Va argument1 argument2 ... argument9

filter [-flag] infile outfile

è¿éç filter æ¯ å½ä»¤åç§°, æ¹æ¬å¼§å ç -flag æ¯ä¸ä¸ª æ å¿ åæ°, ä½ä¸º å¯éåæ° æ¾å¨ ä»£è¡¨ éé¡¹ ç æ¹æ¬å¼§å. å¨ -mdoc æ¯è¯ ä¸, infile å outfile ç§°ä¸º åæ°. äº§ç ä¸è¿°ææ ç å® æ¯ è¿æ ·ç:

.Nm filter
.Op Fl flag
.Ar infile outfile

ç¬¬ä¸ç§ æåµ è®¨è®º å½ä»¤ åå¶è¯æ³, åæ¬ å®ä»¬çä¾å, å¯è½ è¿æ æ´å¤ç»è. ä¸é¢çä¾åé, å¯ä»¥æ infile å outfile çè§£ä¸º æä½åæ° operands æ æä»¶åæ° file arguments. æäº å½ä»¤è¡åæ° ç½åç åå é¿:

make

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

è¿é ä½ å¯è½ è®¨è®º make å½ä»¤ å å®çåæ° makefile, ä½ä¸º ä¸ä¸ª æ å¿çåæ°, -f, æè è®¨è®º ä¸ä¸ª å¯éçæä»¶æä½å¯¹è±¡ target. å¨ å·ä½çä¸ä¸æ ä¸, è¿ç§ç»è è½å¤ é²æ¢ æ··æ·. ç¶è -mdoc å®åä¸ æ²¡æä¸º æ å¿çåæ° åå¤ å®. ä½ä¸º æ¿ä»£ æ¯ ‘Ar’ åæ°å®, ç¨äº æè¿° æä½å¯¹è±¡ æ æä»¶åæ° å¦ target ä»¥å æ å¿çåæ° å¦ 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

å¨ “Keeps” å°èä¸ å°ä¼ è§£é ‘.Bk’ å ‘.Ek’ å®.

åºæ¬è¯æ³ General Syntax

æåå®å å åºæ¬æ£æå®å ç å® æç ç¸ä¼¼çè¯æ³, ä»æ å¾®å°å·®å«: ‘.Ar’, ‘.Fl’, ‘.Nm’, å ‘.Pa’ ä»å½ æ åæ°è°ç¨æ¶ ææ åºå«; ‘.Fn’ å ‘.Xr’ ç åæ°åè¡¨ è¦æ± ä¸å®ç é¡ºåº; ‘.Op’ å ‘.Fn’ å®æåµå¥éå¶. ææç åå®¹å® è½å¤ è¯å«åæ£ç¡®å¤ç æ ç¹ç¬¦å·, æ¯ä¸ª æ ç¹ç¬¦å· è¦å¨ åé¢ ç¨ ç©ºæ ¼ éå¼. å¦æ ç»åº è¿æ ·ç å®è¯·æ±:

.Li sptr, ptr),

ç»ææ¯:

sptr, ptr),

.Li sptr , ptr ) ,

ç»ææ¯:

sptr, ptr),

{+,-,/,*,%,<,>,<=,>=,=,==,&,‘,’,"}

æåå MANUAL DOMAIN

å°åå® Address Macro

å°åå® ç¨ è¿ç§ æ ¼å¼ æ æå°å: addr1[,addr2[,addr3]].

Usage: .Ad address ...

.Ad addr1

addr1

.Ad addr1 .

addr1.

.Ad addr1 , file2

addr1, file2

.Ad f1 , f2 , f3 :

f1, f2, f3:

.Ad addr ) ) ,

addr)),

ä½èåç§° Author Name

The ‘.An’ å®ç¨ä»¥ è¯´æ è¿ä¸ªææ¡£ç æè¿°å¯¹è±¡ç ä½è, æè è¿ç¯æåé¡µç ä½è. åå ä¿¡æ¯ åé¢ç å¶ä»åæ° è¢«è®¤ä¸ºæ¯ æ ç¹ç¬¦å·.

Usage: .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)),

åæ°å® Argument Macro

å½ å¼ç¨ å½ä»¤è¡åæ°æ¶ å¯ä»¥ä½¿ç¨ ‘.Ar’ åæ°å®.

Usage: .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’ å®å¯ä»¥è¢« (å¶ä»å®) åæåè°ç¨.

éç½®å®ä¹ (æåç¬¬åé¨å) Configuration Declaration

device le0 at scode?

æ¥èª: ‘.Cd device le0 at scode?’.

å½ä»¤ä¿®é¥° Command Modifier

å·²å®ä¹çåé Defined Variables

å¨ å¤´æä»¶ ä¸ å·²ç» å®ä¹äºçåé ç¨ ‘.Dv’ å®è¯´æ.

Usage: .Dv defined_variable ...

.Dv MAXHOSTNAMELEN

MAXHOSTNAMELEN

.Dv TIOCGPGRP )

TIOCGPGRP)

Errno’s (ä»ä¾æåç¬¬äºé¨å)

Usage: .Er ERRNOTYPE ...

.Er ENOENT

ENOENT

.Er ENOENT ) ;

ENOENT);

.Bq Er ENOTDIR

[ENOTDIR]

ç¯å¢åé Environment Variables

‘.Ev’ å®è¯´æä¸ä¸ªç¯å¢åé.

Usage: .Ev argument ...

.Ev DISPLAY

DISPLAY

.Ev PATH .

PATH.

.Ev PRINTER ) ) ,

PRINTER)),

å½æ°åæ° Function Argument

‘.Fa’ å® ç¨æ¥ è¯´æ å¨æåç “æ»è§ SYNOPSIS” å°è ä¹å¤ç å½æ°åæ°, æèå¨ “æ»è§ SYNOPSIS” å°èå, å¶ åæ°åè¡¨å¯¹ ‘.Fn’ å® èè¨ è¿é¿, å¹¶ä¸ å¿é¡» ä½¿ç¨ ‘.Fo’ å ‘.Fc’ å®æ¶. ‘.Fa’ ä¹ æå¯è½ ç¨æ¥ è¯´æ ç»ææå.

Usage: .Fa function_argument ...

.Fa d_namlen ) ) ,

d_namlen)),

.Fa iov_len

iov_len

å½æ°å£°æ Function Declaration

Usage: .Fd include_file (or defined variable)

æ å¿ Flags

‘.Fl’ å® å¤ç å½ä»¤è¡æ å¿. å® å¨ æ å¿å å ä¸ä¸ª çæ¨ªçº¿ ‘-’, å¯¹äº äº¤äºå½ä»¤ æ å¿, å® ä¸éè¦ çæ¨ªçº¿, å¯ä»¥ç¨ ‘.Cm’ (å½ä»¤ä¿®é¥° command modifier) å®æ¿æ¢, å® æ²¡æ çæ¨ªçº¿.

Usage: .Fl argument ...

.Fl

.Fl cfv

-cfv

.Fl cfv .

-cfv.

.Fl s v t

-s -v -t

.Fl - ,

--,

.Fl xyz ) ,

-xyz),

å¦æ ‘.Fl’ å® ä¸å¸¦ ä»»ä½ åæ°, å° åªäº§ç ä¸ä¸ª çæ¨ªçº¿, ä»£è¡¨ stdin/stdout. æ³¨æ å¦æ æ ä¸ä¸ª çæ¨ªçº¿ åä¸º ‘.Fl’ çåæ°, ç»æ ä¼ å¾å° ä¸¤ä¸ªçæ¨ªçº¿. ‘.Fl’ å®å¯ä»¥è¢« (å¶ä»å®) åæåè°ç¨.

å½æ°(åºå½æ°) Functions (library routines)

å® .Fn æ¯ ANSI C å½æ°é£æ ¼ ç æ¨¡å.

Usage: .Fn [type] function [[type] parameters ...

.Fn getchar

getchar()

.Fn strlen ) ,

strlen()),

.Fn "int align" "const * char *sptrs",

int align(const * char *sptrs),

å¯¹äº å«ä¸ª åæ° ä»¥ä¸ç å½æ° (å°½ç®¡å°è§), å¯ä»¥ ç¨ å® ‘.Fo’ (function open) å ‘.Fc’ (function close) éå ‘.Fa’ (function argument) å® ç ä½¿ç¨, çªç ´ åæ° è¿å¤ ç éå¶, ä¾å¦:

.Fo "int 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)

å½æ°ç±»å Function Type

è¿ä¸ªå® è®¾è®¡ ç¨å¨ “æ»è§ SYNOPSIS” å°è. å® å¯ä»¥ æ¯«æ å°é¾ç ç¨å¨ æåé¡µç å¶ä» å°æ¹, ä½ å®ç ä¸»è¦ ç®ç æ¯ ä¸º ç¬¬äº å ç¬¬ä¸é¨å æåé¡µç “æ»è§ SYNOPSIS” å°è, ä»¥ æ ¸å¿æ åå½¢å¼ (kernel normal form) æè¿° å½æ°ç±»å (å® å¯¼è´ æè¡, å¨ ä¸ä¸è¡ æ¾ç¤º å½æ° åç§°).

Usage: .Ft type ...

.Ft struct stat

struct stat

‘.Ft’ å®ä¸è½è¢«å¶ä»å®è°ç¨.

äº¤äºå½ä»¤ Interactive Commands

å® ‘.Ic’ ç¨äº è¯´æ äº¤äº æ åé¨å½ä»¤.

Usage: .Ic argument ...

.Ic :wq

:wq

.Ic do while {...}

do while {...}

.Ic setenv , unsetenv

setenv, unsetenv

åç§°å® Name Macro

Usage: .Nm argument ...

.Nm mdoc.sample

mdoc.sample

.Nm \-mdoc

-mdoc.

.Nm foo ) ) ,

foo)),

.Nm

‘.Nm’ å®å¯ä»¥è¢« (å¶ä»å®) åæåè°ç¨.

éé¡¹ Options

Usage: .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’ å¯ä»¥è¢« (å¶ä»å®) åæåè°ç¨.

è·¯å¾å Pathnames

‘.Pa’ å® ç¨äº æ ¼å¼å è·¯å¾ æ æä»¶å.

Usage: .Pa pathname

.Pa /usr/share

/usr/share

.Pa /tmp/fooXXXXX ) .

/tmp/fooXXXXX).

‘.Pa’ å®å¯ä»¥è¢« (å¶ä»å®) åæåè°ç¨.

åé Variables

åºæ¬ç åé åè:

Usage: .Va variable ...

.Va count

count

.Va settimer,

settimer,

.Va int *prt ) :

int *prt):

.Va char s ] ) ) ,

char s])),

æåé¡µåç§ Manual Page Cross References

‘.Xr’ å® æ ç¬¬ä¸ä¸ªåæ° å½å æåé¡µ åç§°, ç¬¬äºä¸ªåæ°, å¦æ åå¨, å½å æ ç¹ç¬¦å· æ æåé¡µ ç é¨åå· (èå·). å©ä¸ ææçåæ° è§å æ ç¹ç¬¦å·.

Usage: .Xr man_page [1,...,8]

.Xr mdoc

mdoc

.Xr mdoc ,

mdoc,

.Xr mdoc 7

mdoc(7)

.Xr mdoc 7 ) ) ,

mdoc(7))),

åºæ¬æ£æå®å GENERAL TEXT DOMAIN

AT&T å®

Usage: .At [v6 | v7 | 32v | V.1 | V.4] ...

.At

AT&T UNIX

.At v6 .

Version 6 AT&T UNIX.

BSD å®

Usage: .Bx [Version/release] ...

.Bx

BSD

.Bx 4.3 .

4.3BSD.

‘.Bx’ å®å¯ä»¥è¢« (å¶ä»å®) åæåè°ç¨.

FreeBSD å®

Usage: .Fx Version.release ...

.Fx 2.2 .

FreeBSD 2.2.

UNIX å®

Usage: .Ux ...

.Ux

Unix

‘.Ux’ å®å¯ä»¥è¢« (å¶ä»å®) åæåè°ç¨.

åµå¥åå¼ç¨å® Enclosure and Quoting Macros

Quote Close Open Function Result

.Aq	.Ac	.Ao	Angle Bracket Enclosure	<string>
.Bq	.Bc	.Bo	Bracket Enclosure	[string]
.Dq	.Dc	.Do	Double Quote	‘‘string’’
	.Ec	.Eo	Enclose String (in XX)	XXstringXX
.Pq	.Pc	.Po	Parenthesis Enclosure	(string)
.Ql			Quoted Literal	‘st’ or string
.Qq	.Qc	.Qo	Straight Double Quote	"string"
.Sq	.Sc	.So	Single Quote	‘string’

.Ec, .Eo

è¿äºå® ç ç¬¬ä¸ä¸ªåæ° æ¯ åèªç å¼å§åç»æä¸².

.Ql

åæå¼ç¨å® ç è¡¨ç°å¨ troff ä¸å nroff ä¸ä¸æ ·. å¦æç¨ nroff æ ¼å¼å, å¼ç¨çåæ å§ç» è¢«å¼ç¨. å¦æç¨ troff æ ¼å¼å, åªæ å®½åº¦ å°äº ä¸ä¸ªå®å®½åç¬¦ ç é¡¹ æè¢« å¼ç¨. This is to make short strings more visible where the font change to literal (constant width) is less noticeable. å½ åä½ åæ åæ(å®å®½) æ¶, çä¸²æ¾å¾æ´å®¹æè¢«çå°.

.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’

No-Op ææ£æå® or Normal Text Macro

æ ç©ºæ ¼å® Space Macro

.Op Fl I Ns Ar directory

äº§ç [-Idirectory]

æåé¡µå¯¹ç§åè Section Cross References

.Sx FILES

“FILES”

åèåå¼è¨ References and Citations

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. ä¸é¢çå® è¯å¾ éåº¦ç å¤ç åèèµæ. æå¥½æåµæ¶, è¿äºå® ä¾¿äº æå·¥ æå¥ ä¸æ®µ ç¸å³é£æ ¼ç åèèµæ.

.Rs

.Re

åèç»æ. å æå°åº åèä¿¡æ¯.

.%A

åèèµæ ç ä½èåå, ä¸æ¬¡ä¸ä¸ª.

.%B

ä¹¦å.

.%C

åå¸/å°ç¹.

.%D

æ¥æ.

.%J

æåå.

.%N

åè¡å·.

.%O

å¯éä¿¡æ¯.

.%P

é¡µç .

.%R

æ¥åå.

.%T

æç« é¢ç®.

.%V

å·.

ç¨ ‘%’ ç¬¦å· å¼å§ç å® ä¸è½è¢« (å¶ä»å®) è°ç¨, åªè½ è¢« trade name macro åæ, ç»æ è¿åç» è°ç¨è (æ¤æ¶ ç»æ ä¸å¤ªå¥½ é¢æµ). å¶ç®ç æ¯ åè®¸ trade name è½å¤ å¾å¥½ç æå°å¨ troff/ditroff ç è¾åºç«¯.

è¿åå¼ Return Values

‘.Rv’ å® äº§ç ä¸äº ç¨å¨ “è¿åå¼ RETURN VALUES” å°èç æå.

Usage: .Rv [-std function]

‘.Rv -std atexit’ å°è¾åº ä¸åæå:

.Rv -std atexit

è¿ä¸ª -std éé¡¹ ä»ç¨äº æåé¡µç ç¬¬äºåç¬¬ä¸é¨å.

Trade Names (æç¼©ç¥åç±»åå)

Usage: .Tn symbol ...

.Tn DEC

DEC

.Tn ASCII

ASCII

‘.Tn’ å®å¯ä»¥è¢« (å¶ä»å®) åæåè°ç¨.

æ©å±åæ° Extended Arguments

è¿éæ ‘.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’ (list-item) å® ç åæ°åè¡¨ ä¸ ä½¿ç¨äº ‘.Xo’ å®. æ©å±å® ä¸ç»å¸¸ ä½¿ç¨, ä¸è¬ç¨æ¥ æ©å± list-item å® ç åæ°åè¡¨. è¿ä¹ ä¸å¹¸ç æ¯ æ©å±å® æèå»ç å°æ¹. åä¸¤ä¸ªä¾åé ç©ºæ ¼ è¢«å»æ; ç¬¬ä¸ä¸ª ä¾åä¸, å¸æ è½ è¾åº é¨å ç©ºæ ¼, èä¸æ¯ å¨é¨. å¨ è¿ç§æåµä¸ ç¨ è¿äºå®, è¦ ç¡®ä¿ ‘.Xo’ å ‘.Xc’ å® ææ¾å° ç¬¬ä¸ä¸ªä¾å ä¸ ç¤ºèçä½ç½®. å¦æ ‘.Xo’ å® æ²¡æ åç¬ åºç°å¨ ‘.It’ ç åæ°è¡¨ ä¸, å æ æ³é¢æµ ç©ºæ ¼ æåµ. è¿ç§æåµä¸, ‘.Ns’ (no space macro) ä¸å® ä¸è½ ä½ä¸º ä¸è¡ç ç¬¬ä¸ä¸ªå® æ æåä¸ä¸ªå®. å½å BSD åå¸ç è¶è¿ 900ä¸ª æåé¡µ (äºå®ä¸å¤§çº¦1500ä¸ª) ä¸, åªæ åäºä¸ª ç¨å°äº ‘.Xo’ å®.

é¡µç»æå®å®å PAGE STRUCTURE DOMAIN

å°èé¦é¨ Section Headers

.Sh åç§° NAME

‘.Sh åç§° NAME’ å®æ¯ å¿ä¸å¯å°ç. å¦å æ æ³è®¾ç½® é¡µå¤´, é¡µè å ç¼ºçç é¡µå¸å±, æ ·å ä¼ å¾é¾ç. “åç§° NAME” å°è è³å° ç± ä¸é¡¹ ç»æ. ç¬¬ä¸ä¸ª æ¯ ‘.Nm’ åç§°å®, å½å æåé¡µç ä¸»é¢. ç¬¬äºä¸ª æ¯ åç§°æè¿°å® ‘.Nd’, å® æ ä¸»é¢åç§° å ç¬¬ä¸é¡¹, æè¿°, åç¦»å¼æ¥. æè¿° åºè¯¥ å°½å¯è½ç ç²¾ç®ææ, å°å ç©ºé´.

.Sh æ»è§ SYNOPSIS

“SYNOPSIS” æ»è§å°è æè¿° è¯¥ æåé¡µå¯¹è±¡ ç å¸åç¨é. è¯·æ±çå® æ¯ ä¸é¢ ç ä»»æä¸ä¸ª, ‘.Nm’, ‘.Cd’, ‘.Fn’, (ä¹å¯è½æ¯ ‘.Fo’, ‘.Fc’, ‘.Fd’, ‘.Ft’ å®). å½æ°åç§°å® ‘.Fn’ ç¨å¨ æåé¡µ ç ç¬¬äºç¬¬ä¸é¨å, å½ä»¤ å åºæ¬åç§°å® ‘.Nm’ ç¨å¨ æåé¡µ ç 1, 5, 6, 7, 8 é¨å. æå ç¬¬åé¨å éè¦ ‘.Nm’, ‘.Fd’ æ ‘.Cd’ éå¶è®¾å¤ç¨éå®. å¶ä»ä¸äº å® å¯è½ ç¨æ¥ äº§ç æ¦è¦è¡, è±¡ä¸é¢ç:

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

ä¸é¢ ç¨å°ç å®

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

æ³¨æ: å® ‘.Op’, ‘.Fl’, å ‘.Ar’ è½å¤ è¯å« ç®¡éç¬¦ ‘|’, å æ¤ å½ä»¤è¡ å¦:

.Op Fl a | Fl b

ç è¡¨ç° ä¼ åºè½¨. Troff ä¸è¬æ | å½å ç¹æ®ç¬¦å·. åè§ “é¢å®ä¹ä¸² PREDEFINED STRINGS”, å¨ å¶ä»æåµä¸ | çä½¿ç¨.

.Sh æè¿° DESCRIPTION

å¤§å¤æ° æåµä¸ “æè¿° DESCRIPTION” å°è ç ç¬¬ä¸æ®µè¯ æ¯ å³äº è¿ä¸ª å½ä»¤, å½æ° æ æä»¶ ç æè¦, åè· åå¸å¼ç éé¡¹ ä»¥å ç¸åºçè§£é. åå»º è¿æ ·ç åè¡¨, åºè¯¥ ä½¿ç¨ ‘.Bl’ åè¡¨å¼å§, ‘.It’ åè¡¨é¡¹å ‘.El’ åè¡¨ç»æå® (åè§ä¸é¢ç “åè¡¨åæ ç® Lists and Columns” ).

.Sh ç¯å¢ ENVIRONMENT

“ç¯å¢ ENVIRONMENT” å°è ç¨æ¥ æç¤º ç¸å³ç ç¯å¢åé å çº¿ç´¢, å®ä»¬ç è¡ä¸º, è¡¨ç°, ç¨æ³.

.Sh ç¤ºä¾ EXAMPLES

æ å¾å¤ åæ³ åå»º ç¤ºä¾, è¯¦è§ ä¸é¢ç “ç¤ºä¾ EXAMPLES” å°è.

.Sh æä»¶ FILES

ç± æåé¡µç ä¸»é¢å¯¹è±¡ åå»º æ ä½¿ç¨ ç æä»¶, åºè¯¥ éè¿ ‘.Pa’ å®å¨ “æä»¶ FILES” å°è éå åºæ¥.

.Sh å¦è§ SEE ALSO

å¦æ æå å¶ä» æåé¡µ æ åç§ ç¸åºç æå, åº æå®ä»¬ æ¾å¨ “å¦è§ SEE ALSO” å°è. åç§ä¸»é¢ ç± ‘.Xr’ å®æå®. å¨ “å¦è§ SEE ALSO” å°è ç åç§ä¸»é¢ åºè¯¥æ æåèå· æåº, æ åæ¯é¡ºåº éå, å¹¶ç¨ éå· éå¼, ä¾å¦:

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

è¿æ¶å ä¸å¤ªéå ç¨ refer(1) é£æ ¼ ç åèå¼ç¨.

.Sh éµå¾ª CONFORMING TO

å¦æ é£äº å½ä»¤, åºå½æ° æ æä»¶ éµå¾ª ä¸å®ç æ å å®ç°, å¦ IEEE Std 1003.2 (“POSIX.2”) æ ANSI X3.159-1989 (“ANSI C89”), é£å°± ä¸éè¦ è¿ä¸å°è. å¦æ å½ä»¤ ä¸ç¬¦å ä»»ä½æ å, åºè¯¥ æ å®çåå² æ¾å¨ “åå² HISTORY” å°è.

.Sh åå² HISTORY

.Sh ä½è AUTHORS

å¦æ æ å¿è¦, æ è´è°¢åå ä¹ åè¿å¿.

.Sh è¯æ DIAGNOSTICS

åºè¯¥ æ è¯æå½ä»¤ æ¾å¨ è¿ä¸è.

.Sh éè¯¯ ERRORS

.Sh BUGS

ææ¾ç é®é¢ æ¾è¿å¿...

.Sh PAGE STRUCTURE DOMAIN

.Pp

‘.Pp’ æ æ®µè½å½ä»¤ æ¾å¨ æéçä½ç½®, å¯ä»¥ äº§ç ä¸ä¸ªç©ºè¡. å¨ ‘.Sh’ æ ‘.Ss’ å® åé¢ ä¸éè¦ è¿ä¸ª å®, ‘.Bl’ å® ç åé¢ ä¹ä¸éè¦. ( ‘.Bl’ å£°æäº åç´æ¹å ç è·ç¦», é¤é ç»åº -compact æ å¿).

ä¿æ Keeps

ç®å åªå®ç°äº å¯¹åè¯ç ä¿æ è½å. è¿ä¸ªå® æ ‘.Bk’ (å¼å§ä¿æ begin-keep) å ‘.Ek’ (ç»æä¿æ end-keep ) . ‘.Bk’ å® ç å¯ä¸ åæ°æ¯ -words, ç¨äº é²æ¢ å¨ éé¡¹è¯å¥ ç ä¸é´ æè¡. å¨ make å½ä»¤è¡åæ°ç ä¾åé (åè§ “åç§°èå What’s in a name”), keep å®é²æ¢ nroff æ æ å¿ å åæ° åæ ä¸¤è¡. (äºå®ä¸ å¯ä»¥ ç¨ éé¡¹å® é²æ¢ æ¤ç±» äºæ, ä½ å½æä»¬ å³å® å¨ troff ä¸ ä½ä¸º åºæ¬éé¡¹, å¼ºå¶ å³è¾¹çå¯¹é½ æ¶, å® å¨ ç¨çè¡é å±å¼ç å¾ç³ç³. ä½¿ç¨ ä¿æå® æ¶ éè¦ å¤åç¹äº, å¢å ä¸ä¸ª -line éé¡¹ ) .

ç¤ºä¾åæ¾ç¤º

æ äºç§ç±»å ç æ¾ç¤º, ä¸ä¸ª å¿«éçåè¡ç¼©è¿æ¾ç¤º ‘.D1’, å¿«éçåè¡åææ¾ç¤º ‘.Dl’, åæå, å¡«åå, åç± ‘.Bd’ (begin-display) æ¾ç¤ºå¼å§ å ‘.Ed’ (end-display) æ¾ç¤ºç»æ å®å¯¹ ç»æç ä¸è§åå.

.D1

-ldghfstru

ä¸é¢æ¯è¿æ ·äº§çç: .Dl -ldghfstru.

.Dl

% ls -ldg /usr/local/bin

ä¸é¢æ¯è¿æ ·äº§çç .Dl % ls -ldg /usr/local/bin.

.Bd

æ¾ç¤ºå¼å§. ‘.Bd’ ç æ¾ç¤º å¿é¡»ç± ‘.Ed’ å® ç»æ. æ¾ç¤º å¯ä»¥ åµå¥å¨ æ¾ç¤º å åè¡¨ä¸. ‘.Bd’ æ è¿æ ·ç è¯æ³:

.Bd display-type [-offset offset_value] [-compact]

-ragged

-filled

æ¾ç¤º å¡«å (æ ¼å¼å) å. åä¸æå è¢« æ ¼å¼å (è¾¹ç å·²ç» å¡«åè¿, ä¸åæ¯ å·¦è¾¹ ä¸å¯¹é½ ).

-literal

-file file_name

éè¯» å¹¶ æ¾ç¤º è·å¨ -file æ å¿ åé¢ç æä»¶. åææ¨¡å¼ è¢«æå¼, table è®¾ä¸º 8ä¸ªåç¬¦ å®½, ç¶è æä»¶ä¸ åºç°ç ä»»ä½ troff/-mdoc å½ä»¤ é½å° è¢«å¤ç.

-offset string

left

æ£æå æ å½å å·¦è¾¹ç å¯¹é½, è¿æ¯ ‘.Bd’ ç ç¼ºçæ¨¡å¼.

center

indent

indent-two

right

.Ed

End-display. æ¾ç¤ºç»æ.

åä½æ¨¡å¼ Font Modes

ç°æ äºä¸ªå® ç¨äº æ¹å æåé¡µç æåå¤è§:

.Em

æå å¯ä»¥ ç¨ ‘.Em’ å® å éæå¼ºè°. å¸¸ç¨ç å¼ºè°åä½ æ¯ æä½ (italic).

Usage: .Em argument ...

.Em does not

does not

.Em exceed 1024 .

exceed 1024.

.Em vide infra ) ) ,

vide infra)),

.Li

‘.Li’ åæå® ç¨æ¥ æ¾ç¤º åç¬¦, åé, å¸¸æ°, ä»»ä½ å¸æ ç§ è¾å¥æå åæ ·æ¾ç¤º ç åå®¹.

Usage: .Li argument ...

.Li \en

.Li M1 M2 M3 ;

M1 M2 M3;

.Li cntrl-D ) ,

cntrl-D),

.Li 1024 ...

1024 ...

‘.Li’ å®å¯ä»¥è¢« (å¶ä»å®) åæåè°ç¨.

.Sy

Usage: .Sy symbol ...

.Sy Important Notice

Important Notice

.Bf

.Bf font-mode

åä½æ¨¡å¼ å¿é¡» æ¯ ä¸å ä¸ç§ ä¹ä¸: ‘.Bf’.

Em | -emphasis

å°±è±¡ æ¯ æ ‘.Em’ å® ç¨å¨ æ´ä¸ª æ£æå ä¸æ ·.

Li | -literal

å°±è±¡ æ¯ æ ‘.Li’ å® ç¨å¨ æ´ä¸ª æ£æå ä¸æ ·.

Sy | -symbolic

å°±è±¡ æ¯ æ ‘.Sy’ å® ç¨å¨ æ´ä¸ª æ£æå ä¸æ ·.

.Ef

åä½æ¨¡å¼ç»æ.

æ è®°æ ååè¡¨ Tagged Lists and Columns

å¦å¤ è¿å¯ä»¥ æå® åè¡¨å±æ§, åæ è®°å®½åº¦, åè¡¨åç§», ä»¥å ç´§åæ¨¡å¼ (åè®¸ æ ä¸åè®¸ è¡¨é¡¹é´ç ç©ºè¡) å¨æ¬æä¸ å¤§å¤ ä½¿ç¨äº æ è®°é£æ ¼ (tag style) ç åè¡¨ (-tag). ä½ä¸º æ¥è·åå, è¡¨ç¤º åè¡¨ç±»åç åè¡¨ç±»å æ¯ä¸ª çªåºæ¥ (overhanging) ç åè¡¨ (-ohang). è¿ç§ åè¡¨ç±»å å¨ TeX ç¨æ·ä¸ å¾æµè¡, ä½ çè¿ å¾å¤ é¡µ ç æ è®°åè¡¨ å å¯è½ä¼ è§å¾ æç¹ æ»ç¨½. ‘.Bl’ å® å¯ä»¥ æ¥å ä¸é¢ç åè¡¨ç±»å:

-bullet
-item
-enum

.Bl -enum -compact
.It
Item one goes here.
.It
And item two here.
.It
Lastly item three goes here.
.El

ç»ææ¯:

Item one goes here.

And item two here.

Lastly item three goes here.

ç®åçå¸åæ :

.Bl -bullet -compact
.It
Bullet one goes here.
.It
Bullet two here.
.El

äº§ç:

•

Bullet one goes here.

•

Bullet two here.

-tag
-diag
-hang
-ohang
-inset

è¿äº åè¡¨ç±»å æ¶é ‘.It’ å® æå®ç åæ°, å¹¶ä¸ åå»º ä¸ä¸ª æ ç¾, å® å¯è½ä¼ æå¥ inset åé¢ç æåä¸, æ¬æ (hanged) æ¾ç¤ºå¨ åé¢ç æåå, çªå (overhanged) æ¾ç¤ºå¨ æ´é« ä½ç½®, å¹¶ä¸ ä¸è½ ç¼©è¿ æ æ è®° tagged. è¿ä¸ª åè¡¨ ç± ‘-ohang’ åè¡¨ç±»å æå»º. ‘.It’ å® åªè½ è¢« æå¥ (inset), æ¬æ (hang), å æ è®°åè¡¨ç±»åå® åæ, ä¸ ä¸è½ è¢«è°ç¨.
è¿æ¯ ä¸ä¸ª æå¥æ ç¾ ç ä¾å:

Tag

The tagged list (also called a tagged paragraph) is the most common type of list used in the Berkeley manuals.

Diag

Diag lists create section four diagnostic lists and are similar to inset lists except callable macros are ignored.

Hang

Hanged labels are a matter of taste.

Ohang

Overhanging labels are nice when space is constrained.

Inset

Inset labels are useful for controlling blocks of paragraphs and are valuable for converting -mdoc manuals to other formats.

ä¸é¢æ¯ äº§ç è¿ä¸ªä¾å ç æºææ¬:

.Bl -inset -offset indent
.It Em Tag
The tagged list (also called a tagged paragraph) is the
most common type of list used in the Berkeley manuals.
.It Em Diag
Diag lists create section four diagnostic lists
and are similar to inset lists except callable
macros are ignored.
.It Em Hang
Hanged labels are a matter of taste.
.It Em Ohang
Overhanging labels are nice when space is constrained.
.It Em Inset
Inset labels are useful for controlling blocks of
paragraphs and are valuable for converting
.Nm -mdoc
manuals to other formats.
.El

è¿æ¯ å«æ ä¸¤ä¸ªè¡¨é¡¹ ç æ¬æåè¡¨:

Hanged

labels appear similar to tagged lists when the label is smaller than the label width.

Longer hanged list labels

blend in to the paragraph unlike tagged paragraph labels.

å®ä»¬ç æºææ¬ä¸º:

.Bl -hang -offset indent
.It Em Hanged
labels appear similar to tagged lists when the
label is smaller than the label width.
.It Em Longer hanged list labels
blend in to the paragraph unlike
tagged paragraph labels.
.El

sleep time of the process (seconds blocked)

PAGEIN

number of disk I/O’s resulting from references by the process to pages not loaded in core.

UID

numerical user-id of process owner

PPID

numerical id of parent of process process priority (non-positive when in non-interruptible wait)

æºææ¬æ¯:

.Bl -tag -width "PAGEIN" -compact -offset indent
.It SL
sleep time of the process (seconds blocked)
.It PAGEIN
number of disk
.Tn I/O Ns ’s
resulting from references
by the process to pages not loaded in core.
.It UID
numerical user-id of process owner
.It PPID
numerical id of parent of process process priority
(non-positive when in non-interruptible wait)
.El

å¯æ¥åç å®½åº¦è¯´æ:

-width Fl

æ å®½åº¦ è®¾ç½®ä¸º æ å¿ (flag) ç ç¼ºç å®½åº¦. ææ å¯è°ç¨ç å® é½æ ä¸ä¸ª ç¼ºç å®½åº¦å¼. ç®å ‘.Fl’ ç å¼ è®¾ä¸º åä¸ª åç¬¦å®½åº¦, å¤§çº¦ 5/6 è±å¯¸.

-width 24n

-width ENAMETOOLONG

è®¾ç½® å®½åº¦ä¸º æç»ä¸²ç é¿åº¦.

-width "int mkfifo"

åæ ·, è®¾ç½® å®½åº¦ä¸º æç»ä¸²ç é¿åº¦.

é¢å®ä¹ä¸² PREDEFINED STRINGS

String 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’ ç ä¸² åºè¯¥ åæ ‘\*q’, å ä¸º å® åªæ ä¸ä¸ªåç¬¦.

è¯æ DIAGNOSTICS

-mdoc ç é¤éç³»ç» æ¯è¾ æé, ä½æ¯ å¯ä»¥ å¸®å©ä½ æ£æµåº å¾®å¦ç éè¯¯, ä¾å¦ åæ°å å åé¨å¯åå¨ æ å®å å²çª. (æ¯ä»ä¹?) å¯åå¨ æ¯ troff ç ç®æ¯åå¨ç±», ç¨ ä¸å°äºä¸ªåç¬¦ å½å. -mdoc å¯¹ troff å ditroff èè¨, ææ -mdoc ç åé¨å¯åå¨ ç± ä¸¤ä¸ªåç¬¦ ç»æ, æ ¼å¼æ¯ <å¤§ååæ¯> <å°ååæ¯> å¦ ‘Ar’, <å°ååæ¯> <å¤§åå- æ¯> å¦ ‘aR’ æ <åæ¯> <æ°å> å¦ ‘C1’. ä½ä¸º ä¹±ä¸å ä¹±, troff æ å® èªå·±ç åé¨å¯åå¨, ç± ä¸¤ä¸ª å°ååæ¯ ç»æ, æè æ¯ ä¸ä¸ªç¹ å ä¸ ä¸ä¸ªåæ¯, æè æ¯ è½¬ä¹åç¬¦ (meta-character) å åç¬¦. å·²ç» ä»ç»è¿ç ç¤ºä¾ä¸ å±ç¤ºè¿ ææ ·ç¨ è½¬ä¹åºå ‘\&’ é²æ¢ è§£éå®. è¿åæ³ åæ · éç¨äº åé¨å¯åå¨å.

Usage: .Db [on | off]

å¨ è¿ä¸ª ç¤ºä¾ä¸, æä»¬æ ä»äº debug å® ä¹é´ ç ææ¬ ææ å¼åºç¹ éè¯¯ (æ å¿åæ° ‘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

.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

åæ° ‘\&aC’ è¡¨ç°åº åæ ·ç é¿åº¦2, è¿æ¯ å ä¸º ‘\&’ åºåç é¿åº¦ ä¸ºé¶, ä½æ¯ ä¸åå¨ å«å ‘\&aC’ ç å¯åå¨, å æ¤ å®çç±»å æ¯ åç¬¦ä¸².

å¶ä» è¯æåå®¹ æ¯ ä½¿ç¨æ¥åç, è½å¤ èªæè§£éç.

GROFF, TROFF AND NROFF

The -mdoc å®å ä¸éè¦ å groff ç å¼å®¹æ¨¡å¼.

ä¸ºäº ä¾¿äº å¨çº¿éè¯», è¿ä¸ªå®å é»æ¢äº åé¡µ, é¡µå¤´, é¡µè ä¹ç±» å¸¸å¸¸å¨ nroff ä¸ åºç°ç ä¸æ. æ¤æ¶ å³ä½¿å¨ æåé¡µ å°¾, groff (ååæ° -Tascii ) ä¹ ä¸ä¼ æç¤º ä»ä¹. å¯¹ åé¡µç é»æ¢ ä½¿å¾ nroff’d æä»¶ ä¸éå ç¡¬æ·è´ (hardcopy). æä¸ä¸ª åä¸º ‘cR’ ç å¯åå¨ å¯ä»¥ éè¿ å¨ æä»¶ /usr/src/share/tmac/doc-nroff (ä¾èµäºå®¿ä¸»ç³»ç») ä¸ç½®é¶, æ¢å¤ ä¼ ç»é£æ ¼.

ç¸å³æä»¶ FILES
/usr/share/tmac/tmac.doc

æåå®å

/usr/share/misc/mdoc.template

ç¼å æå ç æ¨¡æ¿

/usr/share/examples/mdoc/*

ä¸äº æåé¡µ ç ä¾å

å¦è§ SEE ALSO

man(1), troff(1), mdoc(7)

BUGS

ææ¡£ä¸ æ²¡æ å£°æ é¢å®ä¹ä¸².

è¿æ²¡æ æ 3f å°è å è¿ å¤´ä¾ç¨ (header routine) ä¸.

‘.Nm’ åä½ ä¸åºå½å¨ “NAME” å°è ä¸ æ¹å.

åè¡¨åæ¾ç¤ºå®ä¸åä»»ä½ä¿å, æ¾ç¶å®åºè¯¥åç.

[ä¸æçç»´æ¤äºº]

å¾æ <xuming@users.sourceforge.net>

[ä¸æçææ°æ´æ°]

2003/05/13

ãä¸å½Linuxè®ºåmanæåé¡µç¿»è¯è®¡åã

http://cmpp.linuxforum.net

è·

æ¬é¡µé¢ä¸æçç±ä¸æ man æåé¡µè®¡åæä¾ã
ä¸æ man æåé¡µè®¡åï¼https://github.com/man-pages-zh/manpages-zh Debian December 30, 1993 MDOC.SAMPLES(7)

手册导航

man1

man2

man3

man4

man5

man6

man7

man8

mdoc.samples

目录