WebSVN – planix.SVN – Blame – /os/branches/planix-v0/sys/man/6/ms

Rev	Author	Line No.	Line
2	-	1	`.TH MS 6`
		2	`.hc %`
		3	`.SH NAME`
		4	`ms \- macros for formatting manuscripts`
		5	`.SH SYNOPSIS`
		6	`.B "nroff -ms"`
		7	`[`
		8	`.I options`
		9	`]`
		10	`.I file ...`
		11	`.br`
		12	`.B "troff -ms"`
		13	`[`
		14	`.I options`
		15	`]`
		16	`.I file ...`
		17	`.SH DESCRIPTION`
		18	`This package of`
		19	`.I nroff`
		20	`and`
		21	`.IR troff (1)`
		22	`macro definitions provides a canned formatting`
		23	`facility for tech%nical papers in various formats.`
		24	`.PP`
		25	`The macro requests are defined below.`
		26	`Many`
		27	`.I nroff`
		28	`and`
		29	`.I troff`
		30	`requests are unsafe in conjunction with`
		31	`this package, but the following requests may be used with`
		32	`impunity after the first`
		33	`.BR .PP :`
		34	`.LR .bp ,`
		35	`.LR .br ,`
		36	`.LR .sp ,`
		37	`.LR .ls ,`
		38	`.LR .na .`
		39	`.PP`
		40	`Output of the`
		41	`.IR eqn (1),`
		42	`.IR tbl (1),`
		43	`.IR pic (1)`
		44	`and`
		45	`.IR grap (1)`
		46	`preprocessors`
		47	`for equations, tables, pictures, and graphs is acceptable as input.`
		48	`.SH FILES`
		49	`.B /sys/lib/tmac/tmac.s`
		50	`.SH "SEE ALSO"`
		51	`.br`
		52	`M. E. Lesk,`
		53	``Typing Documents on the UNIX System: Using the \-ms Macros with Troff and Nroff'',
		54	`.I`
		55	`Unix Research System Programmer's Manual,`
		56	`Tenth Edition, Volume 2.`
		57	`.br`
		58	`.IR eqn (1),`
		59	`.IR troff (1),`
		60	`.IR tbl (1),`
		61	`.IR pic (1)`
		62	`.SH REQUESTS`
		63	`.ta \w'.\fL.CW \fIx y z\fR 'u +\w'Initial 'u +\w'Cause 'u`
		64	`.br`
		65	`.di x`
		66	`\ka`
		67	`.br`
		68	`.di`
		69	`.in \nau`
		70	`.ti0`
		71	`Request Initial Cause Explanation`
		72	`.ti0`
		73	`Value Break`
		74	`.br`
		75	`.in \nau`
		76	`.ti0`
		77	`\fL\&.1C\fP yes yes One column format on a new page.`
		78	`.ti0`
		79	`\fL\&.2C\fP no yes Two column format.`
		80	`.ti0`
		81	`\fL\&.AB\fP no yes Begin abstract.`
		82	`.ti0`
		83	`\fL\&.AE\fP - yes End abstract.`
		84	`.ti0`
		85	`\fL\&.AI\fP no yes Author's institution follows.`
		86	`Suppressed in`
		87	`.BR .TM .`
		88	`.ti0`
		89	\fL\&.AT\fP no yes Print `Attached' and turn off line filling.
		90	`.ti0`
		91	`\fL\&.AU\fP\fP\fP \fIx y\fR no yes Author's name follows.`
		92	`.IR x " is location and " y " is"`
		93	`extension, ignored except in`
		94	`.BR TM .`
		95	`.ti0`
		96	`\fL\&.B\fP \fIx y z\fR no no Print`
		97	`.I x`
		98	`in boldface, append roman`
		99	`.I y`
		100	`and preface with`
		101	`.IR z ;`
		102	`if no argument switch to boldface.`
		103	`.ti0`
		104	`\fL\&.B1\fP no yes Begin text to be enclosed in a box.`
		105	`.ti0`
		106	`\fL\&.B2\fP no yes End boxed text.`
		107	`.ti0`
		108	`\fL\&.BI\fP \fIx y z\fR no no Print`
		109	`.I x`
		110	`in bold italic, append roman`
		111	`.I y`
		112	`and preface with`
		113	`.IR z ;`
		114	`if no argument switch to bold italic.`
		115	`.ti0`
		116	`\fL\&.BT\fP date no Bottom title, automatically invoked at`
		117	`foot of page.`
		118	`May be redefined.`
		119	`.ti0`
		120	`\fL\&.BX\fP \fIx\fR no no Print`
		121	`.I x`
		122	`in a box.`
		123	`.ti0`
		124	`\fL\&.CW\fP \fIx y z\fR no no Constant width font for`
		125	`.IR x ,`
		126	`append roman`
		127	`.I y`
		128	`and preface with`
		129	`.IR z ;`
		130	`if no argument switch to constant width.`
		131	`.ti0`
		132	\fL\&.CT\fP no yes Print `Copies to' and turn off line filling.
		133	`.ti0`
		134	\fL\&.DA\fP \fIx\fR nroff no `Date line' at bottom of page
		135	`is`
		136	`.IR x .`
		137	`Default is today.`
		138	`.ti0`
		139	`\fL\&.DE\fP - yes End displayed text.`
		140	`Implies`
		141	`.BR .KE .`
		142	`.ti0`
		143	`\fL\&.DS\fP \fIx\fR no yes Start of displayed text,`
		144	`to appear verbatim line-by-line:`
		145	`.L I`
		146	`indented (default),`
		147	`.L L`
		148	`left-justified,`
		149	`.L C`
		150	`centered,`
		151	`.L B`
		152	`(block) centered with straight left margin.`
		153	`Implies`
		154	`.BR .KS .`
		155	`.ti0`
		156	\fL\&.EG\fP no - Print document in BTL format for `Engineer's Notes.' Must be first.
		157	`.ti0`
		158	`\fL\&.EN\fP - yes Space after equation`
		159	`produced by`
		160	`.I neqn`
		161	`or`
		162	`.IR eqn (1).`
		163	`.ti0`
		164	`\fL\&.EQ\fP \fIx y\fR - yes Display equation.`
		165	`Equation number is`
		166	`.IR y .`
		167	`Optional`
		168	`.I x`
		169	`is`
		170	`.BR I ", " L ", " C`
		171	`as in`
		172	`.BR .DS .`
		173	`.ti0`
		174	`\fL\&.FE\fP - yes End footnote.`
		175	`.ti0`
		176	`\fL\&.FP\fP \fIx\fR - no Set font positions for a family, e.g.,`
		177	`.L .FP lucidasans`
		178	`.ti0`
		179	`\fL\&.FS\fP no no Start footnote.`
		180	`The note will be moved to the bottom of the page.`
		181	`.ti0`
		182	\fL\&.HO\fP - no `Bell Laboratories, Holmdel,
		183	`New Jersey 07733'.`
		184	`.ti0`
		185	`\fL\&.I\fP \fIx y z\fR no no Italicize`
		186	`.IR x ,`
		187	`append roman`
		188	`.I y`
		189	`and preface with`
		190	`.IR z ;`
		191	`if no argument switch to italic.`
		192	`.ti0`
		193	\fL\&.IH\fP no no `Bell Laboratories, Naperville, Illinois 60540'
		194	`.ti0`
		195	`\fL\&.IM\fP no no Print document in BTL format for an internal memorandum. Must be first.`
		196	`.ti0`
		197	`\fL\&.IP\fP \fIx y\fR no yes Start indented paragraph,`
		198	`with hanging tag`
		199	`.IR x .`
		200	`Indentation is`
		201	`.I y`
		202	`ens (default 5).`
		203	`.ti0`
		204	`\fL\&.KE\fP - yes End keep.`
		205	`Put kept text on next page if not enough room.`
		206	`.ti0`
		207	`\fL\&.KF\fP no yes Start floating keep.`
		208	`If the kept text must be moved to the next page,`
		209	`float later text back to this page.`
		210	`.ti0`
		211	`\fL\&.KS\fP no yes Start keeping following text.`
		212	`.ti0`
		213	`\fL\&.LG\fP no no Make letters larger.`
		214	`.ti0`
		215	`\fL\&.LP\fP yes yes Start left-blocked paragraph.`
		216	`.ti0`
		217	`\fL\&.LT\fP no yes Start a letter; a non-empty first argument`
		218	`produces a full Lucent letterhead, a second argument is a room number,`
		219	`a third argument is a telephone number.`
		220	`.ti0`
		221	\fL\&.MF\fP - - Print document in BTL format for `Memorandum for File.' Must be first.
		222	`.ti0`
		223	\fL\&.MH\fP - no `Bell Laboratories, Murray Hill,
		224	`New Jersey 07974'.`
		225	`.ti0`
		226	\fL\&.MR\fP - - Print document in BTL format for `Memorandum for Record.' Must be first.
		227	`.ti0`
		228	`\fL\&.ND\fP \fIdate\fR troff no Use date supplied (if any) only in`
		229	`special BTL format positions; omit from page footer.`
		230	`.ti0`
		231	`\fL\&.NH\fP \fIn\fR - yes Same as`
		232	`.BR .SH ,`
		233	`with automatic section`
		234	numbers like `1.2.3';
		235	`.I n`
		236	`is subsection level (default 1).`
		237	`If`
		238	`.I n`
		239	`is 0, reset the numbering.`
		240	`.ti0`
		241	`\fL\&.NL\fP yes no Make letters normal size.`
		242	`.ti0`
		243	`\fL\&.P1\fP - yes Begin program display in constant width font.`
		244	`.ti0`
		245	`\fL\&.P2\fP - yes End program display.`
		246	`.ti0`
		247	`\fL\&.PE\fP - yes End picture; see`
		248	`.IR pic (1).`
		249	`.ti0`
		250	`\fL\&.PF\fP - yes End picture; restore vertical`
		251	`position.`
		252	`.ti0`
		253	`\fL\&.PP\fP no yes Begin paragraph.`
		254	`First line indented.`
		255	`.ti0`
		256	`\fL\&.PS\fP \fIh w\fR - yes Start picture; height`
		257	`and width in inches.`
		258	`.ti0`
		259	\fL\&.PY\fP - no `Bell Laboratories, Piscataway, New Jersey 08854'
		260	`.ti0`
		261	`\fL\&.QE\fP - yes End quoted material.`
		262	`.ti0`
		263	`\fL\&.QP\fP - yes Begin quoted paragraph (indent both margins).`
		264	`.ti0`
		265	`\fL\&.QS\fP - yes Begin quoted material (indent both margins).`
		266	`.ti0`
		267	`\fL\&.R\fP yes no Roman text follows.`
		268	`.ti0`
		269	`\fL\&.RE\fP - yes End relative indent level.`
		270	`.ti0`
		271	`\fL\&.RP\fP no - Cover sheet and first page for released`
		272	`paper.`
		273	`Must precede other requests.`
		274	`.ti0`
		275	`\fL\&.RS\fP - yes Start level of relative indentation`
		276	`from which subsequent indentation is measured.`
		277	`.ti0`
		278	`\fL\&.SG\fP \fIx\fR no yes Insert signature(s) of author(s),`
		279	`ignored except in`
		280	`.B .TM`
		281	`and`
		282	`.BR .LT .`
		283	`.IR x " is the reference line (initials of author and typist)."`
		284	`.ti0`
		285	`\fL\&.SH\fP - yes Section head follows,`
		286	`font automatically bold.`
		287	`.ti0`
		288	`\fL\&.SM\fP no no Make letters smaller.`
		289	`.ti0`
		290	`\fL\&.TA\fP\ \fIx\fR... 5... no Set tabs in ens.`
		291	`Default is 5 10 15 ...`
		292	`.ti0`
		293	`\fL\&.TE\fP - yes End table; see`
		294	`.IR tbl (1).`
		295	`.ti0`
		296	`\fL\&.TH\fP - yes End heading section of table.`
		297	`.ti0`
		298	`\fL\&.TL\fP no yes Title follows.`
		299	`.ti0`
		300	`\fL\&.TM\fP\ \fIx\fR... no - Print document in BTL technical memorandum format.`
		301	`Arguments are TM number, (quoted list of) case number(s), and file number.`
		302	`Must precede other requests.`
		303	`.ti0`
		304	`\fL\&.TR\fP \fIx\fR - - Print in BTL technical report format; report number is \fIx\fR. Must be first.`
		305	`.ti0`
		306	`\fL\&.TS\fP \fIx\fR - yes Begin table; if`
		307	`.I x`
		308	`is`
		309	`.B H`
		310	`table heading is repeated on new pages.`
		311	`.ti0`
		312	`\fL\&.UL\fP \fIx\fR - no Underline argument (even in troff).`
		313	`.ti0`
		314	\fL\&.UX\fP\ \fIy z\fP - no `\fIz\fRUNIX\fIy\fP';
		315	`first use gives registered trademark notice.`
		316	`.ti0`
		317	\fL\&.WH\fP - no `Bell Laboratories, Whippany,
		318	`New Jersey 07981'.`
		319	`.hc`

Subversion Repositories planix.SVN

(root)/os/branches/planix-v0/sys/man/6/ms – Rev 2