MAN 7 1999-06-16

中文man手册

NAME man
总览 SYNOPSIS
描述 DESCRIPTION
导言 PREAMBLE
段 SECTIONS
开始，后跟标题名。如果标题包含空格并且和 .BR
在同一行，则需在标题上加双引号。传统的或建议的标题包括： NAME, 总览 SYNOPSIS, 描述 DESCRIPTION, 返回值 RETURN VALUE, 退出状态 EXIT STATUS, 错误处理 ERROR HANDLING, 错误 ERRORS, 选项 OPTIONS, 用法 USAGE, 示例 EXAMPLES, 文件 FILES, 环境 ENVIRONMENT, 诊断 DIAGNOSTICS, 安全 SECURITY, 遵循 CONFORMING TO, 注意 NOTES, BUGS, 作者 AUTHOR, 和参见 SEE ALSO. 在适合使用约定标题的地方，请使用它；这样做可以使文章更易读、易懂。不过，只要您的标题能够增加易懂性，请放心使用。唯一必须的标题是 .IR NAME , 他应是手册页的第一段，后面应紧跟对该命令的简单描述。比如： .RS .sp
NAME .br chess
字体 FONTS 虽然在 UNIX 世界中有各种对手册页（man pages)的不同约定，但在 linux 系统下存在一个字体的标准： .IP 对函数，其参数通常用下划线（或斜体）， .IR
其他宏命令和字符串 OTHER MACROS AND STRINGS
, 但是作为段中的字标题使用） .SS
安全子集 SAFE SUBSET
注意 NOTES
文件 FILES
BUGS .PP 大多数宏命令描述的是格式（比如：字体和空格）而不是内容描述（比如：这段文字指向另外一页），与 mdoc 和 DocBook 正好相反（HTML 也有比较多的内容描述）。这使得 .B man 难以转换为其他形式，不容易与其他文件组合或自动插入交叉引用。遵照以上的安全说明，就比较容易在将来把他转换为其他格式。 .LP The Sun macro .B TX 下不能用。 .SH
参见 SEE ALSO
[中文版维护人]
[中文版最新更新]
《中国linux论坛man手册翻译计划》:
跋

MAN

NAME
æ»è§ SYNOPSIS
æè¿° DESCRIPTION
å¯¼è¨ PREAMBLE
æ®µ SECTIONS
åä½ FONTS
å¶ä»å®å½ä»¤ååç¬¦ä¸² OTHER MACROS AND STRINGS
æ®éæ®µï¼æ ç¼©è¿ï¼ Normal Paragraphs
ç¸å¯¹ç¼©è¿ Relative Margin Indent
ç¼©è¿ Indented Paragraph Macros
è¶ææ¬é¾æ¥å® Hypertext Link Macros
æé¡¹å® Miscellaneous Macros
é¢å®ä¹åç¬¦ä¸² Predefined Strings
å®å¨åé SAFE SUBSET
æ³¨æ NOTES
æä»¶ FILES
BUGS
ä½è AUTHOR S
åè§ SEE ALSO
[ä¸æçç»´æ¤äºº]
[ä¸æçææ°æ´æ°]
ãä¸å½linuxè®ºåmanæåç¿»è¯è®¡åã:
è·

NAME

man - æ ¼å¼åæåé¡µçå®

æ»è§ SYNOPSIS

groff -Tascii -man file ...

groff -Tps -man file ...

man [section] title

æè¿° DESCRIPTION

æ³¨æ NET-2 BSD mdoc æåé¡µä¹å¯ä»¥ä½¿ç¨ groff å¤çï¼åªè¦æå® -mdoc éé¡¹èä¸æ¯ -man éé¡¹ãæ¨èä½¿ç¨ -mandoc éé¡¹ï¼å ä¸ºè¿æ ·ä¼èªå¨å¤æ- åºå½ä½¿ç¨åªä¸ä¸ªã

å¯¼è¨ PREAMBLE

ä¸ç¯æåé¡µçç¬¬ä¸ä¸ªå½ä»¤ (æ³¨éè¡ä¹å) åºå½æ¯

.TH title section date source manual,

