Debian Codegraph @

tests/inputs/asciidoctor.adoc

raw
1 // https://raw.githubusercontent.com/asciidoctor/asciidoctor/master/man/asciidoctor.adoc
2 // Stripped down, added block comments for cloc
3 = asciidoctor(1)
4 Dan Allen; Sarah White; Ryan Waldron
5 :doctype: manpage
6 :man manual: Asciidoctor Manual
7 :man source: Asciidoctor 1.5.6.1
8 :page-layout: base
9
10 == NAME
11
12 asciidoctor - converts AsciiDoc source files to HTML, DocBook and other formats
13
14 == SYNOPSIS
15
16 *asciidoctor* [_OPTION_]... _FILE_...
17
18 == DESCRIPTION
19
20 The asciidoctor(1) command converts the AsciiDoc source file(s) _FILE_ to HTML5, DocBook 5, DocBook 4.5, man(ual) page and other custom output formats.
21
22 If _FILE_ is _-_ then the AsciiDoc source is read from standard input.
23
24 == OPTIONS
25 ////
26 === Security Settings
27
28 *-B, --base-dir*=_DIR_::
29 Base directory containing the document and resources.
30 Defaults to the directory containing the source file, or the working directory if the source is read from a stream.
31 When combined with the safe mode setting, can be used to chroot the execution of the program.
32
33 *-S, --safe-mode*=_SAFE_MODE_::
34 Set safe mode level: _unsafe_, _safe_, _server_ or _secure_.
35 Disables potentially dangerous macros in source files, such as `include::[]`.
36 If not set, the safe mode level defaults to _unsafe_ when Asciidoctor is invoked using this script.
37
38 *--safe*::
39 Set safe mode level to _safe_.
40 Enables include directives, but prevents access to ancestor paths of source file.
41 Provided for compatibility with the asciidoc command.
42 If not set, the safe mode level defaults to _unsafe_ when Asciidoctor is invoked using this script.
43
44 === Document Settings
45 ////
46
47 *-a, --attribute*=_ATTRIBUTE_::
48 Define, override or delete a document attribute.
49 Command-line attributes take precedence over attributes defined in the source file unless the value ends with _@_.
50 +
51 _ATTRIBUTE_ is normally formatted as a key-value pair, in the form _NAME=VALUE_.
52 Alternate acceptable forms are _NAME_ (where the _VALUE_ defaults to an empty string), _NAME!_ (unassigns the _NAME_ attribute) and _NAME=VALUE@_ (where _VALUE_ does not override value of _NAME_ attribute if it's already defined in the source document).
53 Values containing spaces should be enclosed in quotes.
54 +
55 This option may be specified more than once.
56
57 ////
58 *-b, --backend*=_BACKEND_::
59 Backend output file format: _html5_, _docbook5_, _docbook45_ and _manpage_ are supported out of the box.
60 You can also use the backend alias names _html_ (aliased to _html5_) or _docbook_ (aliased to _docbook5_).
61 Other values can be passed, but if Asciidoctor cannot resolve the backend to a converter, it will fail.
62 Defaults to _html5_.
63 ////
64
65 *-d, --doctype*=_DOCTYPE_::
66 Document type: _article_, _book_, _manpage_ or _inline_.
67 Sets the root element when using the _docbook_ backend and the style class on the HTML body element when using the _html_ backend.
68 The _book_ document type allows multiple level-0 section titles in a single document.
69 The _manpage_ document type enables parsing of metadata necessary to produce a man page.
70 The _inline_ document type allows the content of a single paragraph to be formatted and returned without wrapping it in a containing element.
71 Defaults to _article_.
72
73 === Rendering Control
74
75 *-C, --compact*::
76 Compact the output by removing blank lines.
77 (No longer in use).
78 // file truncated here