annotate unit-tests/BTrack Tests/BTrack_Tests.1 @ 31:8f135e664398 develop

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