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