adamstark@51: .\"Modified from man(1) of FreeBSD, the NetBSD mdoc.template, and mdoc.samples.
adamstark@51: .\"See Also:
adamstark@51: .\"man mdoc.samples for a complete listing of options
adamstark@51: .\"man mdoc for the short list of editing options
adamstark@51: .\"/usr/share/misc/mdoc.template
adamstark@51: .Dd 21/01/2014               \" DATE 
adamstark@51: .Dt BTrack Tests 1      \" Program name and manual section number 
adamstark@51: .Os Darwin
adamstark@51: .Sh NAME                 \" Section Header - required - don't modify 
adamstark@51: .Nm BTrack Tests,
adamstark@51: .\" The following lines are read in generating the apropos(man -k) database. Use only key
adamstark@51: .\" words here as the database is built based on the words here and in the .ND line. 
adamstark@51: .Nm Other_name_for_same_program(),
adamstark@51: .Nm Yet another name for the same program.
adamstark@51: .\" Use .Nm macro to designate other names for the documented program.
adamstark@51: .Nd This line parsed for whatis database.
adamstark@51: .Sh SYNOPSIS             \" Section Header - required - don't modify
adamstark@51: .Nm
adamstark@51: .Op Fl abcd              \" [-abcd]
adamstark@51: .Op Fl a Ar path         \" [-a path] 
adamstark@51: .Op Ar file              \" [file]
adamstark@51: .Op Ar                   \" [file ...]
adamstark@51: .Ar arg0                 \" Underlined argument - use .Ar anywhere to underline
adamstark@51: arg2 ...                 \" Arguments
adamstark@51: .Sh DESCRIPTION          \" Section Header - required - don't modify
adamstark@51: Use the .Nm macro to refer to your program throughout the man page like such:
adamstark@51: .Nm
adamstark@51: Underlining is accomplished with the .Ar macro like this:
adamstark@51: .Ar underlined text .
adamstark@51: .Pp                      \" Inserts a space
adamstark@51: A list of items with descriptions:
adamstark@51: .Bl -tag -width -indent  \" Begins a tagged list 
adamstark@51: .It item a               \" Each item preceded by .It macro
adamstark@51: Description of item a
adamstark@51: .It item b
adamstark@51: Description of item b
adamstark@51: .El                      \" Ends the list
adamstark@51: .Pp
adamstark@51: A list of flags and their descriptions:
adamstark@51: .Bl -tag -width -indent  \" Differs from above in tag removed 
adamstark@51: .It Fl a                 \"-a flag as a list item
adamstark@51: Description of -a flag
adamstark@51: .It Fl b
adamstark@51: Description of -b flag
adamstark@51: .El                      \" Ends the list
adamstark@51: .Pp
adamstark@51: .\" .Sh ENVIRONMENT      \" May not be needed
adamstark@51: .\" .Bl -tag -width "ENV_VAR_1" -indent \" ENV_VAR_1 is width of the string ENV_VAR_1
adamstark@51: .\" .It Ev ENV_VAR_1
adamstark@51: .\" Description of ENV_VAR_1
adamstark@51: .\" .It Ev ENV_VAR_2
adamstark@51: .\" Description of ENV_VAR_2
adamstark@51: .\" .El                      
adamstark@51: .Sh FILES                \" File used or created by the topic of the man page
adamstark@51: .Bl -tag -width "/Users/joeuser/Library/really_long_file_name" -compact
adamstark@51: .It Pa /usr/share/file_name
adamstark@51: FILE_1 description
adamstark@51: .It Pa /Users/joeuser/Library/really_long_file_name
adamstark@51: FILE_2 description
adamstark@51: .El                      \" Ends the list
adamstark@51: .\" .Sh DIAGNOSTICS       \" May not be needed
adamstark@51: .\" .Bl -diag
adamstark@51: .\" .It Diagnostic Tag
adamstark@51: .\" Diagnostic informtion here.
adamstark@51: .\" .It Diagnostic Tag
adamstark@51: .\" Diagnostic informtion here.
adamstark@51: .\" .El
adamstark@51: .Sh SEE ALSO 
adamstark@51: .\" List links in ascending order by section, alphabetically within a section.
adamstark@51: .\" Please do not reference files that do not exist without filing a bug report
adamstark@51: .Xr a 1 , 
adamstark@51: .Xr b 1 ,
adamstark@51: .Xr c 1 ,
adamstark@51: .Xr a 2 ,
adamstark@51: .Xr b 2 ,
adamstark@51: .Xr a 3 ,
adamstark@51: .Xr b 3 
adamstark@51: .\" .Sh BUGS              \" Document known, unremedied bugs 
adamstark@51: .\" .Sh HISTORY           \" Document history if command behaves in a unique manner