man/asciidoctor.1 in asciidoctor-1.5.6.2 vs man/asciidoctor.1 in asciidoctor-1.5.7

- old
+ new

@@ -1,25 +1,34 @@ '\" t .\" Title: asciidoctor .\" Author: Dan Allen, Sarah White, Ryan Waldron -.\" Generator: Asciidoctor 1.5.6.2 -.\" Date: 2018-03-20 +.\" Generator: Asciidoctor 1.5.7 +.\" Date: 2018-05-02 .\" Manual: Asciidoctor Manual -.\" Source: Asciidoctor 1.5.6.2 +.\" Source: Asciidoctor 1.5.7 .\" Language: English .\" -.TH "ASCIIDOCTOR" "1" "2018-03-20" "Asciidoctor 1.5.6.2" "Asciidoctor Manual" +.TH "ASCIIDOCTOR" "1" "2018-05-02" "Asciidoctor 1.5.7" "Asciidoctor Manual" .ie \n(.g .ds Aq \(aq .el .ds Aq ' .ss \n[.ss] 0 .nh .ad l .de URL -\\$2 \(laURL: \\$1 \(ra\\$3 +\fI\\$2\fP <\\$1>\\$3 .. -.if \n[.g] .mso www.tmac -.LINKSTYLE blue R < > +.als MTO URL +.if \n[.g] \{\ +. mso www.tmac +. am URL +. ad l +. . +. am MTO +. ad l +. . +. LINKSTYLE blue R < > +.\} .SH "NAME" asciidoctor \- converts AsciiDoc source files to HTML, DocBook and other formats .SH "SYNOPSIS" .sp \fBasciidoctor\fP [\fIOPTION\fP]... \fIFILE\fP... @@ -39,11 +48,11 @@ .RE .sp \fB\-S, \-\-safe\-mode\fP=\fISAFE_MODE\fP .RS 4 Set safe mode level: \fIunsafe\fP, \fIsafe\fP, \fIserver\fP or \fIsecure\fP. -Disables potentially dangerous macros in source files, such as \f[CR]include::[]\fP. +Disables potentially dangerous macros in source files, such as \f(CRinclude::[]\fP. If not set, the safe mode level defaults to \fIunsafe\fP when Asciidoctor is invoked using this script. .RE .sp \fB\-\-safe\fP .RS 4 @@ -81,18 +90,12 @@ The \fIbook\fP document type allows multiple level\-0 section titles in a single document. The \fImanpage\fP document type enables parsing of metadata necessary to produce a man page. The \fIinline\fP document type allows the content of a single paragraph to be formatted and returned without wrapping it in a containing element. Defaults to \fIarticle\fP. .RE -.SS "Rendering Control" +.SS "Document Conversion" .sp -\fB\-C, \-\-compact\fP -.RS 4 -Compact the output by removing blank lines. -(No longer in use). -.RE -.sp \fB\-D, \-\-destination\-dir\fP=\fIDIR\fP .RS 4 Destination output directory. Defaults to the directory containing the source file, or the working directory if the source is read from a stream. If specified, the directory is resolved relative to the working directory. @@ -120,11 +123,11 @@ .RE .sp \fB\-n, \-\-section\-numbers\fP .RS 4 Auto\-number section titles. -Synonym for \fB\-\-attribute numbered\fP. +Synonym for \fB\-\-attribute sectnums\fP. .RE .sp \fB\-o, \-\-out\-file\fP=\fIOUT_FILE\fP .RS 4 Write output to file \fIOUT_FILE\fP. @@ -132,10 +135,18 @@ The file is resolved relative to the working directory. If the input is read from standard input or a named pipe (fifo), then the output file defaults to stdout. If \fIOUT_FILE\fP is \fI\-\fP, then the output file is written to standard output. .RE .sp +\fB\-R, \-\-source\-dir\fP=\fIDIR\fP +.RS 4 +Source directory. +Currently only used if the destination directory is also specified. +Used to preserve the directory structure of files converted within this directory in the destination directory. +If specified, the directory is resolved relative to the working directory. +.RE +.sp \fB\-r, \-\-require\fP=\fILIBRARY\fP .RS 4 Require the specified library before executing the processor, using the standard Ruby require. This option may be specified more than once. .RE @@ -156,10 +167,16 @@ This option may be specified more than once. Matching templates found in subsequent directories override ones previously discovered. .RE .SS "Processing Information" .sp +\fB\-\-failure\-level\fP=\fILEVEL\fP +.RS 4 +The minimum logging level that triggers a non\-zero exit code (failure). +If this option is not set (default: FATAL), the program exits with a status code zero even if warnings or errors have been logged. +.RE +.sp \fB\-q, \-\-quiet\fP .RS 4 Silence warnings. .RE .sp @@ -189,11 +206,11 @@ .sp \fB\-V, \-\-version\fP .RS 4 Print program version number. .sp -\f[CR]\-v\fP can also be used if no other flags or arguments are present. +\f(CR\-v\fP can also be used if no other flags or arguments are present. .RE .SH "ENVIRONMENT" .sp \fBAsciidoctor\fP honors the \fBSOURCE_DATE_EPOCH\fP environment variable. If this variable is assigned an integer value, that value is used as the epoch of all input documents and as the local date and time. @@ -221,11 +238,11 @@ .sp \fBAsciiDoc\fP was written by Stuart Rackham and has received contributions from many other individuals. .SH "RESOURCES" .sp \fBProject web site:\fP \c -.URL "http://asciidoctor.org" "" "" +.URL "https://asciidoctor.org" "" "" .sp \fBGit source repository on GitHub:\fP \c .URL "https://github.com/asciidoctor/asciidoctor" "" "" .sp \fBGitHub organization:\fP \c @@ -235,11 +252,12 @@ .URL "http://discuss.asciidoctor.org" "" "" .SH "COPYING" .sp Copyright (C) 2012\-2018 Dan Allen, Ryan Waldron and the Asciidoctor Project. Free use of this software is granted under the terms of the MIT License. -.SH "AUTHOR(S)" +.SH "AUTHORS" .sp -\fBDan Allen, Sarah White, Ryan Waldron\fP -.RS 4 -Author(s). -.RE +Dan Allen +.sp +Sarah White +.sp +Ryan Waldron \ No newline at end of file