Makefile.am | 9 ++++++++-
man/loolconfig.1 | 27 +++++++++++++++++++++++++++
man/loolconvert.1 | 20 ++++++++++++++++++++
man/loolforkit.1 | 11 +++++++++++
man/loolwsd-systemplate-setup.1 | 9 +++++++++
man/loolwsd.1 | 34 ++++++++++++++++++++++++++++++++++
6 files changed, 109 insertions(+), 1 deletion(-)
New commits:
commit ecce256f0556ab05ccc9499bad923364fa1d61a4
Author: Andras Timar <andras.ti...@collabora.com>
Date: Mon May 14 10:49:46 2018 +0200
Add man pages for installed binaries/scripts
Change-Id: I62c0fd29ab2b8e92522514010f4aa4981edc10cc
Reviewed-on: https://gerrit.libreoffice.org/54306
Reviewed-by: Michael Meeks <michael.me...@collabora.com>
Tested-by: Michael Meeks <michael.me...@collabora.com>
diff --git a/Makefile.am b/Makefile.am
index e05dae2b2..dcb993ce8 100644
--- a/Makefile.am
+++ b/Makefile.am
@@ -8,6 +8,12 @@ bin_PROGRAMS = \
dist_bin_SCRIPTS = loolwsd-systemplate-setup
+man_MANS = man/loolwsd.1 \
+ man/loolforkit.1 \
+ man/loolconvert.1 \
+ man/loolconfig.1 \
+ man/loolwsd-systemplate-setup.1
+
dist_doc_DATA = wsd/README \
wsd/README.vars \
wsd/protocol.txt \
@@ -225,7 +231,8 @@ EXTRA_DIST = discovery.xml \
etc/key.pem \
etc/cert.pem \
etc/ca-chain.cert.pem \
- scripts/unocommands.py
+ scripts/unocommands.py \
+ $(man_MANS)
if HAVE_LO_PATH
diff --git a/man/loolconfig.1 b/man/loolconfig.1
new file mode 100644
index 000000000..3637d9b14
--- /dev/null
+++ b/man/loolconfig.1
@@ -0,0 +1,27 @@
+.TH LOOLCONFIG "1" "May 2018" "loolconfig" "User Commands"
+.SH NAME
+loolconfig \- Configuration tool for LibreOffice Online.
+.SH SYNOPSYS
+loolconfig COMMAND [OPTIONS]
+.SH OPTIONS
+Some options make sense only with a specific command.
+.PP
+.SS "Commands:"
+.PP
+set\-admin\-password
+.PP
+set <key> <value>
+.PP
+update\-system\-template
+.SS "Options:"
+\fB\-h\fR, \fB\-\-help\fR Show this usage information.
+.PP
+\fB\-\-config\-file\fR=\fIpath\fR Specify configuration file path
manually.
+.PP
+\fB\-\-pwd\-salt\-length\fR=\fInumber\fR Length of the salt to use to hash
password [set\-admin\-password].
+.PP
+\fB\-\-pwd\-iterations\fR=\fInumber\fR Number of iterations to do in PKDBF2
password hashing [set\-admin\-password].
+.PP
+\fB\-\-pwd\-hash\-length\fR=\fInumber\fR Length of password hash to generate
[set\-admin\-password].
+.SH "SEE ALSO"
+loolforkit(1), loolconvert(1), loolwsd(1), loolwsd-systemplate-setup(1)
diff --git a/man/loolconvert.1 b/man/loolconvert.1
new file mode 100644
index 000000000..bd0dcf01a
--- /dev/null
+++ b/man/loolconvert.1
@@ -0,0 +1,20 @@
+.TH LOOLCONVERT "1" "May 2018" "loolconvert" "User Commands"
+.SH NAME
+loolconvert \- LibreOffice Online document converter tool
+.SH SYNOPSYS
+loolconvert OPTIONS FILE(S)
+.SH OPTIONS
+\fB\-\-help\fR Display help information on command line
arguments.
+.PP
+\fB\-\-extension\fR=\fIformat\fR file format extension to convert to
+.PP
+\fB\-\-outdir\fR=\fIoutdir\fR output directory for converted files
+.PP
+\fB\-\-parallelism\fR=\fIthreads\fR number of simultaneous threads to use
+.PP
+\fB\-\-server\fR=\fIuri\fR URI of LOOL server
+.PP
+\fB\-\-no\-check\-certificate\fR Disable checking of SSL certs
+.PP
+.SH "SEE ALSO"
+loolwsd(1), loolforkit(1), loolconfig(1), loolforkit-systemplate-setup(1)
diff --git a/man/loolforkit.1 b/man/loolforkit.1
new file mode 100644
index 000000000..73b54fd7a
--- /dev/null
+++ b/man/loolforkit.1
@@ -0,0 +1,11 @@
+.TH LOOLFORKIT "1" "May 2018" "loolforkit " "User Commands"
+.SH NAME
+loolforkit
+.SH SYNOPSYS
+loolforkit OPTIONS
+.SH DESCRIPTION
+Single-threaded process that spawns LibreOffice Online Kit (LOK) instances.
+.PP
+\fBNote\fR: Running this standalone is not possible. It is spawned by loolwsd
and is controlled via a pipe.
+.SH "SEE ALSO"
+loolwsd(1), loolconvert(1), loolconfig(1), loolforkit-systemplate-setup(1)
diff --git a/man/loolwsd-systemplate-setup.1 b/man/loolwsd-systemplate-setup.1
new file mode 100644
index 000000000..c55f17290
--- /dev/null
+++ b/man/loolwsd-systemplate-setup.1
@@ -0,0 +1,9 @@
+.TH LOOLWSD-SYSTEMPLATE-SETUP "1" "May 2018" "loolwsd-systemplate-setup "
"User Commands"
+.SH NAME
+loolwsd-systemplate-setup
+.SH SYNOPSYS
+loolwsd-systemplate-setup <chroot template directory for system libs to
create> <LibreOffice installation directory>
+.SH DESCRIPTION
+loolwsd-systemplate-setup creates a minimal system template for running the
LibreOfficeKit in a chroot jail. The system template contains the bare minimum
of system libraries to run LibreOfficeKit, and also fonts and locale data from
the system.
+.SH "SEE ALSO"
+loolforkit(1), loolconvert(1), loolconfig(1), loolwsd(1)
diff --git a/man/loolwsd.1 b/man/loolwsd.1
new file mode 100644
index 000000000..22c1fe99e
--- /dev/null
+++ b/man/loolwsd.1
@@ -0,0 +1,34 @@
+.TH LOOLWSD "1" "May 2018" "loolwsd " "User Commands"
+.SH NAME
+loolwsd \- LibreOffice Online Websocket Daemon
+.SH SYNOPSYS
+loolwsd OPTIONS
+.SH OPTIONS
+\fB\-\-daemon\fR Run application as a daemon.
+.PP
+\fB\-\-umask\fR=\fImask\fR Set the daemon's umask (octal,
e.g. 027).
+.PP
+\fB\-\-pidfile\fR=\fIpath\fR Write the process ID of the
application to given file.
+.PP
+\fB\-\-help\fR Display help information on command
line arguments.
+.PP
+\fB\-\-version\fR Display version information.
+.PP
+\fB\-\-port\fR=\fIport_number\fR Port number to listen to
(default: 9980), must not be 9981.
+.PP
+\fB\-\-disable\-ssl\fR Disable SSL security layer.
+.PP
+\fB\-oxmlpath\fR, \fB\-\-override\fR=\fIxmlpath\fR Override any setting by
providing fullxmlpath=value.
+.PP
+\fB\-\-config\-file\fR=\fIpath\fR Override configuration file path.
+.PP
+\fB\-\-config\-dir\fR=\fIpath\fR Override extra configuration
directory path.
+.PP
+\fB\-\-unitlib\fR=\fIunitlib\fR Unit testing library path.
+.PP
+\fB\-\-careerspan\fR=\fIseconds\fR How many seconds to run.
+.PP
+\fB\-\-nocaps\fR Use a non\-privileged forkit, with
increase in security problems.
+.PP
+.SH "SEE ALSO"
+loolforkit(1), loolconvert(1), loolconfig(1), loolwsd-systemplate-setup(1)
_______________________________________________
Libreoffice-commits mailing list
libreoffice-comm...@lists.freedesktop.org
https://lists.freedesktop.org/mailman/listinfo/libreoffice-commits