è¿éï¼

	title		æåé¡µçæ é¢ (ä¾å¦ï¼ MAN).
	section		æåé¡µçç« èå·åºå½æ¾å¨è¿é (ä¾å¦ï¼ 7).
	date		æåä¿®æ¹æ¥æ -- è®°ä½è¦å¨æ¯æ¬¡ä¿®æ¹è¿æ¤æåé¡µä¹åä¿®æ¹å®ï¼ è¿æ ·å¯ä»¥æ¹ä¾¿å°è¿è¡çæ¬æ§å¶
	source		å½ä»¤çæ¥æº

å¯¹äºäºè¿å¶æä»¶ï¼ä½¿ç¨è¿æ ·çè¡¨è¿°ï¼ GNU, NET-2, SLS Distribution, MCC Distribution.

å¯¹äºåºè°ç¨ï¼ä½¿ç¨å½æ°çæ¥æºæ¥è¡¨è¿°ï¼ GNU, BSD 4.3, Linux DLL 4.4.1.

manual

æåçæ é¢ (ä¾å¦ï¼ Linux Programmer’s Manual).

æ³¨æ BSD mdoc æ ¼å¼çæåé¡µä»¥ Dd å½ä»¤å¼å§ï¼èä¸æ¯ TH å½ä»¤

æåç« èä¼ ç»ä¸å¦ä¸å®ä¹ï¼

1 Commands

ç¨æ·å¯ä» shell è¿è¡çå½ä»¤

2 System calls

å¿é¡»ç±åæ ¸å®æçåè½

3 Library calls

å¤§å¤æ° libc å½æ°ï¼ä¾å¦ qsort(3))

4 Special files

/dev) ç®å½ä¸çæä»¶

5 File formats and conventions

/etc/passwd çäººç±»å¯è¯»çæä»¶çæ ¼å¼è¯´æ

6 Games

7 Macro packages and conventions

8 System management commands

ç±»ä¼¼ mount(8) çå½ä»¤ï¼å¤§é¨ååªè½ç± root æ§è¡

9 Kernel routines

æ®µ SECTIONS

æ®µä»¥ .SH å¼å§ï¼åè·æ é¢åãå¦ææ é¢åå«ç©ºæ ¼å¹¶ä¸å .SH å¨åä¸è¡ï¼åéå¨æ é¢ä¸å åå¼å·ã ä¼ ç»çæå»ºè®®çæ é¢åæ¬ï¼ NAME, æ»è§ SYNOPSIS, æè¿° DESCRIPTION, è¿åå¼ RETURN VALUE, éåºç¶æ EXIT STATUS, éè¯¯å¤ç ERROR HANDLING, éè¯¯ ERRORS, éé¡¹ OPTIONS, ç¨æ³ USAGE, ç¤ºä¾ EXAMPLES, æä»¶ FILES, ç¯å¢ ENVIRONMENT, è¯æ DIAGNOSTICS, å®å¨ SECURITY, éµå¾ª CONFORMING TO, æ³¨æ NOTES, BUGS, ä½è AUTHOR, å åè§ SEE ALSO. å¨éåä½¿ç¨çº¦å®æ é¢çå°æ¹ï¼è¯·ä½¿ç¨å®ï¼ è¿æ ·åå¯ä»¥ä½¿æç« æ´æè¯»ãææã ä¸è¿ï¼åªè¦æ¨çæ é¢è½å¤å¢å æææ§ï¼è¯·æ¾å¿ä½¿ç¨ã å¯ä¸å¿é¡»çæ é¢æ¯ NAME, ä»åºæ¯æåé¡µçç¬¬ä¸æ®µï¼åé¢åºç´§è·å¯¹è¯¥å½ä»¤çç®åæè¿°ãæ¯å¦ï¼

.SH NAME
chess \- the game of chess

è¯·ä¸å®è¦æç§è¿ä¸ªæ ¼å¼æ¥åï¼æ³¨æå¨çæ¨ªçº¿ (dash ‘-’) åè¦æä¸ªææ (slash ‘´). è¿ç§è¯æ³ç»æå¨ makewhatis(8) ç¨åºä¸º whatis(1) å apropos(1) å½ä»¤å»ºç«ç®çå½ä»¤æè¿°æ¶è¦ç¨å°ã

å¶ä»çº¦å®æ®µçåå®¹åºä¸ºï¼

æ»è§ SYNOPSIS

æè¿° DESCRIPTION

è¿åå¼ RETURN VALUE

ååºç¨åºæå½æ°ä¼è¿åçå¼ï¼æåºå¼åè¿åå¼çæ¡ä»¶æåå ã

éåºç¶æ EXIT STATUS

