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