aboutsummaryrefslogtreecommitdiff
path: root/man
diff options
context:
space:
mode:
authorJohn MacFarlane <[email protected]>2023-08-31 17:57:01 -0700
committerJohn MacFarlane <[email protected]>2023-08-31 17:57:01 -0700
commit5fe3396a221b34145c56ccfae39ab947fb407817 (patch)
treed4ff4f3e93e8d9cda0dd1763d4105c232c5c6a49 /man
parent19385e1833fc060f113abeecb1d5882e0f1c10d2 (diff)
Add Makefile targets for pandoc-lua.1, pandoc-server.1.
Regenerate these man pages.
Diffstat (limited to 'man')
-rw-r--r--man/pandoc-lua.188
-rw-r--r--man/pandoc-server.152
2 files changed, 59 insertions, 81 deletions
diff --git a/man/pandoc-lua.1 b/man/pandoc-lua.1
index 8f247aabf..f944bd386 100644
--- a/man/pandoc-lua.1
+++ b/man/pandoc-lua.1
@@ -1,77 +1,59 @@
-.\" Automatically generated by Pandoc 3.1.5
+.\" Automatically generated by Pandoc 3.1.7
.\"
-.\" Define V font for inline verbatim, using C font in formats
-.\" that render this, and otherwise B font.
-.ie "\f[CB]x\f[]"x" \{\
-. ftr V B
-. ftr VI BI
-. ftr VB B
-. ftr VBI BI
-.\}
-.el \{\
-. ftr V CR
-. ftr VI CI
-. ftr VB CB
-. ftr VBI CBI
-.\}
-.TH "pandoc-lua" "1" "September 22, 2022" "pandoc-lua 3.1.6.2" ""
-.hy
+.TH "pandoc-lua" "1" "September 22, 2022" "pandoc 3.1.7" "Pandoc User\[cq]s Guide"
.SH SYNOPSIS
-.PP
-\f[V]pandoc-lua\f[R] [\f[I]options\f[R]] [\f[I]script\f[R]
+\f[CR]pandoc-lua\f[R] [\f[I]options\f[R]] [\f[I]script\f[R]
[\f[I]args\f[R]]]
.SH DESCRIPTION
-.PP
-\f[V]pandoc-lua\f[R] is a standalone Lua interpreter with behavior
-similar to that of the standard \f[V]lua\f[R] executable, but exposing
+\f[CR]pandoc-lua\f[R] is a standalone Lua interpreter with behavior
+similar to that of the standard \f[CR]lua\f[R] executable, but exposing
all of pandoc\[cq]s Lua libraries.
-All \f[V]pandoc.*\f[R] packages, as well as the packages \f[V]re\f[R]
-and \f[V]lpeg\f[R], are available via global variables.
-Furthermore, the globals \f[V]PANDOC_VERSION\f[R],
-\f[V]PANDOC_STATE\f[R], and \f[V]PANDOC_API_VERSION\f[R] are set at
+All \f[CR]pandoc.*\f[R] packages, as well as the packages \f[CR]re\f[R]
+and \f[CR]lpeg\f[R], are available via global variables.
+Furthermore, the globals \f[CR]PANDOC_VERSION\f[R],
+\f[CR]PANDOC_STATE\f[R], and \f[CR]PANDOC_API_VERSION\f[R] are set at
startup.
.PP
If no script argument is given, then the script is assumed to be passed
in via \f[I]stdin\f[R].
-When called without arguments, \f[V]pandoc-lua\f[R] behaves as
-\f[V]pandoc-lua -v -i\f[R] when the standard input (\f[V]stdin\f[R]) is
-a terminal, and as \f[V]pandoc-lua -\f[R] otherwise.
+When called without arguments, \f[CR]pandoc-lua\f[R] behaves as
+\f[CR]pandoc-lua -v -i\f[R] when the standard input (\f[CR]stdin\f[R])
+is a terminal, and as \f[CR]pandoc-lua -\f[R] otherwise.
On Windows the program will always behave as if it was connected to a
terminal.
.PP
-When called without the option \f[V]-E\f[R], the interpreter checks for
-an environment variable \f[V]LUA_INIT\f[R] before running any argument.
+When called without the option \f[CR]-E\f[R], the interpreter checks for
+an environment variable \f[CR]LUA_INIT\f[R] before running any argument.
If the variable content has the format
-\f[I]\f[VI]\[at]filename\f[I]\f[R], then \f[V]pandoc-lua\f[R] executes
+\f[I]\f[CI]\[at]filename\f[I]\f[R], then \f[CR]pandoc-lua\f[R] executes
the file.
-Otherwise, \f[V]pandoc-lua\f[R] executes the string itself.
+Otherwise, \f[CR]pandoc-lua\f[R] executes the string itself.
.SH OPTIONS
.TP
-\f[V]-e stat\f[R]
-Execute statement \f[V]stat\f[R].
+\f[CR]-e stat\f[R]
+Execute statement \f[CR]stat\f[R].
.TP
-\f[V]-l mod\f[R]
-If mod has the pattern \f[V]g=m\f[R], then require library \f[V]m\f[R]
-into global \f[V]g\f[R]; otherwise require library \f[V]mod\f[R] into
-global \f[V]mod\f[R].
+\f[CR]-l mod\f[R]
+If mod has the pattern \f[CR]g=m\f[R], then require library \f[CR]m\f[R]
+into global \f[CR]g\f[R]; otherwise require library \f[CR]mod\f[R] into
+global \f[CR]mod\f[R].
.TP
-\f[V]-v\f[R]
+\f[CR]-v\f[R]
Show version information.
.TP
-\f[V]-i\f[R]
+\f[CR]-i\f[R]
Enter interactive mode after running \f[I]script\f[R].
.TP
-\f[V]-E\f[R]
+\f[CR]-E\f[R]
Ignore environment variables.
This is not fully implemented yet and only ignores the
-\f[V]LUA_INIT\f[R] variable.
-Other variables like \f[V]LUA_PATH\f[R] and \f[V]LUA_CPATH\f[R] are
+\f[CR]LUA_INIT\f[R] variable.
+Other variables like \f[CR]LUA_PATH\f[R] and \f[CR]LUA_CPATH\f[R] are
\f[B]not\f[R] ignored.
.TP
-\f[V]-W\f[R]
+\f[CR]-W\f[R]
Turn warnings on.
.SH INTERACTIVE MODE
-.PP
In interactive mode, the Lua interpreter repeatedly prompts and waits
for a line.
After reading a line, Lua first tries to interpret the line as an
@@ -81,16 +63,20 @@ Otherwise, it interprets the line as a statement.
If you write an incomplete statement, the interpreter waits for its
completion by issuing a different prompt.
.PP
-Exit the interactive mode by pressing \f[V]Ctrl-D\f[R] or
-\f[V]Ctrl-C\f[R], or by typing \f[V]os.exit()\f[R].
+Exit the interactive mode by pressing \f[CR]Ctrl-D\f[R] or
+\f[CR]Ctrl-C\f[R], or by typing \f[CR]os.exit()\f[R].
The \f[I]Isocline\f[R] library is used for line editing.
-Press \f[V]F1\f[R] to get a list of available keybindings; the
-\f[V]ctrl\f[R] key is abbreviated as \f[V]\[ha]\f[R] in that list.
+Press \f[CR]F1\f[R] to get a list of available keybindings; the
+\f[CR]ctrl\f[R] key is abbreviated as \f[CR]\[ha]\f[R] in that list.
.SH AUTHORS
-.PP
Copyright 2023 John MacFarlane (jgm\[at]berkeley.edu) and contributors.
Released under the GPL, version 2 or later.
This software carries no warranty of any kind.
(See COPYRIGHT for full copyright and warranty notices.)
.PP
Lua: Copyright 1994-2022 Lua.org, PUC-Rio.
+.PP
+The Pandoc source code may be downloaded
+from <https://hackage.haskell.org/package/pandoc> or
+<https://github.com/jgm/pandoc/releases>. Further
+documentation is available at <https://pandoc.org>.
diff --git a/man/pandoc-server.1 b/man/pandoc-server.1
index c07cd438d..3d7529b3f 100644
--- a/man/pandoc-server.1
+++ b/man/pandoc-server.1
@@ -1,9 +1,9 @@
-.TH "pandoc-server" "1" "August 15, 2022" "pandoc 3.1.7"
+.\" Automatically generated by Pandoc 3.1.7
+.\"
+.TH "pandoc-server" "1" "August 15, 2022" "pandoc 3.1.7" "Pandoc User\[cq]s Guide"
.SH SYNOPSIS
-.PP
\f[CR]pandoc-server\f[R] [\f[I]options\f[R]]
.SH DESCRIPTION
-.PP
\f[CR]pandoc-server\f[R] is a web server that can perform pandoc
conversions.
It can be used either as a running server or as a CGI program.
@@ -39,8 +39,8 @@ Timeout in seconds, after which a conversion is killed.
Default: 2.
.RS
.PP
-When \f[CR]pandoc-server\f[R] is run as a CGI program, this option can be
-set via the \f[CR]PANDOC_SERVER_TIMEOUT\f[R] environment variable.
+When \f[CR]pandoc-server\f[R] is run as a CGI program, this option can
+be set via the \f[CR]PANDOC_SERVER_TIMEOUT\f[R] environment variable.
.RE
.TP
\f[CR]--help\f[R]
@@ -50,10 +50,8 @@ Print this help.
Print version.
.SH API
.SS Root endpoint
-.PP
The root (\f[CR]/\f[R]) endpoint accepts only POST requests.
.SS Response
-.PP
It returns a converted document in one of the following formats (in
order of preference), depending on the \f[CR]Accept\f[R] header:
.IP \[bu] 2
@@ -70,32 +68,25 @@ binary will be base64 encoded.
If a JSON response is given, it will have one of the following formats.
If the conversion is not successful:
.IP
-.nf
-\f[C]
+.EX
{ \[dq]error\[dq]: string with the error message }
-\f[R]
-.fi
+.EE
.PP
If the conversion is successful:
.IP
-.nf
-\f[C]
+.EX
{ \[dq]output\[dq]: string with textual or base64-encoded binary output,
\[dq]base64\[dq]: boolean (true means the \[dq]output\[dq] is base64-encoded),
\[dq]messages\[dq]: array of message objects (see below) }
-\f[R]
-.fi
+.EE
.PP
Each element of the \[lq]messages\[rq] array will have the format
.IP
-.nf
-\f[C]
+.EX
{ \[dq]message\[dq]: string,
\[dq]verbosity\[dq]: string (either \[dq]WARNING\[dq] or \[dq]INFO\[dq]) }
-\f[R]
-.fi
+.EE
.SS Request
-.PP
The body of the POST request should be a JSON object, with the following
fields.
Only the \f[CR]text\f[R] field is required; all of the others can be
@@ -106,8 +97,8 @@ default.
\f[CR]text\f[R] (string)
The document to be converted.
Note: if the \f[CR]from\f[R] format is binary (e.g., \f[CR]epub\f[R] or
-\f[CR]docx\f[R]), then \f[CR]text\f[R] should be a base64 encoding of the
-document.
+\f[CR]docx\f[R]), then \f[CR]text\f[R] should be a base64 encoding of
+the document.
.TP
\f[CR]from\f[R] (string, default \f[CR]\[dq]markdown\[dq]\f[R])
The input format, possibly with extensions, just as it is specified on
@@ -229,8 +220,8 @@ Automatically number sections (in supported formats).
\f[CR]number-offset\f[R] (array of integers)
Offsets to be added to each component of the section number.
For example, \f[CR][1]\f[R] will cause the first section to be numbered
-\[lq]2\[rq] and the first subsection \[lq]2.1\[rq]; \f[CR][0,1]\f[R] will
-cause the first section to be numbered \[lq]1\[rq] and the first
+\[lq]2\[rq] and the first subsection \[lq]2.1\[rq]; \f[CR][0,1]\f[R]
+will cause the first section to be numbered \[lq]1\[rq] and the first
subsection \[lq]1.2.\[rq]
.TP
\f[CR]html-math-method\f[R] (\f[CR]\[dq]plain\[dq]|\[dq]webtex\[dq]|\[dq]gladtex\[dq]|\[dq]mathml\[dq]|\[dq]mathjax\[dq]|\[dq]katex\[dq]\f[R])
@@ -315,9 +306,8 @@ Binary data must be base64-encoded.
Textual data may be left as it is, unless it is \f[I]also\f[R] valid
base 64 data, in which case it will be interpreted that way.
.SS \f[CR]/batch\f[R] endpoint
-.PP
-The \f[CR]/batch\f[R] endpoint behaves like the root endpoint, except for
-these two points:
+The \f[CR]/batch\f[R] endpoint behaves like the root endpoint, except
+for these two points:
.IP \[bu] 2
It accepts a JSON array, each element of which is a JSON object like the
one expected by the root endpoint.
@@ -327,12 +317,10 @@ It returns a JSON array of JSON results.
This endpoint can be used to convert a sequence of small snippets in one
request.
.SS \f[CR]/version\f[R] endpoint
-.PP
The \f[CR]/version\f[R] endpoint accepts a GET request and returns the
pandoc version as a plain or JSON-encoded string, depending on Accept
headers.
.SS \f[CR]/babelmark\f[R] endpoint
-.PP
The \f[CR]/babelmark\f[R] endpoint accepts a GET request with the
following query parameters:
.IP \[bu] 2
@@ -349,8 +337,12 @@ It returns a JSON object with fields \f[CR]html\f[R] and
\f[CR]version\f[R].
This endpoint is designed to support the Babelmark website.
.SH AUTHORS
-.PP
Copyright 2022 John MacFarlane (jgm\[at]berkeley.edu).
Released under the GPL, version 2 or greater.
This software carries no warranty of any kind.
(See COPYRIGHT for full copyright and warranty notices.)
+.PP
+The Pandoc source code may be downloaded
+from <https://hackage.haskell.org/package/pandoc> or
+<https://github.com/jgm/pandoc/releases>. Further
+documentation is available at <https://pandoc.org>.