ååºå¯è½çéåºç¶æçå¼ï¼æåºå¼èµ·è¿åçç¨åºæåå ã

	éé¡¹ OPTIONS		æåºç¨åºå¯ç¨çéé¡¹ï¼åå¶ä½ç¨ã
	ç¨æ³ USAGE		æè¿°ç¨åºçè¾é«çº§çä½¿ç¨æ¹æ³ã

ç¤ºä¾ EXAMPLES

provides one or more examples describing how this function, file or command is used.

æä»¶ FILES

ç¯å¢ ENVIRONMENT

ååºå½±åä½ çç¨åºçææç¯å¢åéï¼å¹¶è¯´æå½±åçåå ã

è¯æ DIAGNOSTICS

å®å¨ SECURITY

éµå¾ª CONFORMING TO

æè¿°å®å®ç°çä»»ä½æ åæçº¦å®

	æ³¨æ NOTES		æä¾æé¡¹æ³¨æäºé¡¹
	BUGS		ååºå±éãå·²ç¥çç¼ºç¹æä¸ä¾¿ä¹å¤ï¼è¿æå¶ä»å¯è½åå¨çé®é¢ã
	ä½è AUTHOR		ååºç¨åºææä»¶ä½èï¼èç³»åæ³çã
	åè§ SEE ALSO		ä»¥åæ¯é¡ºåºååºç¸å³çæåé¡µï¼man pages)ãéå¸¸æ¥è®²ï¼è¿æ¯ä¸ä¸ªæåé¡µçæåä¸æ®µã

åä½ FONTS

å¯¹å½æ°ï¼å¶åæ°éå¸¸ç¨ä¸åçº¿ï¼ææä½ï¼ï¼ å¨æ»è§ï¼SYNOPSIS)ä¸- ä¹æ¯è¿æ · ï¼å¶ä»é¨åç¨é»ä½ã ä¾å¦
int myfunction(int argc, char **argv);

æä»¶åç¨ä¸åçº¿ï¼ææä½ï¼ï¼ä¾å¦ï¼.IR "/usr/include/stdio.h" ), ä½å¨æ»è§ï¼SYNOPSIS)ä¸ï¼åå«çæä»¶ç¨é»ä½ï¼ä¾å¦ #include <stdio.h>).

ä¸ç¨å®ï¼ä¸è¬å¤§åè¡¨ç¤ºï¼ç¨é»ä½ï¼å¦ï¼ MAXINT).

	.B		é»ä½
	.BI		é»ä½åä¸åçº¿ï¼ææä½ï¼äº¤æ¿ï¼æè¿°å½æ°æ¶éå¸¸æç¨ï¼
	.BR		é»ä½åæ®éä½äº¤æ¿ï¼æè¿°å¼ç¨æ¶éå¸¸æç¨ï¼
	.I		ä¸åçº¿ï¼ææä½ï¼
	.IB		ä¸åçº¿ï¼ææä½ï¼åé»ä½äº¤æ¿
	.IR		æ®éä½åä¸åçº¿ï¼ææä½ï¼äº¤æ¿
	.RB		æ®éä½åä¸åçº¿ï¼ææä½ï¼äº¤æ¿
	.RI		å°å·ååé»ä½äº¤æ¿
	.SB		å°å·ååé»ä½äº¤æ¿
	.SM		å°å·åï¼ç¨äºç¼©åï¼

å¶ä»å®å½ä»¤ååç¬¦ä¸² OTHER MACROS AND STRINGS

æ®éæ®µï¼æ ç¼©è¿ï¼ Normal Paragraphs

	.LP		ä¸ .PP ç¸åï¼å¼å§ä¸ä¸ªæ°æ®µï¼
	.P		ä¸ .PP ç¸åï¼å¼å§ä¸ä¸ªæ°æ®µï¼
	.PP		å¼å§ä¸ä¸ªæ°æ®µï¼éç½®âæµè¡ç¼©è¿âå¼ã

ç¸å¯¹ç¼©è¿ Relative Margin Indent

.RS i

å¼å§ç¸å¯¹ç¼©è¿ -- æå·¦è¾¹çå³ç§» i

.RE

ç»æç¸å¯¹ç¼©è¿åæ¶æâæµè¡ç¼©è¿âæ¢å¤åå¼ã

