summaryrefslogtreecommitdiffstats
path: root/man
diff options
context:
space:
mode:
authorAron Budea <aron.budea@collabora.com>2022-01-11 23:42:08 +0100
committerAndras Timar <andras.timar@collabora.com>2022-01-13 22:25:44 +0100
commit51d58df12bdf36c8b5459e3f556440be16b339ac (patch)
treeada5e37445dc3602ec7d624603aa19778fc01a84 /man
parentfix some UI elements of Draw (diff)
downloadonline-51d58df12bdf36c8b5459e3f556440be16b339ac.tar.gz
online-51d58df12bdf36c8b5459e3f556440be16b339ac.zip
coolconfig: updated man page
Follow-up to a6b258a0db07a4fa720903f1fcf2e32c4677bb47 Signed-off-by: Aron Budea <aron.budea@collabora.com> Change-Id: I79e457bb6fd410cbb40de500d2f3ce0f33f2e9ae
Diffstat (limited to 'man')
-rw-r--r--man/coolconfig.18
1 files changed, 5 insertions, 3 deletions
diff --git a/man/coolconfig.1 b/man/coolconfig.1
index d05d83ede3..d2a024667c 100644
--- a/man/coolconfig.1
+++ b/man/coolconfig.1
@@ -8,7 +8,7 @@ coolconfig COMMAND [OPTIONS]
.SS "General options:"
\fB\-h\fR, \fB\-\-help\fR Show this usage information.
.PP
-\fB\-\-config\-file\fR=\fIpath\fR Specify configuration file path manually.
+\fB\-\-config\-file\fR=\fIpath\fR Specify configuration file path manually. The default is usually \fI/etc/coolwsd/coolwsd.xml\fR.
.SS "anonymize"
The \fBanonymize\fR command helps to read anonymized logs. If you know a document and/or a user had an issue, you can find their session in the logs by running this command with the username and/or document name and get the anonymized hash, which you use to search the logs with.
.PP
@@ -19,12 +19,14 @@ anonymize [string\-1]...[string\-n]
.SS "migrateconfig"
The \fBmigrateconfig\fR command migrates config file of Collabora Online 6.4 or older to the new format.
.PP
-migrateconfig
+migrateconfig [\-\-old\-config\-file=<path>] [\-\-config\-file=<path>] [\-\-write]
.PP
-\fB\-\-old\-config\-file\fR=\fIpath\fR Specify configuration file path manually. The default is \fI/etc/loolwsd/loolwsd.xml\fR.
+\fB\-\-old\-config\-file\fR=\fIpath\fR Specify file path for the old configuration manually. The default is \fI/etc/loolwsd/loolwsd.xml\fR.
.PP
\fB\-\-write\fR Write migrated configuration. Without this option no changes are written to the config file, only information about differences between old and new config is printed.
.PP
+\fBExample:\fR coolconfig migrateconfig \-\-old\-config\-file=/etc/loolwsd/loolwsd.xml \-\-config\-file=/etc/coolwsd/coolwsd.xml \-\-write
+.PP
.SS "set"
The \fBset\fR command changes an existing configuration setting in the config file. The <key> is the XPath expression of the config item in the config XML file (coolwsd.xml).
.PP