haraldwolff
/
collabora-online
mirror of https://github.com/CollaboraOnline/online.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Fix Lintian warnings related to man pages 

W: loolwsd: bad-whatis-entry usr/share/man/man1/loolforkit.1.gz
W: loolwsd: bad-whatis-entry usr/share/man/man1/loolwsd-generate-proof-key.1.gz
W: loolwsd: bad-whatis-entry usr/share/man/man1/loolwsd-systemplate-setup.1.gz
W: loolwsd: no-manual-page usr/bin/loolmount
Signed-off-by: Andras Timar <andras.timar@collabora.com>
Change-Id: Ieb7d2f92076d4d4b6b13bfc3ceb990ff3d8db78e
pull/3325/head
Andras Timar 2021-09-27 00:52:53 +02:00
parent 96b3904b9c
commit ab2af84665
9 changed files with 25 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
Makefile.am
View File

@ -32,7 +32,9 @@ man_MANS = man/loolwsd.1 \
man/loolconvert.1 \
man/loolconfig.1 \
man/loolwsd-systemplate-setup.1 \
man/loolwsd-generate-proof-key.1
man/loolwsd-generate-proof-key.1 \
man/loolmount.1
dist_doc_DATA = wsd/README \
wsd/README.vars \

1
loolwsd.spec.in
View File

@ -126,6 +126,7 @@ echo "account required pam_unix.so" >> %{buildroot}/etc/pam.d/loolwsd
/usr/share/man/man1/loolconfig.1.gz
/usr/share/man/man1/loolwsd-systemplate-setup.1.gz
/usr/share/man/man1/loolwsd-generate-proof-key.1.gz
/usr/share/man/man1/loolmount.1.gz
%{_unitdir}/loolwsd.service
%if 0%{?rhel}
%config(noreplace) /etc/sysconfig/loolwsd

2
man/loolconfig.1
View File

@ -24,4 +24,4 @@ update\-system\-template
.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), loolwsd-generate-proof-key(1)
loolforkit(1), loolconvert(1), loolwsd(1), loolwsd-systemplate-setup(1), loolwsd-generate-proof-key(1), loolmount(1)

2
man/loolconvert.1
View File

@ -17,4 +17,4 @@ loolconvert OPTIONS FILE(S)
\fB\-\-no\-check\-certificate\fR Disable checking of SSL certs
.PP
.SH "SEE ALSO"
loolwsd(1), loolforkit(1), loolconfig(1), loolforkit-systemplate-setup(1), loolwsd-generate-proof-key(1)
loolwsd(1), loolforkit(1), loolconfig(1), loolforkit-systemplate-setup(1), loolwsd-generate-proof-key(1), loolmount(1)

6
man/loolforkit.1
View File

@ -1,11 +1,11 @@
.TH LOOLFORKIT "1" "May 2018" "loolforkit " "User Commands"
.SH NAME
loolforkit
loolforkit \- Utility that spawns LOK instances for Collabora Online
.SH SYNOPSIS
loolforkit OPTIONS
.SH DESCRIPTION
Single-threaded process that spawns Collabora Online Kit (LOK) instances.
Single-threaded process that spawns LibreOfficeKit (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), loolwsd-generate-proof-key(1)
loolwsd(1), loolconvert(1), loolconfig(1), loolforkit-systemplate-setup(1), loolwsd-generate-proof-key(1), loolmount(1)

11
man/loolmount.1 100644
View File

@ -0,0 +1,11 @@
.TH LOOLMOUNT "1" "May 2018" "loolmount " "User Commands"
.SH NAME
loolmount \- A very tiny helper to allow overlay mounting for Collabora Online
.SH SYNOPSIS
loolmount OPTIONS
.SH DESCRIPTION
This is a very tiny helper to allow overlay mounting.
.PP
\fBNote\fR: Running this standalone is not possible. It is used internally by loolwsd when it creates the jail for the document.
.SH "SEE ALSO"
loolwsd(1), loolconvert(1), loolconfig(1), loolforkit-systemplate-setup(1), loolwsd-generate-proof-key(1), loolforkit(1)

4
man/loolwsd-generate-proof-key.1
View File

@ -1,9 +1,9 @@
.TH LOOLWSD-GENERATE_PROOF_KEY "1" "April 2020" "loolwsd-generate-proof-key " "User Commands"
.SH NAME
loolwsd-generate-proof-key
loolwsd-generate-proof-key \- Utility that genarates WOPI Proof keys for Collabora Online
.SH SYNOPSIS
loolwsd-generate-proof-key
.SH DESCRIPTION
loolwsd-generate-proof-key creates an RSA key pair in /etc/loolwsd for the WOPI Proof headers. The script is automatically run by the postinstall script of loolwsd package, but in case of failure sysadmins can run it manually.
.SH "SEE ALSO"
loolforkit(1), loolconvert(1), loolconfig(1), loolwsd(1), loolwsd-systemplate-setup(1)
loolforkit(1), loolconvert(1), loolconfig(1), loolwsd(1), loolwsd-systemplate-setup(1), loolmount(1)

4
man/loolwsd-systemplate-setup.1
View File

@ -1,9 +1,9 @@
.TH LOOLWSD-SYSTEMPLATE-SETUP "1" "May 2018" "loolwsd-systemplate-setup " "User Commands"
.SH NAME
loolwsd-systemplate-setup
loolwsd-systemplate-setup \- Utility that sets up system template for Collabora Online
.SH SYNOPSIS
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), loolwsd-generate-proof-key(1)
loolforkit(1), loolconvert(1), loolconfig(1), loolwsd(1), loolwsd-generate-proof-key(1), loolmount(1)

2
man/loolwsd.1
View File

@ -31,4 +31,4 @@ loolwsd OPTIONS
\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), loolwsd-generate-proof-key(1)
loolforkit(1), loolconvert(1), loolconfig(1), loolwsd-systemplate-setup(1), loolwsd-generate-proof-key(1), loolmount(1)