docs/master
annotate style @ 82:ff4537327162
Mayor rework: Replaced .DS with .VS, a better verbatim environment.
VS is no Keep.
By translating characters in the typewriter fonts, we don't need to
escape the minus, backtick and single quote characters.
author | markus schnalke <meillo@marmaro.de> |
---|---|
date | Wed, 06 Jun 2012 17:58:09 +0200 |
parents | 5fb821ed6f3c |
children | 99ab58dc891f |
rev | line source |
---|---|
meillo@0 | 1 .do xflag 3 |
meillo@0 | 2 .de __ |
meillo@0 | 3 .. |
meillo@0 | 4 .blm __ \" ignore empty lines in input |
meillo@0 | 5 .lc_ctype en_US.utf8 |
meillo@0 | 6 .mediasize a4 |
meillo@0 | 7 |
meillo@0 | 8 .fp 1 R LinLibertine_R otf |
meillo@0 | 9 .feature R +onum |
meillo@0 | 10 .fp 2 I LinLibertine_RI otf |
meillo@0 | 11 .feature I +onum |
meillo@0 | 12 .fp 3 B LinLibertine_RB otf |
meillo@0 | 13 .feature B +onum |
meillo@0 | 14 .fp 4 BI LinLibertine_RBI otf |
meillo@0 | 15 .feature BI +onum |
meillo@0 | 16 .fp 5 CW TerminusMedium-4.36 ttf |
meillo@0 | 17 .fp 0 CI TerminusMediumItalic-4.36 ttf |
meillo@0 | 18 .fp 0 CB TerminusBold-4.36 ttf |
meillo@0 | 19 .fp 0 L TerminusMedium-4.36 ttf |
meillo@82 | 20 .ftr CW -\-`\`'\' |
meillo@82 | 21 .ftr CI -\-`\`'\' |
meillo@82 | 22 .ftr CB -\-`\`'\' |
meillo@82 | 23 .ftr L -\-`\`'\' |
meillo@15 | 24 .fp 0 SC LinLibertine_R otf |
meillo@15 | 25 .feature SC +onum +smcp |
meillo@15 | 26 .fp 0 IC LinLibertine_RI otf |
meillo@15 | 27 .feature IC +onum +smcp |
meillo@0 | 28 .fp 0 BC LinLibertine_RB otf |
meillo@0 | 29 .feature BC +onum +smcp |
meillo@0 | 30 |
meillo@0 | 31 .ig |
meillo@75 | 32 . nr PS 11 |
meillo@75 | 33 . nr VS 13 |
meillo@75 | 34 . padj |
meillo@0 | 35 .. |
meillo@0 | 36 |
meillo@0 | 37 .nr PI 3n |
meillo@41 | 38 .nr PD .3v |
meillo@0 | 39 .nr lu 0 |
meillo@0 | 40 .af PN i |
meillo@0 | 41 |
meillo@15 | 42 .ds _E '\\\\n(PN''\f(SCMarkus Schnalke: The Modern Mail Handler\fP' \" left |
meillo@15 | 43 .ds _O '\f(SCChapter \\\\n(H1\ \ \\\\*(_C\fP''\\\\n(PN' \" right |
meillo@29 | 44 .ds _o '\f(SC\\\\*(_C\fP''\\\\n(PN' \" right |
meillo@0 | 45 .ds CH " |
meillo@0 | 46 |
meillo@0 | 47 .nr HM 3.3c |
meillo@0 | 48 .nr FM 6.6c |
meillo@75 | 49 .nr LL 13c |
meillo@75 | 50 .ll 13c |
meillo@0 | 51 .nr LT \n(LL |
meillo@75 | 52 .if t .nr PO 3.3c |
meillo@0 | 53 |
meillo@81 | 54 . \" _M - change margins for text block on next page |
meillo@81 | 55 .de _M |
meillo@75 | 56 .if t .if o .nr PO +(21c-\n(.lu-(2u*3.3c))c |
meillo@75 | 57 .if t .if e .nr PO -(21c-\n(.lu-(2u*3.3c))c |
meillo@0 | 58 .ds CF " |
meillo@0 | 59 .. |
meillo@0 | 60 .wh -1u _M |
meillo@0 | 61 |
meillo@81 | 62 . \" CW - Set text in CW font (similar to .B and .I) |
meillo@0 | 63 .de CW |
meillo@0 | 64 .nr PQ \\n(.f |
meillo@0 | 65 .if t \{\ |
meillo@0 | 66 . ft CW |
meillo@0 | 67 . if !^\\$1^^ \&\\$1\f\\n(PQ\\$2 |
meillo@0 | 68 .\} |
meillo@0 | 69 .if n \{\ |
meillo@0 | 70 . ie ^\\$1^^ .ul 999 |
meillo@0 | 71 . el .ul 1 |
meillo@0 | 72 . if \\n(.$=1 \&\\$1 |
meillo@0 | 73 . if \\n(.$>1 \&\\$1\c |
meillo@0 | 74 . if \\n(.$>1 \&\\$2 |
meillo@0 | 75 .\} |
meillo@0 | 76 .. |
meillo@0 | 77 |
meillo@81 | 78 . \" refer(1) stuff |
meillo@35 | 79 .ds [. " [ |
meillo@0 | 80 .ds .] ] |
meillo@0 | 81 .rm ]< |
meillo@0 | 82 .de ]< |
meillo@0 | 83 . LP |
meillo@0 | 84 . de FP |
meillo@0 | 85 . IP \\\\$1. |
meillo@0 | 86 \\.. |
meillo@0 | 87 . rm FS FE |
meillo@0 | 88 .. |
meillo@0 | 89 |
meillo@81 | 90 . \" PT - page top macro of ms |
meillo@0 | 91 .am PT |
meillo@0 | 92 . rs |
meillo@0 | 93 .. |
meillo@0 | 94 |
meillo@81 | 95 |
meillo@81 | 96 . \" RN - Reset PN and continue on an odd page ($1=number-format) |
meillo@81 | 97 .de RN |
meillo@81 | 98 .ie e .pn 1 |
meillo@81 | 99 .el \{ |
meillo@81 | 100 . pn 0 |
meillo@81 | 101 . bp |
meillo@81 | 102 .\} |
meillo@81 | 103 .ie \\n(.$=1 .af PN \\$1 |
meillo@81 | 104 .el .af PN 1 |
meillo@81 | 105 .. |
meillo@81 | 106 |
meillo@81 | 107 |
meillo@81 | 108 . \" T_ - Add TOC entry ($1=pre-space $2=indent-level $3=text) |
meillo@81 | 109 .de T_ |
meillo@79 | 110 .tm TOC____.sp \\$1 |
meillo@79 | 111 .tm TOC____\&\\h'\\$2u*2u*\\n(PIu'\\$3\0\0\a\t\\n(PN\fR |
meillo@79 | 112 .. |
meillo@79 | 113 |
meillo@81 | 114 . \" NH - redefine numbered heading |
meillo@0 | 115 .de NH |
meillo@0 | 116 .SH |
meillo@0 | 117 .nr NS \\$1 |
meillo@0 | 118 .if !\\n(.$ .nr NS 1 |
meillo@0 | 119 .if !\\n(NS .nr NS 1 |
meillo@0 | 120 .nr H\\n(NS +1 |
meillo@6 | 121 .if \\n(NS<2 .nr H2 0 |
meillo@6 | 122 .if \\n(NS<3 .nr H3 0 |
meillo@0 | 123 .ds SN \\n(H1 |
meillo@6 | 124 .if \\n(NS>1 .as SN \&.\\n(H2 |
meillo@6 | 125 .if \\n(NS>2 .as SN \&.\\n(H3 |
meillo@0 | 126 .. |
meillo@0 | 127 |
meillo@81 | 128 . \" H- - Chapter unnumbered and not in TOC ($2=="no" -> no page hdrs) |
meillo@40 | 129 .de H- |
meillo@29 | 130 .EH " |
meillo@29 | 131 .OH " |
meillo@29 | 132 .bp |
meillo@81 | 133 .if e .rs \" move to an odd page |
meillo@29 | 134 .if e .bp |
meillo@29 | 135 .lg 0 |
meillo@29 | 136 .nr PS +6 |
meillo@29 | 137 .nr VS +6 |
meillo@29 | 138 .SH |
meillo@29 | 139 .ce 1 |
meillo@29 | 140 .tr aAbBcCdDeEfFgGhHiIjJkKlLmMnNoOpPqQrRsStTuUvVwWxXyYzZ |
meillo@29 | 141 \&\\$1 |
meillo@29 | 142 .br |
meillo@29 | 143 .tr aabbccddeeffgghhiijjkkllmmnnooppqqrrssttuuvvwwxxyyzz |
meillo@29 | 144 .nr PS -6 |
meillo@29 | 145 .nr VS -6 |
meillo@29 | 146 .lg |
meillo@40 | 147 .if !,\\$2,no, \{ |
meillo@40 | 148 . EH "\\\\*(_E |
meillo@40 | 149 . ie \\n(H1 .OH "\\\\*(_O |
meillo@40 | 150 . el .OH "\\\\*(_o |
meillo@40 | 151 . ds CF \\n(PN |
meillo@40 | 152 .\} |
meillo@81 | 153 .RT |
meillo@29 | 154 .sp 4 |
meillo@29 | 155 .nr PP 0 |
meillo@29 | 156 .. |
meillo@29 | 157 |
meillo@81 | 158 . \" H0 - Chapter ($2=="no" -> not numbered) |
meillo@0 | 159 .de H0 |
meillo@0 | 160 .EH " |
meillo@0 | 161 .OH " |
meillo@0 | 162 .bp |
meillo@81 | 163 .if e .rs \" begin chapter on an odd page |
meillo@0 | 164 .if e .bp |
meillo@81 | 165 .lg 0 |
meillo@81 | 166 .nr PS +6 |
meillo@81 | 167 .nr VS +6 |
meillo@81 | 168 .ie ,\\$2,no, .SH |
meillo@81 | 169 .el \{\ |
meillo@0 | 170 . NH 1 |
meillo@0 | 171 . ce 1 |
meillo@0 | 172 Chapter \\*(SN |
meillo@0 | 173 . sp .5 |
meillo@0 | 174 .\} |
meillo@81 | 175 .ce 1 |
meillo@81 | 176 .tr aAbBcCdDeEfFgGhHiIjJkKlLmMnNoOpPqQrRsStTuUvVwWxXyYzZ |
meillo@0 | 177 \&\\$1 |
meillo@81 | 178 .br |
meillo@81 | 179 .tr aabbccddeeffgghhiijjkkllmmnnooppqqrrssttuuvvwwxxyyzz |
meillo@81 | 180 .nr PS -6 |
meillo@81 | 181 .nr VS -6 |
meillo@81 | 182 .lg |
meillo@81 | 183 .\" add to TOC |
meillo@79 | 184 .rm t_ |
meillo@79 | 185 .if !,\\$2,no, .ds t_ \\*(SN\0\0 |
meillo@79 | 186 .T_ .5v 0 "\fB\\*(t_\\$1 |
meillo@81 | 187 .\" set page headers and footers |
meillo@29 | 188 .EH "\\\\*(_E |
meillo@81 | 189 .ds _C "\\$1 |
meillo@29 | 190 .ie \\n(H1 .OH "\\\\*(_O |
meillo@29 | 191 .el .OH "\\\\*(_o |
meillo@29 | 192 .ds CF \\n(PN |
meillo@81 | 193 .RT |
meillo@0 | 194 .sp 4 |
meillo@0 | 195 .nr PP 0 |
meillo@0 | 196 .. |
meillo@0 | 197 |
meillo@39 | 198 |
meillo@81 | 199 . \" H1 - Section ($2=="no" -> not numbered) |
meillo@0 | 200 .de H1 |
meillo@0 | 201 .br |
meillo@0 | 202 .ne 7 |
meillo@1 | 203 .sp |
meillo@81 | 204 .lg 0 |
meillo@81 | 205 .nr PS +2 |
meillo@81 | 206 .nr VS +2 |
meillo@81 | 207 .ie '\\$2'no' .SH |
meillo@81 | 208 .el .NH 2 |
meillo@6 | 209 .if !'\\$2'no' \&\\*(SN |
meillo@81 | 210 .tr aAbBcCdDeEfFgGhHiIjJkKlLmMnNoOpPqQrRsStTuUvVwWxXyYzZ |
meillo@81 | 211 \&\\$1 |
meillo@81 | 212 .br |
meillo@81 | 213 .tr aabbccddeeffgghhiijjkkllmmnnooppqqrrssttuuvvwwxxyyzz |
meillo@81 | 214 .nr PS -2 |
meillo@81 | 215 .nr VS -2 |
meillo@81 | 216 .lg |
meillo@81 | 217 .if !'\\$2'no' .T_ .3v 1 "\\*(SN\0\0\\$1 \" add to TOC |
meillo@81 | 218 .RT |
meillo@6 | 219 .nr PP 0 |
meillo@6 | 220 .. |
meillo@6 | 221 |
meillo@81 | 222 . \" H2 - Subsection |
meillo@6 | 223 .de H2 |
meillo@6 | 224 .br |
meillo@7 | 225 .ne 4 |
meillo@59 | 226 .NH 3 |
meillo@81 | 227 \&\\*(SN \\$1 |
meillo@81 | 228 .T_ 0 2 "\\*(SN\0\0\\$1 \" add to TOC |
meillo@11 | 229 .RT |
meillo@11 | 230 .nr PP 0 |
meillo@11 | 231 .. |
meillo@11 | 232 |
meillo@81 | 233 . \" U2 - Subsection unnumbered |
meillo@11 | 234 .de U2 |
meillo@11 | 235 .br |
meillo@11 | 236 .ne 4 |
meillo@11 | 237 .SH |
meillo@81 | 238 \&\\$1 |
meillo@11 | 239 .RT |
meillo@0 | 240 .nr PP 0 |
meillo@0 | 241 .. |
meillo@0 | 242 |
meillo@81 | 243 . \" U3 - Subsubsection unnumbered |
meillo@73 | 244 .de U3 |
meillo@73 | 245 .br |
meillo@73 | 246 .ne 4 |
meillo@73 | 247 .RT |
meillo@73 | 248 .sp |
meillo@73 | 249 .I "\\$1 |
meillo@73 | 250 .RT |
meillo@73 | 251 .nr PP 0 |
meillo@73 | 252 .. |
meillo@73 | 253 |
meillo@81 | 254 . \" P - Paragraph (indented unless following a heading) |
meillo@0 | 255 .de P |
meillo@0 | 256 .ie \\n(PP .PP |
meillo@0 | 257 .el .LP |
meillo@0 | 258 .nr PP 1 |
meillo@0 | 259 .. |
meillo@0 | 260 |
meillo@81 | 261 . \" IP - Paragraph with hanging label |
meillo@0 | 262 .am IP |
meillo@0 | 263 .nr PP 0 |
meillo@0 | 264 .. |
meillo@0 | 265 |
meillo@81 | 266 . \" BU - Bulleted paragraph |
meillo@6 | 267 .de BU |
meillo@6 | 268 .IP \(bu |
meillo@6 | 269 .. |
meillo@6 | 270 |
meillo@81 | 271 . \" QP - Block quote paragraph |
meillo@0 | 272 .am QP |
meillo@0 | 273 .ps -1 |
meillo@0 | 274 .. |
meillo@0 | 275 |
meillo@81 | 276 . \" DS - Code display |
meillo@0 | 277 .am DS |
meillo@0 | 278 .ft CW |
meillo@0 | 279 .ps -1 |
meillo@0 | 280 .ta T 8n |
meillo@0 | 281 .. |
meillo@0 | 282 |
meillo@82 | 283 . \" VS - verbatim text start (\\ -> ^G; ' -> disabled; . -> ^B) |
meillo@82 | 284 .de VS |
meillo@82 | 285 .br |
meillo@82 | 286 .ne 4 |
meillo@82 | 287 .sp \n(DDu |
meillo@82 | 288 .if t .in +.5i |
meillo@82 | 289 .if n .in +8n |
meillo@82 | 290 .nf |
meillo@82 | 291 .ft CW |
meillo@82 | 292 .\" ps -1 |
meillo@82 | 293 .ta T 8n |
meillo@82 | 294 .\" set up verbatim environment |
meillo@82 | 295 \.blm |
meillo@82 | 296 \.ec |
meillo@82 | 297 \.c2 "" |
meillo@82 | 298 \.cc |
meillo@82 | 299 .. |
meillo@82 | 300 |
meillo@82 | 301 . \" VE - verbatim text end (NOTE: Needs to be called as ^BVE !) |
meillo@82 | 302 .de VE |
meillo@82 | 303 \" restore the special characters |
meillo@82 | 304 cc |
meillo@82 | 305 .c2 |
meillo@82 | 306 .ec |
meillo@82 | 307 .blm __ |
meillo@82 | 308 .if t .in -.5i |
meillo@82 | 309 .if n .in -8n |
meillo@82 | 310 .sp \n(DDu |
meillo@82 | 311 .ft P |
meillo@82 | 312 .fi |
meillo@82 | 313 .TA |
meillo@82 | 314 .. |
meillo@82 | 315 |
meillo@81 | 316 . \" FA - XXX somehow related to footnotes? |
meillo@0 | 317 .am FA |
meillo@0 | 318 .ps 8 |
meillo@0 | 319 .vs 9 |
meillo@0 | 320 .. |
meillo@18 | 321 |
meillo@18 | 322 .de Fn \" file name |
meillo@18 | 323 .CW "\\$1" "\\$2 |
meillo@18 | 324 .. |
meillo@18 | 325 .de Pn \" program name |
meillo@18 | 326 .CW "\\$1" "\\$2 |
meillo@18 | 327 .. |
meillo@18 | 328 .de Fu \" function |
meillo@18 | 329 .CW "\\$1" "\\$2 |
meillo@18 | 330 .. |
meillo@19 | 331 .de Ev \" env variable |
meillo@19 | 332 .CW "\\$1" "\\$2 |
meillo@19 | 333 .. |
meillo@18 | 334 .de Cl \" command line |
meillo@18 | 335 `\c |
meillo@18 | 336 .CW "\\$1" "'\\$2 |
meillo@18 | 337 .. |
meillo@18 | 338 .de Sw \" switch |
meillo@18 | 339 .CW "\\$1" "\\$2 |
meillo@18 | 340 .. |
meillo@18 | 341 .de Mp \" man page |
meillo@18 | 342 .I "\\$1" "\\$2 |
meillo@18 | 343 .. |
meillo@18 | 344 .de Pe \" profile entry |
meillo@18 | 345 .CW "\\$1" "\\$2 |
meillo@18 | 346 .. |
meillo@67 | 347 |
meillo@81 | 348 .de Ci \" commit hash ref |
meillo@70 | 349 .ds _t \\$1 |
meillo@70 | 350 .substring _t 0 6 |
meillo@67 | 351 [\(rh |
meillo@70 | 352 .CW "\\*(_t" "]\\$2 |
meillo@67 | 353 .. |
meillo@77 | 354 |
meillo@77 | 355 .de Cf \" cf. (ref within document) |
meillo@77 | 356 (\(-> \\$1)\\$2 |
meillo@77 | 357 .. |