diff options
| author | Dan Allen <dan.j.allen@gmail.com> | 2013-07-08 23:35:36 -0600 |
|---|---|---|
| committer | Dan Allen <dan.j.allen@gmail.com> | 2013-07-08 23:35:36 -0600 |
| commit | 36cfcb6f7b5c0419f88bba3e2c63750daa84505f (patch) | |
| tree | b5c650febb9a250e6cf69dc04bd5171bb1be4516 /man | |
| parent | ed0c789a834fee25d7455a4a117105c2529244b8 (diff) | |
atx-style headings in manpage; generate w/ Asciidoctor
Diffstat (limited to 'man')
| -rw-r--r-- | man/asciidoctor.1 | 115 | ||||
| -rw-r--r-- | man/asciidoctor.ad | 55 |
2 files changed, 46 insertions, 124 deletions
diff --git a/man/asciidoctor.1 b/man/asciidoctor.1 index b74fbc86..7374eaf3 100644 --- a/man/asciidoctor.1 +++ b/man/asciidoctor.1 @@ -1,32 +1,17 @@ '\" t .\" Title: asciidoctor -.\" Author: [see the "AUTHORS" section] -.\" Generator: DocBook XSL Stylesheets v1.78.1 <http://docbook.sf.net/> -.\" Date: 07/01/2013 -.\" Manual: \ \& -.\" Source: \ \& +.\" Author: Dan Allen +.\" Generator: Asciidoctor 0.1.4.preview.3 +.\" Date: 2013-07-07 +.\" Manual: Asciidoctor Manual +.\" Source: Asciidoctor 0.1.3 .\" Language: English .\" -.TH "ASCIIDOCTOR" "1" "07/01/2013" "\ \&" "\ \&" -.\" ----------------------------------------------------------------- -.\" * Define some portability stuff -.\" ----------------------------------------------------------------- -.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.\" http://bugs.debian.org/507673 -.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html -.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.TH "ASCIIDOCTOR" "1" "2013-07-07" "Asciidoctor 0.1.3" "Asciidoctor Manual" .ie \n(.g .ds Aq \(aq .el .ds Aq ' -.\" ----------------------------------------------------------------- -.\" * set default formatting -.\" ----------------------------------------------------------------- -.\" disable hyphenation .nh -.\" disable justification (adjust text to left margin only) .ad l -.\" ----------------------------------------------------------------- -.\" * MAIN CONTENT STARTS HERE * -.\" ----------------------------------------------------------------- .SH "NAME" asciidoctor \- converts AsciiDoc source files to HTML, DocBook and other formats .SH "SYNOPSIS" @@ -47,22 +32,12 @@ Base directory containing the document and resources\&. Defaults to the director .PP \fB\-S, \-\-safe\-mode\fR=\fISAFE_MODE\fR .RS 4 -Set safe mode level: -\fIunsafe\fR, -\fIsafe\fR, -\fIserver\fR -or -\fIsecure\fR\&. Disables potentially dangerous macros in source files, such as include::[]\&. If not set, the safe mode level defaults to -\fIunsafe\fR -when Asciidoctor is invoked using this script\&. +Set safe mode level: \fIunsafe\fR, \fIsafe\fR, \fIserver\fR or \fIsecure\fR\&. Disables potentially dangerous macros in source files, such as include::[]\&. If not set, the safe mode level defaults to \fIunsafe\fR when Asciidoctor is invoked using this script\&. .RE .PP \fB\-\-safe\fR .RS 4 -Set safe mode level to -\fIsafe\fR\&. Enables include macros, but restricts access to ancestor paths of source file\&. Provided for compatibility with the asciidoc command\&. If not set, the safe mode level defaults to -\fIunsafe\fR -when Asciidoctor is invoked using this script\&. +Set safe mode level to \fIsafe\fR\&. Enables include macros, but restricts access to ancestor paths of source file\&. Provided for compatibility with the asciidoc command\&. If not set, the safe mode level defaults to \fIunsafe\fR when Asciidoctor is invoked using this script\&. .RE .SS "Document Settings" .PP @@ -70,59 +45,19 @@ when Asciidoctor is invoked using this script\&. .RS 4 Define, override or delete a document attribute\&. Command\-line attributes take precedence over attributes defined in the source file\&. .sp -\fIATTRIBUTE\fR -is normally formatted as a key\-value pair, in the form -\fINAME=VALUE\fR\&. Alternate acceptable forms are -\fINAME\fR -(where the -\fIVALUE\fR -defaults to an empty string), -\fINAME!\fR -(unassigns the -\fINAME\fR -attribute) and -\fINAME=VALUE@\fR -(where -\fIVALUE\fR -does not override value of -\fINAME\fR -attribute if it\(cqs already defined in the source document)\&. Values containing spaces should be enclosed in quotes\&. +\fIATTRIBUTE\fR is normally formatted as a key\-value pair, in the form \fINAME=VALUE\fR\&. Alternate acceptable forms are \fINAME\fR (where the \fIVALUE\fR defaults to an empty string), \fINAME!\fR (unassigns the \fINAME\fR attribute) and \fINAME=VALUE@\fR (where \fIVALUE\fR does not override value of \fINAME\fR attribute if it\(cqs already defined in the source document)\&. Values containing spaces should be enclosed in quotes\&. .sp This option may be specified more than once\&. .RE .PP \fB\-b, \-\-backend\fR=\fIBACKEND\fR .RS 4 -Backend output file format: -\fIdocbook45\fR -or -\fIhtml5\fR -supported out of the box\&. You can also use the backend alias names -\fIhtml\fR -(aliased to -\fIhtml5\fR) or -\fIdocbook\fR -(aliased to -\fIdocbook45\fR)\&. Defaults to -\fIhtml5\fR\&. Other options can be passed, but if Asciidoctor cannot find the backend, it will fail during rendering\&. +Backend output file format: \fIdocbook45\fR or \fIhtml5\fR supported out of the box\&. You can also use the backend alias names \fIhtml\fR (aliased to \fIhtml5\fR) or \fIdocbook\fR (aliased to \fIdocbook45\fR)\&. Defaults to \fIhtml5\fR\&. Other options can be passed, but if Asciidoctor cannot find the backend, it will fail during rendering\&. .RE .PP \fB\-d, \-\-doctype\fR=\fIDOCTYPE\fR .RS 4 -Document type: -\fIarticle\fR, -\fIbook\fR -or -\fIinline\fR\&. Sets the root element when using the -\fIdocbook\fR -backend and the style class on the HTML body element when using the -\fIhtml\fR -backend\&. The -\fIbook\fR -document type allows multiple level\-0 section titles in a single document\&. The -\fIinline\fR -document type allows the content of a single paragraph to be formatted and returned without wrapping it in a containing element\&. Defaults to -\fIarticle\fR\&. +Document type: \fIarticle\fR, \fIbook\fR or \fIinline\fR\&. Sets the root element when using the \fIdocbook\fR backend and the style class on the HTML body element when using the \fIhtml\fR backend\&. The \fIbook\fR document type allows multiple level\-0 section titles in a single document\&. The \fIinline\fR document type allows the content of a single paragraph to be formatted and returned without wrapping it in a containing element\&. Defaults to \fIarticle\fR\&. .RE .SS "Rendering Control" .PP @@ -143,29 +78,17 @@ Template engine to use for the custom render templates\&. The gem with the same .PP \fB\-e, \-\-eruby\fR .RS 4 -Specifies the eRuby implementation to use for rendering the built\-in templates\&. Supported values are -\fIerb\fR -and -\fIerubis\fR\&. Defaults to -\fIerb\fR\&. +Specifies the eRuby implementation to use for rendering the built\-in templates\&. Supported values are \fIerb\fR and \fIerubis\fR\&. Defaults to \fIerb\fR\&. .RE .PP \fB\-n, \-\-section\-numbers\fR .RS 4 -Auto\-number section titles\&. Synonym for -\fB\-\-attribute numbered\fR\&. +Auto\-number section titles\&. Synonym for \fB\-\-attribute numbered\fR\&. .RE .PP \fB\-o, \-\-out\-file\fR=\fIOUT_FILE\fR .RS 4 -Write output to file -\fIOUT_FILE\fR\&. Defaults to the base name of the input file suffixed with -\fIbackend\fR -extension\&. If the input is read from standard input, then the output file defaults to stdout\&. If -\fIOUT_FILE\fR -is -\fI\-\fR -then the standard output is also used\&. If specified, the file is resolved relative to the working directory\&. +Write output to file \fIOUT_FILE\fR\&. Defaults to the base name of the input file suffixed with \fIbackend\fR extension\&. If the input is read from standard input, then the output file defaults to stdout\&. If \fIOUT_FILE\fR is \fI\-\fR then the standard output is also used\&. If specified, the file is resolved relative to the working directory\&. .RE .PP \fB\-s, \-\-no\-header\-footer\fR @@ -175,9 +98,7 @@ Suppress the document header and footer in the output\&. .PP \fB\-T, \-\-template\-dir\fR=\fIDIR\fR .RS 4 -A directory containing custom render templates that override one or more templates from the built\-in set\&. (requires -\fItilt\fR -gem) +A directory containing custom render templates that override one or more templates from the built\-in set\&. (requires \fItilt\fR gem) .sp If there is a subfolder that matches the engine name (if specified), that folder is appended to the template directory path\&. Similarly, if there is a subfolder in the resulting template directory that matches the name of the backend, that folder is appended to the template directory path\&. .sp @@ -236,3 +157,9 @@ Mailinglist / forum: <\fBhttp://discuss\&.asciidoctor\&.org\fR> .SH "COPYING" .sp Copyright (C) 2012\-2013 Dan Allen and Ryan Waldron\&. Free use of this software is granted under the terms of the MIT License\&. +.SH "AUTHOR" +.PP +\fBDan Allen\fR +.RS 4 +Author. +.RE
\ No newline at end of file diff --git a/man/asciidoctor.ad b/man/asciidoctor.ad index 27f2dab0..c5bfe4e3 100644 --- a/man/asciidoctor.ad +++ b/man/asciidoctor.ad @@ -1,32 +1,31 @@ -asciidoctor(1) -============== += asciidoctor(1) +Dan Allen; Ryan Waldron :doctype: manpage +:man manual: Asciidoctor Manual +:man source: Asciidoctor 0.1.3 :awestruct-layout: base +== NAME -NAME ----- asciidoctor - converts AsciiDoc source files to HTML, DocBook and other formats -SYNOPSIS --------- +== SYNOPSIS + *asciidoctor* ['OPTION']... 'FILE'... -DESCRIPTION ------------ +== DESCRIPTION + The asciidoctor(1) command converts the AsciiDoc source file(s) 'FILE' to HTML 5, DocBook 4.5 and other output formats. If 'FILE' is '-' then the AsciiDoc source is read from standard input. -OPTIONS -------- +== OPTIONS -Security Settings -~~~~~~~~~~~~~~~~~ +=== Security Settings *-B, --base-dir*='DIR':: Base directory containing the document and resources. Defaults to the @@ -46,8 +45,7 @@ Security Settings asciidoc command. If not set, the safe mode level defaults to 'unsafe' when Asciidoctor is invoked using this script. -Document Settings -~~~~~~~~~~~~~~~~~ +=== Document Settings *-a, --attribute*='ATTRIBUTE':: Define, override or delete a document attribute. Command-line attributes @@ -76,8 +74,7 @@ This option may be specified more than once. allows the content of a single paragraph to be formatted and returned without wrapping it in a containing element. Defaults to 'article'. -Rendering Control -~~~~~~~~~~~~~~~~~ +=== Rendering Control *-C, --compact*:: Compact the output by removing blank lines. Not enabled by default. @@ -121,8 +118,7 @@ folder is appended to the template directory path. This option may be specified more than once. Matching templates found in subsequent directories override ones previously discovered. -Processing Information -~~~~~~~~~~~~~~~~~~~~~~ +=== Processing Information *--trace*:: Include backtrace information on errors. Not enabled by default. @@ -131,8 +127,7 @@ Processing Information Verbosely print processing information and configuration file checks to stderr. -Program Information -~~~~~~~~~~~~~~~~~~~ +=== Program Information *-h, --help*:: Show the help message. @@ -141,8 +136,8 @@ Program Information Print program version number. -EXIT STATUS ------------ +== EXIT STATUS + *0*:: Success @@ -151,13 +146,13 @@ EXIT STATUS failure; unexpected error). -BUGS ----- +== BUGS + See the *Asciidoctor* issue tracker: <**https://github.com/asciidoctor/asciidoctor/issues?state=open**> -AUTHORS -------- +== AUTHORS + *Asciidoctor* was written by Dan Allen, Ryan Waldron, Jason Porter, Nick Hengeveld and other contributors. @@ -165,8 +160,8 @@ Hengeveld and other contributors. many other individuals. -RESOURCES ---------- +== RESOURCES + Git source repository on GitHub: <**https://github.com/asciidoctor/asciidoctor**> Project web site: <**http://asciidoctor.org**> @@ -176,8 +171,8 @@ GitHub organization: <**http://github.com/asciidoctor**> Mailinglist / forum: <**http://discuss.asciidoctor.org**> -COPYING -------- +== COPYING + Copyright \(C) 2012-2013 Dan Allen and Ryan Waldron. Free use of this software is granted under the terms of the MIT License. |
