summaryrefslogtreecommitdiff
path: root/man
diff options
context:
space:
mode:
authorDan Allen <dan.j.allen@gmail.com>2013-09-05 16:39:40 -0600
committerDan Allen <dan.j.allen@gmail.com>2013-09-05 16:44:35 -0600
commita9eb5b54630502c865f94b3bebf566f83fddd485 (patch)
treea02eb16e7b062bd963d11a949c32db39cac63dc6 /man
parent75fd23cd4b5e1bbfd56d171c4f5122ed563b1228 (diff)
add docbook5 backend & manpage doctype to man page and command options
Diffstat (limited to 'man')
-rw-r--r--man/asciidoctor.118
-rw-r--r--man/asciidoctor.adoc28
2 files changed, 23 insertions, 23 deletions
diff --git a/man/asciidoctor.1 b/man/asciidoctor.1
index 7374eaf3..e5caebb5 100644
--- a/man/asciidoctor.1
+++ b/man/asciidoctor.1
@@ -1,25 +1,23 @@
'\" t
.\" Title: asciidoctor
.\" Author: Dan Allen
-.\" Generator: Asciidoctor 0.1.4.preview.3
-.\" Date: 2013-07-07
+.\" Generator: Asciidoctor 0.1.4
+.\" Date: 2013-09-05
.\" Manual: Asciidoctor Manual
-.\" Source: Asciidoctor 0.1.3
+.\" Source: Asciidoctor 0.1.4
.\" Language: English
.\"
-.TH "ASCIIDOCTOR" "1" "2013-07-07" "Asciidoctor 0.1.3" "Asciidoctor Manual"
+.TH "ASCIIDOCTOR" "1" "2013-09-05" "Asciidoctor 0\&.1\&.4" "Asciidoctor Manual"
.ie \n(.g .ds Aq \(aq
.el .ds Aq '
.nh
.ad l
-.SH "NAME"
-asciidoctor \- converts AsciiDoc source files to HTML, DocBook and other formats
.SH "SYNOPSIS"
.sp
\fBasciidoctor\fR [\fIOPTION\fR]\&... \fIFILE\fR\&...
.SH "DESCRIPTION"
.sp
-The asciidoctor(1) command converts the AsciiDoc source file(s) \fIFILE\fR to HTML 5, DocBook 4\&.5 and other output formats\&.
+The asciidoctor(1) command converts the AsciiDoc source file(s) \fIFILE\fR to HTML 5, DocBook 4\&.5, DocBook 5\&.0 and other custom output formats\&.
.sp
If \fIFILE\fR is \fI\-\fR then the AsciiDoc source is read from standard input\&.
.SH "OPTIONS"
@@ -52,12 +50,12 @@ This option may be specified more than once\&.
.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: \fIhtml5\fR, \fIdocbook45\fR and \fIdocbook5\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, \fImanpage\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 \fImanpage\fR document type enables parsing of metadata necessary to produce a manpage\&. 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
@@ -162,4 +160,4 @@ Copyright (C) 2012\-2013 Dan Allen and Ryan Waldron\&. Free use of this software
\fBDan Allen\fR
.RS 4
Author.
-.RE \ No newline at end of file
+.RE
diff --git a/man/asciidoctor.adoc b/man/asciidoctor.adoc
index c5bfe4e3..3cfffe40 100644
--- a/man/asciidoctor.adoc
+++ b/man/asciidoctor.adoc
@@ -2,7 +2,7 @@
Dan Allen; Ryan Waldron
:doctype: manpage
:man manual: Asciidoctor Manual
-:man source: Asciidoctor 0.1.3
+:man source: Asciidoctor 0.1.4
:awestruct-layout: base
== NAME
@@ -18,7 +18,7 @@ asciidoctor - converts AsciiDoc source files to HTML, DocBook and other formats
== DESCRIPTION
The asciidoctor(1) command converts the AsciiDoc source file(s) 'FILE' to HTML 5,
-DocBook 4.5 and other output formats.
+DocBook 4.5, DocBook 5.0 and other custom output formats.
If 'FILE' is '-' then the AsciiDoc source is read from standard input.
@@ -60,19 +60,21 @@ the source document). Values containing spaces should be enclosed in quotes.
This option may be specified more than once.
*-b, --backend*='BACKEND'::
- Backend output file format: 'docbook45' or 'html5' supported out of the box.
- You can also use the backend alias names 'html' (aliased to 'html5') or
- 'docbook' (aliased to 'docbook45'). Defaults to 'html5'. Other options can
- be passed, but if Asciidoctor cannot find the backend, it will fail during
- rendering.
+ Backend output file format: 'html5', 'docbook45' and 'docbook5' supported
+ out of the box. You can also use the backend alias names 'html' (aliased to
+ 'html5') or 'docbook' (aliased to 'docbook45'). Defaults to 'html5'. Other
+ options can be passed, but if Asciidoctor cannot find the backend, it will
+ fail during rendering.
*-d, --doctype*='DOCTYPE'::
- Document type: 'article', 'book' or 'inline'. Sets the root element when
- using the 'docbook' backend and the style class on the HTML body element
- when using the 'html' backend. The 'book' document type allows multiple
- level-0 section titles in a single document. The 'inline' document type
- allows the content of a single paragraph to be formatted and returned
- without wrapping it in a containing element. Defaults to 'article'.
+ Document type: 'article', 'book', 'manpage' or 'inline'. Sets the root
+ element when using the 'docbook' backend and the style class on the HTML
+ body element when using the 'html' backend. The 'book' document type allows
+ multiple level-0 section titles in a single document. The 'manpage' document
+ type enables parsing of metadata necessary to produce a manpage. The
+ 'inline' document type allows the content of a single paragraph to be
+ formatted and returned without wrapping it in a containing element. Defaults
+ to 'article'.
=== Rendering Control