1 |
.\"Modified from man(1) of FreeBSD, the NetBSD mdoc.template, and mdoc.samples. |
2 |
.\"See Also: |
3 |
.\"man mdoc.samples for a complete listing of options |
4 |
.\"man mdoc for the short list of editing options |
5 |
.\"/usr/share/misc/mdoc.template |
6 |
.Dd 3/29/09 \" DATE |
7 |
.Dt AE Installer (CLI) 1 \" Program name and manual section number |
8 |
.Os Darwin |
9 |
.Sh NAME \" Section Header - required - don't modify |
10 |
.Nm AE Installer (CLI), |
11 |
.\" The following lines are read in generating the apropos(man -k) database. Use only key |
12 |
.\" words here as the database is built based on the words here and in the .ND line. |
13 |
.Nm Other_name_for_same_program(), |
14 |
.Nm Yet another name for the same program. |
15 |
.\" Use .Nm macro to designate other names for the documented program. |
16 |
.Nd This line parsed for whatis database. |
17 |
.Sh SYNOPSIS \" Section Header - required - don't modify |
18 |
.Nm |
19 |
.Op Fl abcd \" [-abcd] |
20 |
.Op Fl a Ar path \" [-a path] |
21 |
.Op Ar file \" [file] |
22 |
.Op Ar \" [file ...] |
23 |
.Ar arg0 \" Underlined argument - use .Ar anywhere to underline |
24 |
arg2 ... \" Arguments |
25 |
.Sh DESCRIPTION \" Section Header - required - don't modify |
26 |
Use the .Nm macro to refer to your program throughout the man page like such: |
27 |
.Nm |
28 |
Underlining is accomplished with the .Ar macro like this: |
29 |
.Ar underlined text . |
30 |
.Pp \" Inserts a space |
31 |
A list of items with descriptions: |
32 |
.Bl -tag -width -indent \" Begins a tagged list |
33 |
.It item a \" Each item preceded by .It macro |
34 |
Description of item a |
35 |
.It item b |
36 |
Description of item b |
37 |
.El \" Ends the list |
38 |
.Pp |
39 |
A list of flags and their descriptions: |
40 |
.Bl -tag -width -indent \" Differs from above in tag removed |
41 |
.It Fl a \"-a flag as a list item |
42 |
Description of -a flag |
43 |
.It Fl b |
44 |
Description of -b flag |
45 |
.El \" Ends the list |
46 |
.Pp |
47 |
.\" .Sh ENVIRONMENT \" May not be needed |
48 |
.\" .Bl -tag -width "ENV_VAR_1" -indent \" ENV_VAR_1 is width of the string ENV_VAR_1 |
49 |
.\" .It Ev ENV_VAR_1 |
50 |
.\" Description of ENV_VAR_1 |
51 |
.\" .It Ev ENV_VAR_2 |
52 |
.\" Description of ENV_VAR_2 |
53 |
.\" .El |
54 |
.Sh FILES \" File used or created by the topic of the man page |
55 |
.Bl -tag -width "/Users/joeuser/Library/really_long_file_name" -compact |
56 |
.It Pa /usr/share/file_name |
57 |
FILE_1 description |
58 |
.It Pa /Users/joeuser/Library/really_long_file_name |
59 |
FILE_2 description |
60 |
.El \" Ends the list |
61 |
.\" .Sh DIAGNOSTICS \" May not be needed |
62 |
.\" .Bl -diag |
63 |
.\" .It Diagnostic Tag |
64 |
.\" Diagnostic informtion here. |
65 |
.\" .It Diagnostic Tag |
66 |
.\" Diagnostic informtion here. |
67 |
.\" .El |
68 |
.Sh SEE ALSO |
69 |
.\" List links in ascending order by section, alphabetically within a section. |
70 |
.\" Please do not reference files that do not exist without filing a bug report |
71 |
.Xr a 1 , |
72 |
.Xr b 1 , |
73 |
.Xr c 1 , |
74 |
.Xr a 2 , |
75 |
.Xr b 2 , |
76 |
.Xr a 3 , |
77 |
.Xr b 3 |
78 |
.\" .Sh BUGS \" Document known, unremedied bugs |
79 |
.\" .Sh HISTORY \" Document history if command behaves in a unique manner |