| 1 |
<!DOCTYPE html> |
| 2 |
<html lang="en"> |
| 3 |
<head> |
| 4 |
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| 5 |
<meta name="generator" content="AsciiDoc test"> |
| 6 |
<title>ASCIIDOC(1)</title> |
| 7 |
<style type="text/css"> |
| 8 |
/* Shared CSS for AsciiDoc xhtml11 and html5 backends */ |
| 9 |
|
| 10 |
/* Default font. */ |
| 11 |
body { |
| 12 |
font-family: Georgia,serif; |
| 13 |
} |
| 14 |
|
| 15 |
/* Title font. */ |
| 16 |
h1, h2, h3, h4, h5, h6, |
| 17 |
div.title, caption.title, |
| 18 |
thead, p.table.header, |
| 19 |
#toctitle, |
| 20 |
#author, #revnumber, #revdate, #revremark, |
| 21 |
#footer { |
| 22 |
font-family: Arial,Helvetica,sans-serif; |
| 23 |
} |
| 24 |
|
| 25 |
body { |
| 26 |
margin: 1em 5% 1em 5%; |
| 27 |
} |
| 28 |
|
| 29 |
a { |
| 30 |
color: blue; |
| 31 |
text-decoration: underline; |
| 32 |
} |
| 33 |
a:visited { |
| 34 |
color: fuchsia; |
| 35 |
} |
| 36 |
|
| 37 |
em { |
| 38 |
font-style: italic; |
| 39 |
color: navy; |
| 40 |
} |
| 41 |
|
| 42 |
strong { |
| 43 |
font-weight: bold; |
| 44 |
color: #083194; |
| 45 |
} |
| 46 |
|
| 47 |
h1, h2, h3, h4, h5, h6 { |
| 48 |
color: #527bbd; |
| 49 |
margin-top: 1.2em; |
| 50 |
margin-bottom: 0.5em; |
| 51 |
line-height: 1.3; |
| 52 |
} |
| 53 |
|
| 54 |
h1, h2, h3 { |
| 55 |
border-bottom: 2px solid silver; |
| 56 |
} |
| 57 |
h2 { |
| 58 |
padding-top: 0.5em; |
| 59 |
} |
| 60 |
h3 { |
| 61 |
float: left; |
| 62 |
} |
| 63 |
h3 + * { |
| 64 |
clear: left; |
| 65 |
} |
| 66 |
h5 { |
| 67 |
font-size: 1.0em; |
| 68 |
} |
| 69 |
|
| 70 |
div.sectionbody { |
| 71 |
margin-left: 0; |
| 72 |
} |
| 73 |
|
| 74 |
hr { |
| 75 |
border: 1px solid silver; |
| 76 |
} |
| 77 |
|
| 78 |
p { |
| 79 |
margin-top: 0.5em; |
| 80 |
margin-bottom: 0.5em; |
| 81 |
} |
| 82 |
|
| 83 |
ul, ol, li > p { |
| 84 |
margin-top: 0; |
| 85 |
} |
| 86 |
ul > li { color: #aaa; } |
| 87 |
ul > li > * { color: black; } |
| 88 |
|
| 89 |
.monospaced, code, pre { |
| 90 |
font-family: "Courier New", Courier, monospace; |
| 91 |
font-size: inherit; |
| 92 |
color: navy; |
| 93 |
padding: 0; |
| 94 |
margin: 0; |
| 95 |
} |
| 96 |
pre { |
| 97 |
white-space: pre-wrap; |
| 98 |
} |
| 99 |
|
| 100 |
#author { |
| 101 |
color: #527bbd; |
| 102 |
font-weight: bold; |
| 103 |
font-size: 1.1em; |
| 104 |
} |
| 105 |
#email { |
| 106 |
} |
| 107 |
#revnumber, #revdate, #revremark { |
| 108 |
} |
| 109 |
|
| 110 |
#footer { |
| 111 |
font-size: small; |
| 112 |
border-top: 2px solid silver; |
| 113 |
padding-top: 0.5em; |
| 114 |
margin-top: 4.0em; |
| 115 |
} |
| 116 |
#footer-text { |
| 117 |
float: left; |
| 118 |
padding-bottom: 0.5em; |
| 119 |
} |
| 120 |
#footer-badges { |
| 121 |
float: right; |
| 122 |
padding-bottom: 0.5em; |
| 123 |
} |
| 124 |
|
| 125 |
#preamble { |
| 126 |
margin-top: 1.5em; |
| 127 |
margin-bottom: 1.5em; |
| 128 |
} |
| 129 |
div.imageblock, div.exampleblock, div.verseblock, |
| 130 |
div.quoteblock, div.literalblock, div.listingblock, div.sidebarblock, |
| 131 |
div.admonitionblock { |
| 132 |
margin-top: 1.0em; |
| 133 |
margin-bottom: 1.5em; |
| 134 |
} |
| 135 |
div.admonitionblock { |
| 136 |
margin-top: 2.0em; |
| 137 |
margin-bottom: 2.0em; |
| 138 |
margin-right: 10%; |
| 139 |
color: #606060; |
| 140 |
} |
| 141 |
|
| 142 |
div.content { /* Block element content. */ |
| 143 |
padding: 0; |
| 144 |
} |
| 145 |
|
| 146 |
/* Block element titles. */ |
| 147 |
div.title, caption.title { |
| 148 |
color: #527bbd; |
| 149 |
font-weight: bold; |
| 150 |
text-align: left; |
| 151 |
margin-top: 1.0em; |
| 152 |
margin-bottom: 0.5em; |
| 153 |
} |
| 154 |
div.title + * { |
| 155 |
margin-top: 0; |
| 156 |
} |
| 157 |
|
| 158 |
td div.title:first-child { |
| 159 |
margin-top: 0.0em; |
| 160 |
} |
| 161 |
div.content div.title:first-child { |
| 162 |
margin-top: 0.0em; |
| 163 |
} |
| 164 |
div.content + div.title { |
| 165 |
margin-top: 0.0em; |
| 166 |
} |
| 167 |
|
| 168 |
div.sidebarblock > div.content { |
| 169 |
background: #ffffee; |
| 170 |
border: 1px solid #dddddd; |
| 171 |
border-left: 4px solid #f0f0f0; |
| 172 |
padding: 0.5em; |
| 173 |
} |
| 174 |
|
| 175 |
div.listingblock > div.content { |
| 176 |
border: 1px solid #dddddd; |
| 177 |
border-left: 5px solid #f0f0f0; |
| 178 |
background: #f8f8f8; |
| 179 |
padding: 0.5em; |
| 180 |
} |
| 181 |
|
| 182 |
div.quoteblock, div.verseblock { |
| 183 |
padding-left: 1.0em; |
| 184 |
margin-left: 1.0em; |
| 185 |
margin-right: 10%; |
| 186 |
border-left: 5px solid #f0f0f0; |
| 187 |
color: #888; |
| 188 |
} |
| 189 |
|
| 190 |
div.quoteblock > div.attribution { |
| 191 |
padding-top: 0.5em; |
| 192 |
text-align: right; |
| 193 |
} |
| 194 |
|
| 195 |
div.verseblock > pre.content { |
| 196 |
font-family: inherit; |
| 197 |
font-size: inherit; |
| 198 |
} |
| 199 |
div.verseblock > div.attribution { |
| 200 |
padding-top: 0.75em; |
| 201 |
text-align: left; |
| 202 |
} |
| 203 |
/* DEPRECATED: Pre version 8.2.7 verse style literal block. */ |
| 204 |
div.verseblock + div.attribution { |
| 205 |
text-align: left; |
| 206 |
} |
| 207 |
|
| 208 |
div.admonitionblock .icon { |
| 209 |
vertical-align: top; |
| 210 |
font-size: 1.1em; |
| 211 |
font-weight: bold; |
| 212 |
text-decoration: underline; |
| 213 |
color: #527bbd; |
| 214 |
padding-right: 0.5em; |
| 215 |
} |
| 216 |
div.admonitionblock td.content { |
| 217 |
padding-left: 0.5em; |
| 218 |
border-left: 3px solid #dddddd; |
| 219 |
} |
| 220 |
|
| 221 |
div.exampleblock > div.content { |
| 222 |
border-left: 3px solid #dddddd; |
| 223 |
padding-left: 0.5em; |
| 224 |
} |
| 225 |
|
| 226 |
div.imageblock div.content { padding-left: 0; } |
| 227 |
span.image img { border-style: none; vertical-align: text-bottom; } |
| 228 |
a.image:visited { color: white; } |
| 229 |
|
| 230 |
dl { |
| 231 |
margin-top: 0.8em; |
| 232 |
margin-bottom: 0.8em; |
| 233 |
} |
| 234 |
dt { |
| 235 |
margin-top: 0.5em; |
| 236 |
margin-bottom: 0; |
| 237 |
font-style: normal; |
| 238 |
color: navy; |
| 239 |
} |
| 240 |
dd > *:first-child { |
| 241 |
margin-top: 0.1em; |
| 242 |
} |
| 243 |
|
| 244 |
ul, ol { |
| 245 |
list-style-position: outside; |
| 246 |
} |
| 247 |
ol.arabic { |
| 248 |
list-style-type: decimal; |
| 249 |
} |
| 250 |
ol.loweralpha { |
| 251 |
list-style-type: lower-alpha; |
| 252 |
} |
| 253 |
ol.upperalpha { |
| 254 |
list-style-type: upper-alpha; |
| 255 |
} |
| 256 |
ol.lowerroman { |
| 257 |
list-style-type: lower-roman; |
| 258 |
} |
| 259 |
ol.upperroman { |
| 260 |
list-style-type: upper-roman; |
| 261 |
} |
| 262 |
|
| 263 |
div.compact ul, div.compact ol, |
| 264 |
div.compact p, div.compact p, |
| 265 |
div.compact div, div.compact div { |
| 266 |
margin-top: 0.1em; |
| 267 |
margin-bottom: 0.1em; |
| 268 |
} |
| 269 |
|
| 270 |
tfoot { |
| 271 |
font-weight: bold; |
| 272 |
} |
| 273 |
td > div.verse { |
| 274 |
white-space: pre; |
| 275 |
} |
| 276 |
|
| 277 |
div.hdlist { |
| 278 |
margin-top: 0.8em; |
| 279 |
margin-bottom: 0.8em; |
| 280 |
} |
| 281 |
div.hdlist tr { |
| 282 |
padding-bottom: 15px; |
| 283 |
} |
| 284 |
dt.hdlist1.strong, td.hdlist1.strong { |
| 285 |
font-weight: bold; |
| 286 |
} |
| 287 |
td.hdlist1 { |
| 288 |
vertical-align: top; |
| 289 |
font-style: normal; |
| 290 |
padding-right: 0.8em; |
| 291 |
color: navy; |
| 292 |
} |
| 293 |
td.hdlist2 { |
| 294 |
vertical-align: top; |
| 295 |
} |
| 296 |
div.hdlist.compact tr { |
| 297 |
margin: 0; |
| 298 |
padding-bottom: 0; |
| 299 |
} |
| 300 |
|
| 301 |
.comment { |
| 302 |
background: yellow; |
| 303 |
} |
| 304 |
|
| 305 |
.footnote, .footnoteref { |
| 306 |
font-size: 0.8em; |
| 307 |
} |
| 308 |
|
| 309 |
span.footnote, span.footnoteref { |
| 310 |
vertical-align: super; |
| 311 |
} |
| 312 |
|
| 313 |
#footnotes { |
| 314 |
margin: 20px 0 20px 0; |
| 315 |
padding: 7px 0 0 0; |
| 316 |
} |
| 317 |
|
| 318 |
#footnotes div.footnote { |
| 319 |
margin: 0 0 5px 0; |
| 320 |
} |
| 321 |
|
| 322 |
#footnotes hr { |
| 323 |
border: none; |
| 324 |
border-top: 1px solid silver; |
| 325 |
height: 1px; |
| 326 |
text-align: left; |
| 327 |
margin-left: 0; |
| 328 |
width: 20%; |
| 329 |
min-width: 100px; |
| 330 |
} |
| 331 |
|
| 332 |
div.colist td { |
| 333 |
padding-right: 0.5em; |
| 334 |
padding-bottom: 0.3em; |
| 335 |
vertical-align: top; |
| 336 |
} |
| 337 |
div.colist td img { |
| 338 |
margin-top: 0.3em; |
| 339 |
} |
| 340 |
|
| 341 |
@media print { |
| 342 |
#footer-badges { display: none; } |
| 343 |
} |
| 344 |
|
| 345 |
#toc { |
| 346 |
margin-bottom: 2.5em; |
| 347 |
} |
| 348 |
|
| 349 |
#toctitle { |
| 350 |
color: #527bbd; |
| 351 |
font-size: 1.1em; |
| 352 |
font-weight: bold; |
| 353 |
margin-top: 1.0em; |
| 354 |
margin-bottom: 0.1em; |
| 355 |
} |
| 356 |
|
| 357 |
div.toclevel0, div.toclevel1, div.toclevel2, div.toclevel3, div.toclevel4 { |
| 358 |
margin-top: 0; |
| 359 |
margin-bottom: 0; |
| 360 |
} |
| 361 |
div.toclevel2 { |
| 362 |
margin-left: 2em; |
| 363 |
font-size: 0.9em; |
| 364 |
} |
| 365 |
div.toclevel3 { |
| 366 |
margin-left: 4em; |
| 367 |
font-size: 0.9em; |
| 368 |
} |
| 369 |
div.toclevel4 { |
| 370 |
margin-left: 6em; |
| 371 |
font-size: 0.9em; |
| 372 |
} |
| 373 |
|
| 374 |
span.aqua { color: aqua; } |
| 375 |
span.black { color: black; } |
| 376 |
span.blue { color: blue; } |
| 377 |
span.fuchsia { color: fuchsia; } |
| 378 |
span.gray { color: gray; } |
| 379 |
span.green { color: green; } |
| 380 |
span.lime { color: lime; } |
| 381 |
span.maroon { color: maroon; } |
| 382 |
span.navy { color: navy; } |
| 383 |
span.olive { color: olive; } |
| 384 |
span.purple { color: purple; } |
| 385 |
span.red { color: red; } |
| 386 |
span.silver { color: silver; } |
| 387 |
span.teal { color: teal; } |
| 388 |
span.white { color: white; } |
| 389 |
span.yellow { color: yellow; } |
| 390 |
|
| 391 |
span.aqua-background { background: aqua; } |
| 392 |
span.black-background { background: black; } |
| 393 |
span.blue-background { background: blue; } |
| 394 |
span.fuchsia-background { background: fuchsia; } |
| 395 |
span.gray-background { background: gray; } |
| 396 |
span.green-background { background: green; } |
| 397 |
span.lime-background { background: lime; } |
| 398 |
span.maroon-background { background: maroon; } |
| 399 |
span.navy-background { background: navy; } |
| 400 |
span.olive-background { background: olive; } |
| 401 |
span.purple-background { background: purple; } |
| 402 |
span.red-background { background: red; } |
| 403 |
span.silver-background { background: silver; } |
| 404 |
span.teal-background { background: teal; } |
| 405 |
span.white-background { background: white; } |
| 406 |
span.yellow-background { background: yellow; } |
| 407 |
|
| 408 |
span.big { font-size: 2em; } |
| 409 |
span.small { font-size: 0.6em; } |
| 410 |
|
| 411 |
span.underline { text-decoration: underline; } |
| 412 |
span.overline { text-decoration: overline; } |
| 413 |
span.line-through { text-decoration: line-through; } |
| 414 |
|
| 415 |
div.unbreakable { page-break-inside: avoid; } |
| 416 |
|
| 417 |
|
| 418 |
/* |
| 419 |
* xhtml11 specific |
| 420 |
* |
| 421 |
* */ |
| 422 |
|
| 423 |
div.tableblock { |
| 424 |
margin-top: 1.0em; |
| 425 |
margin-bottom: 1.5em; |
| 426 |
} |
| 427 |
div.tableblock > table { |
| 428 |
border: 3px solid #527bbd; |
| 429 |
} |
| 430 |
thead, p.table.header { |
| 431 |
font-weight: bold; |
| 432 |
color: #527bbd; |
| 433 |
} |
| 434 |
p.table { |
| 435 |
margin-top: 0; |
| 436 |
} |
| 437 |
/* Because the table frame attribute is overridden by CSS in most browsers. */ |
| 438 |
div.tableblock > table[frame="void"] { |
| 439 |
border-style: none; |
| 440 |
} |
| 441 |
div.tableblock > table[frame="hsides"] { |
| 442 |
border-left-style: none; |
| 443 |
border-right-style: none; |
| 444 |
} |
| 445 |
div.tableblock > table[frame="vsides"] { |
| 446 |
border-top-style: none; |
| 447 |
border-bottom-style: none; |
| 448 |
} |
| 449 |
|
| 450 |
|
| 451 |
/* |
| 452 |
* html5 specific |
| 453 |
* |
| 454 |
* */ |
| 455 |
|
| 456 |
table.tableblock { |
| 457 |
margin-top: 1.0em; |
| 458 |
margin-bottom: 1.5em; |
| 459 |
} |
| 460 |
thead, p.tableblock.header { |
| 461 |
font-weight: bold; |
| 462 |
color: #527bbd; |
| 463 |
} |
| 464 |
p.tableblock { |
| 465 |
margin-top: 0; |
| 466 |
} |
| 467 |
table.tableblock { |
| 468 |
border-width: 3px; |
| 469 |
border-spacing: 0px; |
| 470 |
border-style: solid; |
| 471 |
border-color: #527bbd; |
| 472 |
border-collapse: collapse; |
| 473 |
} |
| 474 |
th.tableblock, td.tableblock { |
| 475 |
border-width: 1px; |
| 476 |
padding: 4px; |
| 477 |
border-style: solid; |
| 478 |
border-color: #527bbd; |
| 479 |
} |
| 480 |
|
| 481 |
table.tableblock.frame-topbot { |
| 482 |
border-left-style: hidden; |
| 483 |
border-right-style: hidden; |
| 484 |
} |
| 485 |
table.tableblock.frame-sides { |
| 486 |
border-top-style: hidden; |
| 487 |
border-bottom-style: hidden; |
| 488 |
} |
| 489 |
table.tableblock.frame-none { |
| 490 |
border-style: hidden; |
| 491 |
} |
| 492 |
|
| 493 |
th.tableblock.halign-left, td.tableblock.halign-left { |
| 494 |
text-align: left; |
| 495 |
} |
| 496 |
th.tableblock.halign-center, td.tableblock.halign-center { |
| 497 |
text-align: center; |
| 498 |
} |
| 499 |
th.tableblock.halign-right, td.tableblock.halign-right { |
| 500 |
text-align: right; |
| 501 |
} |
| 502 |
|
| 503 |
th.tableblock.valign-top, td.tableblock.valign-top { |
| 504 |
vertical-align: top; |
| 505 |
} |
| 506 |
th.tableblock.valign-middle, td.tableblock.valign-middle { |
| 507 |
vertical-align: middle; |
| 508 |
} |
| 509 |
th.tableblock.valign-bottom, td.tableblock.valign-bottom { |
| 510 |
vertical-align: bottom; |
| 511 |
} |
| 512 |
|
| 513 |
|
| 514 |
/* |
| 515 |
* manpage specific |
| 516 |
* |
| 517 |
* */ |
| 518 |
|
| 519 |
body.manpage h1 { |
| 520 |
padding-top: 0.5em; |
| 521 |
padding-bottom: 0.5em; |
| 522 |
border-top: 2px solid silver; |
| 523 |
border-bottom: 2px solid silver; |
| 524 |
} |
| 525 |
body.manpage h2 { |
| 526 |
border-style: none; |
| 527 |
} |
| 528 |
body.manpage div.sectionbody { |
| 529 |
margin-left: 3em; |
| 530 |
} |
| 531 |
|
| 532 |
@media print { |
| 533 |
body.manpage div#toc { display: none; } |
| 534 |
} |
| 535 |
|
| 536 |
|
| 537 |
</style> |
| 538 |
<script type="text/javascript"> |
| 539 |
/*<+'])'); |
| 582 |
// Function that scans the DOM tree for header elements (the DOM2 |
| 583 |
// nodeIterator API would be a better technique but not supported by all |
| 584 |
// browsers). |
| 585 |
var iterate = function (el) { |
| 586 |
for (var i = el.firstChild; i != null; i = i.nextSibling) { |
| 587 |
if (i.nodeType == 1 /* Node.ELEMENT_NODE */) { |
| 588 |
var mo = re.exec(i.tagName); |
| 589 |
if (mo && (i.getAttribute("class") || i.getAttribute("className")) != "float") { |
| 590 |
result[result.length] = new TocEntry(i, getText(i), mo[1]-1); |
| 591 |
} |
| 592 |
iterate(i); |
| 593 |
} |
| 594 |
} |
| 595 |
} |
| 596 |
iterate(el); |
| 597 |
return result; |
| 598 |
} |
| 599 |
|
| 600 |
var toc = document.getElementById("toc"); |
| 601 |
if (!toc) { |
| 602 |
return; |
| 603 |
} |
| 604 |
|
| 605 |
// Delete existing TOC entries in case we're reloading the TOC. |
| 606 |
var tocEntriesToRemove = []; |
| 607 |
var i; |
| 608 |
for (i = 0; i < toc.childNodes.length; i++) { |
| 609 |
var entry = toc.childNodes[i]; |
| 610 |
if (entry.nodeName.toLowerCase() == 'div' |
| 611 |
&& entry.getAttribute("class") |
| 612 |
&& entry.getAttribute("class").match(/^toclevel/)) |
| 613 |
tocEntriesToRemove.push(entry); |
| 614 |
} |
| 615 |
for (i = 0; i < tocEntriesToRemove.length; i++) { |
| 616 |
toc.removeChild(tocEntriesToRemove[i]); |
| 617 |
} |
| 618 |
|
| 619 |
// Rebuild TOC entries. |
| 620 |
var entries = tocEntries(document.getElementById("content"), toclevels); |
| 621 |
for (var i = 0; i < entries.length; ++i) { |
| 622 |
var entry = entries[i]; |
| 623 |
if (entry.element.id == "") |
| 624 |
entry.element.id = "_toc_" + i; |
| 625 |
var a = document.createElement("a"); |
| 626 |
a.href = "#" + entry.element.id; |
| 627 |
a.appendChild(document.createTextNode(entry.text)); |
| 628 |
var div = document.createElement("div"); |
| 629 |
div.appendChild(a); |
| 630 |
div.className = "toclevel" + entry.toclevel; |
| 631 |
toc.appendChild(div); |
| 632 |
} |
| 633 |
if (entries.length == 0) |
| 634 |
toc.parentNode.removeChild(toc); |
| 635 |
}, |
| 636 |
|
| 637 |
|
| 638 |
///////////////////////////////////////////////////////////////////// |
| 639 |
// Footnotes generator |
| 640 |
///////////////////////////////////////////////////////////////////// |
| 641 |
|
| 642 |
/* Based on footnote generation code from: |
| 643 |
* http://www.brandspankingnew.net/archive/2005/07/format_footnote.html |
| 644 |
*/ |
| 645 |
|
| 646 |
footnotes: function () { |
| 647 |
// Delete existing footnote entries in case we're reloading the footnodes. |
| 648 |
var i; |
| 649 |
var noteholder = document.getElementById("footnotes"); |
| 650 |
if (!noteholder) { |
| 651 |
return; |
| 652 |
} |
| 653 |
var entriesToRemove = []; |
| 654 |
for (i = 0; i < noteholder.childNodes.length; i++) { |
| 655 |
var entry = noteholder.childNodes[i]; |
| 656 |
if (entry.nodeName.toLowerCase() == 'div' && entry.getAttribute("class") == "footnote") |
| 657 |
entriesToRemove.push(entry); |
| 658 |
} |
| 659 |
for (i = 0; i < entriesToRemove.length; i++) { |
| 660 |
noteholder.removeChild(entriesToRemove[i]); |
| 661 |
} |
| 662 |
|
| 663 |
// Rebuild footnote entries. |
| 664 |
var cont = document.getElementById("content"); |
| 665 |
var spans = cont.getElementsByTagName("span"); |
| 666 |
var refs = {}; |
| 667 |
var n = 0; |
| 668 |
for (i=0; i<spans.length; i++) { |
| 669 |
if (spans[i].className == "footnote") { |
| 670 |
n++; |
| 671 |
var note = spans[i].getAttribute("data-note"); |
| 672 |
if (!note) { |
| 673 |
// Use [\s\S] in place of . so multi-line matches work. |
| 674 |
// Because JavaScript has no s (dotall) regex flag. |
| 675 |
note = spans[i].innerHTML.match(/\s*\[([\s\S]*)]\s*/)[1]; |
| 676 |
spans[i].innerHTML = |
| 677 |
"[<a id='_footnoteref_" + n + "' href='#_footnote_" + n + |
| 678 |
"' title='View footnote' class='footnote'>" + n + "</a>]"; |
| 679 |
spans[i].setAttribute("data-note", note); |
| 680 |
} |
| 681 |
noteholder.innerHTML += |
| 682 |
"<div class='footnote' id='_footnote_" + n + "'>" + |
| 683 |
"<a href='#_footnoteref_" + n + "' title='Return to text'>" + |
| 684 |
n + "</a>. " + note + "</div>"; |
| 685 |
var id =spans[i].getAttribute("id"); |
| 686 |
if (id != null) refs["#"+id] = n; |
| 687 |
} |
| 688 |
} |
| 689 |
if (n == 0) |
| 690 |
noteholder.parentNode.removeChild(noteholder); |
| 691 |
else { |
| 692 |
// Process footnoterefs. |
| 693 |
for (i=0; i<spans.length; i++) { |
| 694 |
if (spans[i].className == "footnoteref") { |
| 695 |
var href = spans[i].getElementsByTagName("a")[0].getAttribute("href"); |
| 696 |
href = href.match(/#.*/)[0]; // Because IE return full URL. |
| 697 |
n = refs[href]; |
| 698 |
spans[i].innerHTML = |
| 699 |
"[<a href='#_footnote_" + n + |
| 700 |
"' title='View footnote' class='footnote'>" + n + "</a>]"; |
| 701 |
} |
| 702 |
} |
| 703 |
} |
| 704 |
}, |
| 705 |
|
| 706 |
install: function(toclevels) { |
| 707 |
var timerId; |
| 708 |
|
| 709 |
function reinstall() { |
| 710 |
asciidoc.footnotes(); |
| 711 |
if (toclevels) { |
| 712 |
asciidoc.toc(toclevels); |
| 713 |
} |
| 714 |
} |
| 715 |
|
| 716 |
function reinstallAndRemoveTimer() { |
| 717 |
clearInterval(timerId); |
| 718 |
reinstall(); |
| 719 |
} |
| 720 |
|
| 721 |
timerId = setInterval(reinstall, 500); |
| 722 |
if (document.addEventListener) |
| 723 |
document.addEventListener("DOMContentLoaded", reinstallAndRemoveTimer, false); |
| 724 |
else |
| 725 |
window.onload = reinstallAndRemoveTimer; |
| 726 |
} |
| 727 |
|
| 728 |
} |
| 729 |
asciidoc.install(); |
| 730 |
/*]]>*/ |
| 731 |
</script> |
| 732 |
</head> |
| 733 |
<body class="manpage"> |
| 734 |
<div id="header"> |
| 735 |
<h1> |
| 736 |
ASCIIDOC(1) Manual Page |
| 737 |
</h1> |
| 738 |
<h2>NAME</h2> |
| 739 |
<div class="sectionbody"> |
| 740 |
<p>asciidoc - |
| 741 |
converts an AsciiDoc text file to HTML or DocBook |
| 742 |
</p> |
| 743 |
</div> |
| 744 |
</div> |
| 745 |
<div id="content"> |
| 746 |
<div class="sect1"> |
| 747 |
<h2 id="_synopsis">SYNOPSIS</h2> |
| 748 |
<div class="sectionbody"> |
| 749 |
<div class="paragraph"><p><strong>asciidoc</strong> [<em>OPTIONS</em>] <em>FILE</em></p></div> |
| 750 |
</div> |
| 751 |
</div> |
| 752 |
<div class="sect1"> |
| 753 |
<h2 id="_description">DESCRIPTION</h2> |
| 754 |
<div class="sectionbody"> |
| 755 |
<div class="paragraph"><p>The asciidoc(1) command translates the AsciiDoc text file <em>FILE</em> to |
| 756 |
DocBook or HTML. If <em>FILE</em> is <em>-</em> then the standard input is used.</p></div> |
| 757 |
</div> |
| 758 |
</div> |
| 759 |
<div class="sect1"> |
| 760 |
<h2 id="_options">OPTIONS</h2> |
| 761 |
<div class="sectionbody"> |
| 762 |
<div class="dlist"><dl> |
| 763 |
<dt class="hdlist1"> |
| 764 |
<strong>-a, --attribute</strong>=<em>ATTRIBUTE</em> |
| 765 |
</dt> |
| 766 |
<dd> |
| 767 |
<p> |
| 768 |
Define or delete document attribute. <em>ATTRIBUTE</em> is formatted like |
| 769 |
<em>NAME=VALUE</em>. Command-line attributes take precedence over |
| 770 |
document and configuration file attributes. Alternate acceptable |
| 771 |
forms are <em>NAME</em> (the <em>VALUE</em> defaults to an empty string); |
| 772 |
<em>NAME!</em> (delete the <em>NAME</em> attribute); <em>NAME=VALUE@</em> (do not override |
| 773 |
document or configuration file attributes). Values containing |
| 774 |
spaces should be enclosed in double-quote characters. This option |
| 775 |
may be specified more than once. A special attribute named |
| 776 |
<em>trace</em> controls the output of diagnostic information. |
| 777 |
</p> |
| 778 |
</dd> |
| 779 |
<dt class="hdlist1"> |
| 780 |
<strong>-b, --backend</strong>=<em>BACKEND</em> |
| 781 |
</dt> |
| 782 |
<dd> |
| 783 |
<p> |
| 784 |
Backend output file format: <em>docbook45</em>, <em>docbook5</em>, <em>xhtml11</em>, <em>html4</em>, |
| 785 |
<em>html5</em>, <em>slidy</em>, <em>wordpress</em> or <em>latex</em> (the <em>latex</em> backend is |
| 786 |
experimental). You can also use the backend alias names <em>html</em> |
| 787 |
(aliased to <em>xhtml11</em>) or <em>docbook</em> (aliased to <em>docbook45</em>). |
| 788 |
Defaults to <em>html</em>. The <strong>--backend</strong> option is also used to manage |
| 789 |
backend plugins (see <a href="#X1"><strong>PLUGIN COMMANDS</strong></a>). |
| 790 |
</p> |
| 791 |
</dd> |
| 792 |
<dt class="hdlist1"> |
| 793 |
<strong>-f, --conf-file</strong>=<em>CONF_FILE</em> |
| 794 |
</dt> |
| 795 |
<dd> |
| 796 |
<p> |
| 797 |
Use configuration file <em>CONF_FILE</em>.Configuration files processed |
| 798 |
in command-line order (after implicit configuration files). This |
| 799 |
option may be specified more than once. |
| 800 |
</p> |
| 801 |
</dd> |
| 802 |
<dt class="hdlist1"> |
| 803 |
<strong>--doctest</strong> |
| 804 |
</dt> |
| 805 |
<dd> |
| 806 |
<p> |
| 807 |
Run Python doctests in <em>asciidoc</em> module. |
| 808 |
</p> |
| 809 |
</dd> |
| 810 |
<dt class="hdlist1"> |
| 811 |
<strong>-d, --doctype</strong>=<em>DOCTYPE</em> |
| 812 |
</dt> |
| 813 |
<dd> |
| 814 |
<p> |
| 815 |
Document type: <em>article</em>, <em>manpage</em> or <em>book</em>. The <em>book</em> document |
| 816 |
type is only supported by the <em>docbook</em> backends. Default document |
| 817 |
type is <em>article</em>. |
| 818 |
</p> |
| 819 |
</dd> |
| 820 |
<dt class="hdlist1"> |
| 821 |
<strong>-c, --dump-conf</strong> |
| 822 |
</dt> |
| 823 |
<dd> |
| 824 |
<p> |
| 825 |
Dump configuration to stdout. |
| 826 |
</p> |
| 827 |
</dd> |
| 828 |
<dt class="hdlist1"> |
| 829 |
<strong>--filter</strong>=<em>FILTER</em> |
| 830 |
</dt> |
| 831 |
<dd> |
| 832 |
<p> |
| 833 |
Specify the name of a filter to be loaded (used to load filters |
| 834 |
that are not auto-loaded). This option may be specified more than |
| 835 |
once. The <strong>--filter</strong> option is also used to manage filter plugins |
| 836 |
(see <a href="#X1"><strong>PLUGIN COMMANDS</strong></a>). |
| 837 |
</p> |
| 838 |
</dd> |
| 839 |
<dt class="hdlist1"> |
| 840 |
<strong>-h, --help</strong> [<em>TOPIC</em>] |
| 841 |
</dt> |
| 842 |
<dd> |
| 843 |
<p> |
| 844 |
Print help TOPIC. <strong>--help</strong> <em>topics</em> will print a list of help |
| 845 |
topics, <strong>--help</strong> <em>syntax</em> summarizes AsciiDoc syntax, |
| 846 |
<strong>--help</strong> <em>manpage</em> prints the AsciiDoc manpage. |
| 847 |
</p> |
| 848 |
</dd> |
| 849 |
<dt class="hdlist1"> |
| 850 |
<strong>-e, --no-conf</strong> |
| 851 |
</dt> |
| 852 |
<dd> |
| 853 |
<p> |
| 854 |
Exclude implicitly loaded configuration files except for those |
| 855 |
named like the input file (<em>infile.conf</em> and |
| 856 |
<em>infile-backend.conf</em>). |
| 857 |
</p> |
| 858 |
</dd> |
| 859 |
<dt class="hdlist1"> |
| 860 |
<strong>-s, --no-header-footer</strong> |
| 861 |
</dt> |
| 862 |
<dd> |
| 863 |
<p> |
| 864 |
Suppress document header and footer output. |
| 865 |
</p> |
| 866 |
</dd> |
| 867 |
<dt class="hdlist1"> |
| 868 |
<strong>-o, --out-file</strong>=<em>OUT_FILE</em> |
| 869 |
</dt> |
| 870 |
<dd> |
| 871 |
<p> |
| 872 |
Write output to file <em>OUT_FILE</em>. Defaults to the base name of |
| 873 |
input file with <em>backend</em> extension. If the input is stdin then |
| 874 |
the outfile defaults to stdout. If <em>OUT_FILE</em> is <em>-</em> then the |
| 875 |
standard output is used. |
| 876 |
</p> |
| 877 |
</dd> |
| 878 |
<dt class="hdlist1"> |
| 879 |
<strong>-n, --section-numbers</strong> |
| 880 |
</dt> |
| 881 |
<dd> |
| 882 |
<p> |
| 883 |
Auto-number HTML article section titles. Synonym for |
| 884 |
<strong>--attribute numbered</strong>. |
| 885 |
</p> |
| 886 |
</dd> |
| 887 |
<dt class="hdlist1"> |
| 888 |
<strong>--safe</strong> |
| 889 |
</dt> |
| 890 |
<dd> |
| 891 |
<p> |
| 892 |
Enable safe mode. Safe mode is disabled by default. AsciiDoc |
| 893 |
<em>safe mode</em> skips potentially dangerous scripted sections in |
| 894 |
AsciiDoc source files. |
| 895 |
</p> |
| 896 |
</dd> |
| 897 |
<dt class="hdlist1"> |
| 898 |
<strong>--theme</strong>=<em>THEME</em> |
| 899 |
</dt> |
| 900 |
<dd> |
| 901 |
<p> |
| 902 |
Specify a theme name. Synonym for <strong>--attribute theme</strong>=<em>THEME</em>. |
| 903 |
The <strong>--theme</strong> option is also used to manage theme plugins (see |
| 904 |
<a href="#X1"><strong>PLUGIN COMMANDS</strong></a>). |
| 905 |
</p> |
| 906 |
</dd> |
| 907 |
<dt class="hdlist1"> |
| 908 |
<strong>-v, --verbose</strong> |
| 909 |
</dt> |
| 910 |
<dd> |
| 911 |
<p> |
| 912 |
Verbosely print processing information and configuration file |
| 913 |
checks to stderr. |
| 914 |
</p> |
| 915 |
</dd> |
| 916 |
<dt class="hdlist1"> |
| 917 |
<strong>--version</strong> |
| 918 |
</dt> |
| 919 |
<dd> |
| 920 |
<p> |
| 921 |
Print program version number. |
| 922 |
</p> |
| 923 |
</dd> |
| 924 |
</dl></div> |
| 925 |
</div> |
| 926 |
</div> |
| 927 |
<div class="sect1"> |
| 928 |
<h2 id="X1">PLUGIN COMMANDS</h2> |
| 929 |
<div class="sectionbody"> |
| 930 |
<div class="paragraph"><p>The asciidoc(1) <strong>--filter</strong>, <strong>--backend</strong> and <strong>--theme</strong> options are used |
| 931 |
to install, remove and list AsciiDoc filter, backend and theme |
| 932 |
plugins. Syntax:</p></div> |
| 933 |
<div class="literalblock"> |
| 934 |
<div class="content monospaced"> |
| 935 |
<pre>asciidoc OPTION install ZIP_FILE [PLUGINS_DIR] |
| 936 |
asciidoc OPTION remove PLUGIN_NAME [PLUGINS_DIR] |
| 937 |
asciidoc OPTION list |
| 938 |
asciidoc OPTION build ZIP_FILE PLUGIN_SOURCE</pre> |
| 939 |
</div></div> |
| 940 |
<div class="paragraph"><p>Where:</p></div> |
| 941 |
<div class="dlist"><dl> |
| 942 |
<dt class="hdlist1"> |
| 943 |
<strong>OPTION</strong> |
| 944 |
</dt> |
| 945 |
<dd> |
| 946 |
<p> |
| 947 |
asciidoc(1) <strong>--filter</strong>, <strong>--backend</strong> or <strong>--theme</strong> option specifying |
| 948 |
the type of plugin. |
| 949 |
</p> |
| 950 |
</dd> |
| 951 |
<dt class="hdlist1"> |
| 952 |
<strong>PLUGIN_NAME</strong> |
| 953 |
</dt> |
| 954 |
<dd> |
| 955 |
<p> |
| 956 |
A unique plugin name containing only alphanumeric or underscore |
| 957 |
characters. |
| 958 |
</p> |
| 959 |
</dd> |
| 960 |
<dt class="hdlist1"> |
| 961 |
<strong>ZIP_FILE</strong> |
| 962 |
</dt> |
| 963 |
<dd> |
| 964 |
<p> |
| 965 |
A Zip file containing plugin resources, the name must start with the |
| 966 |
plugin name e.g. <span class="monospaced">my_filter-1.0.zip</span> packages filter <span class="monospaced">my_filter</span>. |
| 967 |
</p> |
| 968 |
</dd> |
| 969 |
<dt class="hdlist1"> |
| 970 |
<strong>PLUGINS_DIR</strong> |
| 971 |
</dt> |
| 972 |
<dd> |
| 973 |
<p> |
| 974 |
The directory containing installed plugins. Each plugin is contained |
| 975 |
in its own separate subdirectory which has the same name as the |
| 976 |
plugin. |
| 977 |
<strong>PLUGINS_DIR</strong> defaults to the <span class="monospaced">$HOME/.asciidoc/filters</span> (for |
| 978 |
filter plugins) or <span class="monospaced">$HOME/.asciidoc/backends</span> (for backend plugins) or |
| 979 |
<span class="monospaced">$HOME/.asciidoc/themes</span> (for theme plugins). |
| 980 |
</p> |
| 981 |
</dd> |
| 982 |
<dt class="hdlist1"> |
| 983 |
<strong>PLUGIN_SOURCE</strong> |
| 984 |
</dt> |
| 985 |
<dd> |
| 986 |
<p> |
| 987 |
The name of a directory containing the plugin source files or the |
| 988 |
name of a single source file. |
| 989 |
</p> |
| 990 |
</dd> |
| 991 |
</dl></div> |
| 992 |
<div class="paragraph"><p>The plugin commands perform as follows:</p></div> |
| 993 |
<div class="dlist"><dl> |
| 994 |
<dt class="hdlist1"> |
| 995 |
<strong>install</strong> |
| 996 |
</dt> |
| 997 |
<dd> |
| 998 |
<p> |
| 999 |
Create a subdirectory in <strong>PLUGINS_DIR</strong> with the same name as the |
| 1000 |
plugin then extract the <strong>ZIP_FILE</strong> into it. |
| 1001 |
</p> |
| 1002 |
</dd> |
| 1003 |
<dt class="hdlist1"> |
| 1004 |
<strong>remove</strong> |
| 1005 |
</dt> |
| 1006 |
<dd> |
| 1007 |
<p> |
| 1008 |
Delete the <strong>PLUGIN_NAME</strong> plugin subdirectory and all its contents |
| 1009 |
from the <strong>PLUGINS_DIR</strong>. |
| 1010 |
</p> |
| 1011 |
</dd> |
| 1012 |
<dt class="hdlist1"> |
| 1013 |
<strong>list</strong> |
| 1014 |
</dt> |
| 1015 |
<dd> |
| 1016 |
<p> |
| 1017 |
List the names and locations of all installed filter or theme |
| 1018 |
plugins (including standard plugins installed in the global |
| 1019 |
configuration directory). |
| 1020 |
</p> |
| 1021 |
</dd> |
| 1022 |
<dt class="hdlist1"> |
| 1023 |
<strong>build</strong> |
| 1024 |
</dt> |
| 1025 |
<dd> |
| 1026 |
<p> |
| 1027 |
Create a plugin file named <strong>ZIP_FILE</strong> containing the files and |
| 1028 |
subdirectories specified by <strong>PLUGIN_SOURCE</strong>. File and directory |
| 1029 |
names starting with a period are skipped. |
| 1030 |
</p> |
| 1031 |
</dd> |
| 1032 |
</dl></div> |
| 1033 |
</div> |
| 1034 |
</div> |
| 1035 |
<div class="sect1"> |
| 1036 |
<h2 id="_environment_variables">ENVIRONMENT VARIABLES</h2> |
| 1037 |
<div class="sectionbody"> |
| 1038 |
<div class="dlist"><dl> |
| 1039 |
<dt class="hdlist1"> |
| 1040 |
<strong><span class="monospaced">SOURCE_DATE_EPOCH</span></strong> |
| 1041 |
</dt> |
| 1042 |
<dd> |
| 1043 |
<p> |
| 1044 |
If the <span class="monospaced">SOURCE_DATE_EPOCH</span> environment variable is set to a UNIX |
| 1045 |
timestamp, then the <span class="monospaced">{docdate}</span>, <span class="monospaced">{doctime}</span>, <span class="monospaced">{localdate}</span>, and |
| 1046 |
<span class="monospaced">{localtime}</span> attributes are computed in the UTC time zone, with any |
| 1047 |
timestamps newer than <span class="monospaced">SOURCE_DATE_EPOCH</span> replaced by |
| 1048 |
<span class="monospaced">SOURCE_DATE_EPOCH</span>. (This helps software using AsciiDoc to build |
| 1049 |
reproducibly.) |
| 1050 |
</p> |
| 1051 |
</dd> |
| 1052 |
</dl></div> |
| 1053 |
</div> |
| 1054 |
</div> |
| 1055 |
<div class="sect1"> |
| 1056 |
<h2 id="_examples">EXAMPLES</h2> |
| 1057 |
<div class="sectionbody"> |
| 1058 |
<div class="dlist"><dl> |
| 1059 |
<dt class="hdlist1"> |
| 1060 |
<span class="monospaced">asciidoc asciidoc_file_name.txt</span> |
| 1061 |
</dt> |
| 1062 |
<dd> |
| 1063 |
<p> |
| 1064 |
Simply generate an html file from the asciidoc_file_name.txt that is in |
| 1065 |
current directory using asciidoc. |
| 1066 |
</p> |
| 1067 |
</dd> |
| 1068 |
<dt class="hdlist1"> |
| 1069 |
<span class="monospaced">asciidoc -b html5 asciidoc_file_name.txt</span> |
| 1070 |
</dt> |
| 1071 |
<dd> |
| 1072 |
<p> |
| 1073 |
Use the <span class="monospaced">-b</span> switch to use one of the proposed backend or another one you |
| 1074 |
installed on your computer. |
| 1075 |
</p> |
| 1076 |
</dd> |
| 1077 |
<dt class="hdlist1"> |
| 1078 |
<span class="monospaced">asciidoc -a data-uri -a icons -a toc -a max-width=55em article.txt</span> |
| 1079 |
</dt> |
| 1080 |
<dd> |
| 1081 |
<p> |
| 1082 |
Use the <span class="monospaced">-a</span> switch to set attributes from command-line. AsciiDoc generated |
| 1083 |
its stand-alone HTML user guide containing embedded CSS, JavaScript and |
| 1084 |
images from the AsciiDoc article template with this command. |
| 1085 |
</p> |
| 1086 |
</dd> |
| 1087 |
<dt class="hdlist1"> |
| 1088 |
<span class="monospaced">asciidoc -b html5 -d manpage asciidoc.1.txt</span> |
| 1089 |
</dt> |
| 1090 |
<dd> |
| 1091 |
<p> |
| 1092 |
Generating the asciidoc manpage using the html5 backend. |
| 1093 |
</p> |
| 1094 |
</dd> |
| 1095 |
</dl></div> |
| 1096 |
</div> |
| 1097 |
</div> |
| 1098 |
<div class="sect1"> |
| 1099 |
<h2 id="_exit_status">EXIT STATUS</h2> |
| 1100 |
<div class="sectionbody"> |
| 1101 |
<div class="dlist"><dl> |
| 1102 |
<dt class="hdlist1"> |
| 1103 |
<strong>0</strong> |
| 1104 |
</dt> |
| 1105 |
<dd> |
| 1106 |
<p> |
| 1107 |
Success |
| 1108 |
</p> |
| 1109 |
</dd> |
| 1110 |
<dt class="hdlist1"> |
| 1111 |
<strong>1</strong> |
| 1112 |
</dt> |
| 1113 |
<dd> |
| 1114 |
<p> |
| 1115 |
Failure (syntax or usage error; configuration error; document |
| 1116 |
processing failure; unexpected error). |
| 1117 |
</p> |
| 1118 |
</dd> |
| 1119 |
</dl></div> |
| 1120 |
</div> |
| 1121 |
</div> |
| 1122 |
<div class="sect1"> |
| 1123 |
<h2 id="_bugs">BUGS</h2> |
| 1124 |
<div class="sectionbody"> |
| 1125 |
<div class="paragraph"><p>See the AsciiDoc distribution BUGS file.</p></div> |
| 1126 |
</div> |
| 1127 |
</div> |
| 1128 |
<div class="sect1"> |
| 1129 |
<h2 id="_author">AUTHOR</h2> |
| 1130 |
<div class="sectionbody"> |
| 1131 |
<div class="paragraph"><p>AsciiDoc was originally written by Stuart Rackham. Many people have |
| 1132 |
contributed to it.</p></div> |
| 1133 |
</div> |
| 1134 |
</div> |
| 1135 |
<div class="sect1"> |
| 1136 |
<h2 id="_resources">RESOURCES</h2> |
| 1137 |
<div class="sectionbody"> |
| 1138 |
<div class="paragraph"><p>GitHub: <a href="https://github.com/asciidoc/asciidoc-py3/">https://github.com/asciidoc/asciidoc-py3/</a></p></div> |
| 1139 |
<div class="paragraph"><p>Main web site: <a href="https://asciidoc.org/">https://asciidoc.org/</a></p></div> |
| 1140 |
</div> |
| 1141 |
</div> |
| 1142 |
<div class="sect1"> |
| 1143 |
<h2 id="_see_also">SEE ALSO</h2> |
| 1144 |
<div class="sectionbody"> |
| 1145 |
<div class="paragraph"><p>a2x(1)</p></div> |
| 1146 |
</div> |
| 1147 |
</div> |
| 1148 |
<div class="sect1"> |
| 1149 |
<h2 id="_copying">COPYING</h2> |
| 1150 |
<div class="sectionbody"> |
| 1151 |
<div class="paragraph"><p>Copyright (C) 2002-2013 Stuart Rackham.</p></div> |
| 1152 |
<div class="paragraph"><p>Copyright (C) 2013-2020 AsciiDoc Contributors.</p></div> |
| 1153 |
<div class="paragraph"><p>Free use of this software is granted under the terms of the GNU General |
| 1154 |
Public License version 2 (GPLv2).</p></div> |
| 1155 |
</div> |
| 1156 |
</div> |
| 1157 |
</div> |
| 1158 |
<div id="footnotes"><hr></div> |
| 1159 |
<div id="footer"> |
| 1160 |
<div id="footer-text"> |
| 1161 |
Last updated |
| 1162 |
2002-11-25 00:37:42 UTC |
| 1163 |
</div> |
| 1164 |
</div> |
| 1165 |
</body> |
| 1166 |
</html> |