ç¼©è¿ Indented Paragraph Macros

	.HP i		å¼å§æ¬æå¼ç¼©è¿ï¼æ®µçç¬¬ä¸è¡ä»å·¦è¾¹æå¼æ¶ï¼å¶ä½ç¼©è¿æ¾ç¤ºï¼
	.IP x i		å¨æ®µä¸æ ç¾ x ãå¦æä¸æå® x ï¼åæ´ä¸ªæ®µç¼©è¿ i ãå¦ææå®äº x ï¼å x ä¹åçæ®µä¸ç¼©è¿ï¼ä¹åçæ®µç¼©è¿ï¼æäºè±¡ .TP ï¼ä¸è¿ x æ¯è·å¨å½ä»¤åé¢èä¸æ¯å¨ä¸ä¸è¡ï¼ã å¦æ x å¤ªé¿ï¼åé¢çææ¬ä¼æªå°ä¸ä¸è¡ï¼ææ¬ä¸ä¼ä¸¢ å¤±æå²æï¼ã

åå¬ååè¡¨ï¼å¯ä»¥ç¨ \(bu (bullet) æ \(em (em dash). è¦ç¨æ°åæåæ¯åè¡¨, å¯ä»¥ç¨.IP 1. æ .IP A. è¿æ ·è½¬æ¢æå¶ä» æ ¼å¼å°±ç®åäºã

.TP i

è¶ææ¬é¾æ¥å® Hypertext Link Macros

.UR u

	.UE		ç»æç¸åºç UR è¶çº§é¾æ¥ãè½¬æ¢ä¸ºHTMLåæ¯ </A>.
	.UN u		ç»è¶çº§èæ¥æå®åç§°ä¸º u; ä¸éè¦ä»¥ UE UE ç»æãè½¬æ¢ä¸º HTML åä¸ºï¼ <A NAME="u" id="u"> </A> (the   is optional if support for Mosaic is unneeded).

æé¡¹å® Miscellaneous Macros

	.DT		éç½® tab å¼ä¸ºç¼ºç(æ¯ä¸ä¸ª0.5è±å¯¸)ãä¸å¼èµ·ä¸æã
	.IX ...		æå¥ç´¢å¼ä¿¡æ¯ï¼æ¹ä¾¿æç´¢ç³»ç»å·¥ä½ï¼ææå°ç´¢å¼åè¡¨ï¼ã å¨é¡µä¸- ç´¢å¼ä¿¡æ¯ä¸è½æ£å¸¸æ¾ç¤ºã å¦æåªæä¸ä¸ªåæ°ï¼ åæ°ä½ä¸ºç¬ç«çç´¢å¼é¡¹æåæåé¡µçåå®¹ã å¦ææä¸¤ä¸ªåæ°ï¼ä»å¯è½æ¯ Perl æåé¡µæ ¼å¼ï¼ ç¬¬ä¸ä¸ªåæ°æå®ç±»åå ï¼å½ä»¤åï¼æ é¢ ï¼é¢å¤´ï¼åæ®µè´§æºç´ ä¹ä¸ï¼ï¼ ç¬¬äºä¸ªåæ°ææèªå·±çç´¢å¼åã å¦å¤ï¼é¿ç´¢å¼å½¢å¼ï¼æ¯ä¸ªåæ°æ¯ä¸ä¸ªç´¢å¼é¡¹ï¼ æ¬¡çº§ç´¢å¼é¡¹ï¼åæ¬¡çº§ç´¢å¼é¡¹ï¼ççç´å°ä»¥ç©ºåæ°ç»æï¼ ç¶åæ¯ç¨åºååæ°ï¼\mï¼è¿æä¸å°æ®µæè¿°ã è¿å¯è½å¨è·ä¸ä¸ä¸ªç©ºåæ°ï¼æå¯è½æ¯é¡µæ§å¶ä¿¡æ¯ ï¼å¦ï¼ PAGE START)ãä¸¾ä¾å¦ä¸ï¼ "programmingtools""make""""make— build programs".
	.PD d		å¨æ®µä¸é´åç´è·ç¦»ç©ºå¼ d (å¦æä¸æå®ï¼åç¼ºçä¸º d=0.4v)ï¼ä¸å¼èµ·ä¸æã
	.SS t		åæ é¢ t è±¡æ¯ .SH, ä½æ¯ä½ä¸ºæ®µä¸çåæ é¢ä½¿ç¨ï¼

é¢å®ä¹åç¬¦ä¸² Predefined Strings

man é¢å®ä¹äºä¸ååç¬¦ä¸²

	\*R		æ³¨åç¬¦å·: ®
	\*S		æ¹åæç¼ºçåä½å¤§å°
	\*(Tm		åæ ç¬¦å·: ™
	\*(lq		å·¦åå¼å·: “
	\*(rq		å³åå¼å·: ”

å®å¨åé SAFE SUBSET

ä½ è¿å¯è½ä½¿ç¨ troff è½¬ä¹åç¬¦ï¼è¿äºè½¬ç§»ç¬¦å·ä»¥ \ å¼å§ï¼ã ä½ä½ è¦å¨ææ¬ä¸æ¾ç¤ºåæçº¿æ¶ï¼ç¨\eã å¶ä»è½¬ä¹åç¬¦åæ¬ï¼ \’, \‘, \-, \., \", \%, \*x, \*(xx, \(xx, \$N, \nx, \n(xx, \fx, å \f(xx. å¶ä¸ xãxx æ¯ä»»æåç¬¦ï¼N æ¯ä»»ææ°åä¸è¦ä½¿ç¨è½¬ä¹åç¬¦æ¥ç»å¾ã

ä¸è¦éæä½¿ç¨ bp ï¼break page(ä¸æé¡µï¼ï¼ã sp ï¼vertical space(åç´è·ç¦»ï¼åªåºä½¿ç¨æ£å¼ã ä¸è¦ç¨ (de) ï¼defineï¼å®ä¹ï¼å®ä¹ä¸ç°æçå®ååçå®ï¼æ è®º man æ mdoc)ï¼ è¿ç§éæ°å®ä¹å¯è½ä¼è¢«å¿½ç¥ã æ¯ä¸ªæ£ç¼©è¿ (in) åºå¯¹åºä¸ä¸ªè´ç¼©è¿ï¼å³ä½¿å¨ä½¿ç¨ RS å RE æ¯ä¹ä¸ä¾å¤ï¼ã The condition test (if,ie) should only have ’t’ or ’n’ as the condition. å¯ä»¥ä½¿ç¨çåªæå¯å¿½ç¥çè½¬æ¢ (tr). æ¹ååä½å½ä»¤ (ft å \f è½¬ä¹åºå) åªè½å¸¦å¦ä¸åæ°ï¼ 1, 2, 3, 4, R, I, B, P, or CW (ft å½ä»¤ä¹å¯ä»¥ä¸å¸¦åæ°)ã

æ³¨æ NOTES

Tools processing these files should open the file and examine the first non-whitespace character. ä»¥(.)æï¼’)å¼å§ä¸è¡ï¼è¡¨ææ¯åºäº troff çæä»¶ï¼å¦ï¼ man æ mdoc)ã å¦ææ¯ï¼<ï¼è¡¨æåºäº SGML/XML (å¦ï¼HTML æ Docbook)ï¼ å¶ä»å¯è½æ¯çº¯ææ¬ã(ä¾å¦ "catman" çç»æ)

	e		eqn(1)
	g		grap(1)
	p		pic(1)
	r		refer(1)
	t		tbl(1)
	v		vgrind(1)

æä»¶ FILES

/usr/share/groff/[*/]tmac/tmac.an
/usr/man/whatis

BUGS

The Sun macro TX ä¸ä¸è½ç¨ã

ä½è AUTHOR S

	—		James Clark (jjc@jclark.com) wrote the implementation of the macro package.
	—		Rickard E. Faith (faith@cs.unc.edu) wrote the initial version of this manual page.
	—		Jens Schweikhardt (schweikh@noc.fdn.de) wrote the Linux Man-Page Mini-HOWTO (which influenced this manual page).
	—		David A. Wheeler (dwheeler@ida.org) heavily modified this manual page, such as adding detailed information on sections and macros.

åè§ SEE ALSO

apropos(1), groff(1), man(1), man2html(1), mdoc(7), mdoc.samples(7), whatis(1)

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

RedCandle <redcandle51@chinaren.com>

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

2003.11.25

ãä¸å½linuxè®ºåmanæåç¿»è¯è®¡åã:

http://cmpp.linuxforum.net

è·

æ¬é¡µé¢ä¸æçç±ä¸æ man æåé¡µè®¡åæä¾ã
ä¸æ man æåé¡µè®¡åï¼https://github.com/man-pages-zh/manpages-zh

手册导航

man1

man2

man3

man4

man5

man6

man7

man8