diff options
Diffstat (limited to 'doc/makeinfo.1')
| -rw-r--r-- | doc/makeinfo.1 | 222 |
1 files changed, 222 insertions, 0 deletions
diff --git a/doc/makeinfo.1 b/doc/makeinfo.1 new file mode 100644 index 0000000..3753a0f --- /dev/null +++ b/doc/makeinfo.1 @@ -0,0 +1,222 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.36. +.TH MAKEINFO "1" "September 2008" "makeinfo 4.13" "User Commands" +.SH NAME +makeinfo \- translate Texinfo documents +.SH SYNOPSIS +.B makeinfo +[\fIOPTION\fR]... \fITEXINFO-FILE\fR... +.SH DESCRIPTION +Translate Texinfo source documentation to various other formats, by default +Info files suitable for reading online with Emacs or standalone GNU Info. +.SS "General options:" +.TP +\fB\-\-error\-limit\fR=\fINUM\fR +quit after NUM errors (default 100). +.TP +\fB\-\-document\-language\fR=\fISTR\fR locale to use in translating Texinfo keywords +for the output document (default C). +.TP +\fB\-\-force\fR +preserve output even if errors. +.TP +\fB\-\-help\fR +display this help and exit. +.TP +\fB\-\-no\-validate\fR +suppress node cross\-reference validation. +.TP +\fB\-\-no\-warn\fR +suppress warnings (but not errors). +.TP +\fB\-v\fR, \fB\-\-verbose\fR +explain what is being done. +.TP +\fB\-\-version\fR +display version information and exit. +.SS "Output format selection (default is to produce Info):" +.TP +\fB\-\-docbook\fR +output Docbook XML rather than Info. +.TP +\fB\-\-html\fR +output HTML rather than Info. +.TP +\fB\-\-xml\fR +output Texinfo XML rather than Info. +.TP +\fB\-\-plaintext\fR +output plain text rather than Info. +.SS "General output options:" +.TP +\fB\-E\fR, \fB\-\-macro\-expand\fR=\fIFILE\fR +output macro\-expanded source to FILE, +ignoring any @setfilename. +.TP +\fB\-\-no\-headers\fR +suppress node separators, Node: lines, and menus +from Info output (thus producing plain text) +or from HTML (thus producing shorter output); +also, write to standard output by default. +.TP +\fB\-\-no\-split\fR +suppress the splitting of Info or HTML output, +generate only one output file. +.TP +\fB\-\-number\-sections\fR +output chapter and sectioning numbers. +.TP +\fB\-o\fR, \fB\-\-output\fR=\fIFILE\fR +output to FILE (or directory if split HTML). +.SS "Options for Info and plain text:" +.TP +\fB\-\-disable\-encoding\fR +do not output accented and special characters +in Info output based on @documentencoding. +.TP +\fB\-\-enable\-encoding\fR +override \fB\-\-disable\-encoding\fR (default). +.TP +\fB\-\-fill\-column\fR=\fINUM\fR +break Info lines at NUM characters (default 72). +.TP +\fB\-\-footnote\-style\fR=\fISTYLE\fR +output footnotes in Info according to STYLE: +`separate' to put them in their own node; +`end' to put them at the end of the node, in +which they are defined (this is the default). +.TP +\fB\-\-paragraph\-indent\fR=\fIVAL\fR +indent Info paragraphs by VAL spaces (default 3). +If VAL is `none', do not indent; if VAL is +`asis', preserve existing indentation. +.TP +\fB\-\-split\-size\fR=\fINUM\fR +split Info files at size NUM (default 300000). +.SS "Options for HTML:" +.TP +\fB\-\-css\-include\fR=\fIFILE\fR +include FILE in HTML <style> output; +read stdin if FILE is \-. +.TP +\fB\-\-css\-ref\fR=\fIURL\fR +generate reference to a CSS file. +.TP +\fB\-\-internal\-links\fR=\fIFILE\fR +produce list of internal links in FILE. +.TP +\fB\-\-transliterate\-file\-names\fR +produce file names in ASCII transliteration. +.SS "Options for XML and Docbook:" +.TP +\fB\-\-output\-indent\fR=\fIVAL\fR +indent XML elements by VAL spaces (default 2). +If VAL is 0, ignorable whitespace is dropped. +.SS "Input file options:" +.TP +\fB\-\-commands\-in\-node\-names\fR +allow @ commands in node names. +.TP +\fB\-D\fR VAR +define the variable VAR, as with @set. +.TP +\fB\-I\fR DIR +append DIR to the @include search path. +.TP +\fB\-P\fR DIR +prepend DIR to the @include search path. +.TP +\fB\-U\fR VAR +undefine the variable VAR, as with @clear. +.SS "Conditional processing in input:" +.TP +\fB\-\-ifdocbook\fR +process @ifdocbook and @docbook even if +not generating Docbook. +.TP +\fB\-\-ifhtml\fR +process @ifhtml and @html even if not generating HTML. +.TP +\fB\-\-ifinfo\fR +process @ifinfo even if not generating Info. +.TP +\fB\-\-ifplaintext\fR +process @ifplaintext even if not generating plain text. +.TP +\fB\-\-iftex\fR +process @iftex and @tex; implies \fB\-\-no\-split\fR. +.TP +\fB\-\-ifxml\fR +process @ifxml and @xml. +.TP +\fB\-\-no\-ifdocbook\fR +do not process @ifdocbook and @docbook text. +.TP +\fB\-\-no\-ifhtml\fR +do not process @ifhtml and @html text. +.TP +\fB\-\-no\-ifinfo\fR +do not process @ifinfo text. +.TP +\fB\-\-no\-ifplaintext\fR +do not process @ifplaintext text. +.TP +\fB\-\-no\-iftex\fR +do not process @iftex and @tex text. +.TP +\fB\-\-no\-ifxml\fR +do not process @ifxml and @xml text. +.P +Also, for the \fB\-\-no\-ifFORMAT\fR options, do process @ifnotFORMAT text. +.P +The defaults for the @if... conditionals depend on the output format: +if generating HTML, \fB\-\-ifhtml\fR is on and the others are off; +if generating Info, \fB\-\-ifinfo\fR is on and the others are off; +if generating plain text, \fB\-\-ifplaintext\fR is on and the others are off; +if generating XML, \fB\-\-ifxml\fR is on and the others are off. +.SH EXAMPLES +.TP +makeinfo foo.texi +write Info to foo's @setfilename +.TP +makeinfo \fB\-\-html\fR foo.texi +write HTML to @setfilename +.TP +makeinfo \fB\-\-xml\fR foo.texi +write Texinfo XML to @setfilename +.TP +makeinfo \fB\-\-docbook\fR foo.texi +write DocBook XML to @setfilename +.TP +makeinfo \fB\-\-no\-headers\fR foo.texi +write plain text to standard output +.TP +makeinfo \fB\-\-html\fR \fB\-\-no\-headers\fR foo.texi +write html without node lines, menus +.TP +makeinfo \fB\-\-number\-sections\fR foo.texi +write Info with numbered sections +.TP +makeinfo \fB\-\-no\-split\fR foo.texi +write one Info file however big +.SH "REPORTING BUGS" +Email bug reports to bug\-texinfo@gnu.org, +general questions and discussion to help\-texinfo@gnu.org. +Texinfo home page: http://www.gnu.org/software/texinfo/ +.SH COPYRIGHT +Copyright \(co 2008 Free Software Foundation, Inc. +License GPLv3+: GNU GPL version 3 or later <http://gnu.org/licenses/gpl.html> +.br +This is free software: you are free to change and redistribute it. +There is NO WARRANTY, to the extent permitted by law. +.SH "SEE ALSO" +The full documentation for +.B makeinfo +is maintained as a Texinfo manual. If the +.B info +and +.B makeinfo +programs are properly installed at your site, the command +.IP +.B info makeinfo +.PP +should give you access to the complete manual. |