rename coolforkit -> coolforkit-caps, coolforkitns -> coolforkit-ns

update man pages to point to coolforkit-ns Signed-off-by: Caolán McNamara <[email protected]> Change-Id: I80fa7328f601e5599fe47153b1881027e34f8403
meven · Aug 19, 2024 · fa0e74f · fa0e74f
1 parent 5e4d2e1
commit fa0e74f
Show file tree

Hide file tree

Showing 20 changed files with 49 additions and 45 deletions.
diff --git a/.gitignore b/.gitignore
@@ -83,26 +83,28 @@ browser/dist
 browser/compilets
 browser/typescript_js
 
+coolforkit
+coolforkitns
+coolforkit-caps
+coolforkit-nocaps
+coolforkit-ns
 connect
 lokitclient
 coolwsd
 loolwsd
-coolforkit
 coolmount
 coolmap
 coolconvert
 coolsocketdump
 coolstress
 coolconfig
 loolconfig
-coolforkit-nocaps
 loadtest
 unittest
 clientnb
 libsimd.a
 coolwsd-inproc
 coolbench
-coolforkitns
 
 # Fuzzer
 *_fuzzer

diff --git a/Makefile.am b/Makefile.am
@@ -19,8 +19,8 @@ SUBDIRS = . browser test cypress_test
 export ENABLE_DEBUG
 
 bin_PROGRAMS = \
-	coolforkit \
-	coolforkitns \
+	coolforkit-caps \
+	coolforkit-ns \
 	coolmount \
         coolstress \
 	coolconvert coolconfig
@@ -36,7 +36,7 @@ endif
 dist_bin_SCRIPTS = coolwsd-systemplate-setup
 
 man_MANS = man/coolwsd.1 \
-           man/coolforkit.1 \
+           man/coolforkit-ns.1 \
            man/coolconvert.1 \
            man/coolconfig.1 \
            man/coolstress.1 \
@@ -206,17 +206,19 @@ coolforkit_sources = kit/ChildSession.cpp \
                      kit/Kit.cpp \
                      kit/KitWebSocket.cpp
 
-coolforkit_SOURCES = $(coolforkit_sources) \
-                     $(shared_sources) \
-                     kit/forkit-main.cpp
+coolforkit_ldadd = libsimd.a
 
-coolforkit_LDADD = libsimd.a
+coolforkit_caps_SOURCES = $(coolforkit_sources) \
+                          $(shared_sources) \
+                          kit/forkit-main.cpp
 
-coolforkitns_SOURCES = $(coolforkit_sources) \
-                       $(shared_sources) \
-                       kit/forkit-main.cpp
+coolforkit_caps_LDADD = ${coolforkit_ldadd}
 
-coolforkitns_LDADD = libsimd.a
+coolforkit_ns_SOURCES = $(coolforkit_sources) \
+                        $(shared_sources) \
+                        kit/forkit-main.cpp
+
+coolforkit_ns_LDADD = ${coolforkit_ldadd}
 
 if ENABLE_DEBUG
 coolwsd_inproc_SOURCES = $(coolwsd_sources) \
@@ -225,13 +227,13 @@ coolwsd_inproc_SOURCES = $(coolwsd_sources) \
                          wsd/coolwsd-inproc.cpp
 
 coolwsd_inproc_LDADD = ${coolwsd_LDADD} \
-                       ${coolforkit_LDADD}
+                       ${coolforkit_ldadd}
 endif
 
 if ENABLE_LIBFUZZER
-coolforkit_SOURCES += \
+coolforkit_caps_SOURCES += \
 		       common/DummyTraceEventEmitter.cpp
-coolforkitns_SOURCES += \
+coolforkit_ns_SOURCES += \
 		       common/DummyTraceEventEmitter.cpp
 
 common_fuzzer_sources = \
@@ -484,7 +486,7 @@ RUN_GDB = $(if $(GDB_FRONTEND),$(GDB_FRONTEND),gdb --tui --args)
 if ENABLE_LIBFUZZER
 CLEANUP_DEPS=
 else
-CLEANUP_DEPS=coolwsd coolmount coolforkit coolforkitns
+CLEANUP_DEPS=coolwsd coolmount coolforkit-caps coolforkit-ns
 endif
 
 # Build coolwsd and coolmount first, so we can cleanup before updating

diff --git a/coolwsd.spec.in b/coolwsd.spec.in
@@ -62,7 +62,7 @@ echo "account    required     pam_unix.so" >>  %{buildroot}/etc/pam.d/coolwsd
 /usr/bin/loolwsd
 /usr/bin/coolwsd-systemplate-setup
 /usr/bin/loolwsd-systemplate-setup
-/usr/bin/coolforkitns
+/usr/bin/coolforkit-ns
 /usr/bin/coolconvert
 /usr/bin/coolconfig
 /usr/bin/loolconfig
@@ -77,7 +77,7 @@ echo "account    required     pam_unix.so" >>  %{buildroot}/etc/pam.d/coolwsd
 /usr/share/doc/coolwsd/reference.md
 /usr/share/doc/coolwsd/THIRDPARTYLICENSES
 /usr/share/man/man1/coolwsd.1.gz
-/usr/share/man/man1/coolforkit.1.gz
+/usr/share/man/man1/coolforkit-ns.1.gz
 /usr/share/man/man1/coolconvert.1.gz
 /usr/share/man/man1/coolconfig.1.gz
 /usr/share/man/man1/coolstress.1.gz
@@ -96,7 +96,7 @@ echo "account    required     pam_unix.so" >>  %{buildroot}/etc/pam.d/coolwsd
 
 %files deprecated
 %defattr(-,root,root,-)
-/usr/bin/coolforkit
+/usr/bin/coolforkit-caps
 /usr/bin/coolmount
 
 %pre
@@ -142,7 +142,7 @@ coolconfig generate-proof-key >/dev/null 2>&1
 if [ $COOLWSD_IS_ACTIVE == "1" ]; then systemctl start coolwsd; fi
 
 %post deprecated
-setcap cap_fowner,cap_chown,cap_sys_chroot=ep /usr/bin/coolforkit
+setcap cap_fowner,cap_chown,cap_sys_chroot=ep /usr/bin/coolforkit-caps
 setcap cap_sys_admin=ep /usr/bin/coolmount
 
 %preun

diff --git a/debian/coolwsd-deprecated.install b/debian/coolwsd-deprecated.install
@@ -1,2 +1,2 @@
-usr/bin/coolforkit
+usr/bin/coolforkit-caps
 usr/bin/coolmount
diff --git a/debian/coolwsd-deprecated.postinst b/debian/coolwsd-deprecated.postinst
@@ -4,7 +4,7 @@ set -e
 
 case "$1" in
     configure)
-	setcap cap_fowner,cap_chown,cap_sys_chroot=ep /usr/bin/coolforkit || true
+	setcap cap_fowner,cap_chown,cap_sys_chroot=ep /usr/bin/coolforkit-caps || true
 	setcap cap_sys_admin=ep /usr/bin/coolmount || true
 	;;
 

diff --git a/debian/coolwsd.install b/debian/coolwsd.install
@@ -1,7 +1,7 @@
 etc/
 usr/bin/coolconfig
 usr/bin/coolconvert
-usr/bin/coolforkitns
+usr/bin/coolforkit-ns
 usr/bin/coolstress
 usr/bin/coolwsd
 usr/bin/coolwsd-systemplate-setup

diff --git a/docker/from-source-gh-action/Dockerfile b/docker/from-source-gh-action/Dockerfile
@@ -62,7 +62,7 @@ COPY /start-collabora-online.sh /start-collabora-online.sh
 
 # set up Collabora Online (normally done by postinstall script of package)
 # Fix permissions
-RUN setcap cap_fowner,cap_chown,cap_sys_chroot=ep /usr/bin/coolforkit && \
+RUN setcap cap_fowner,cap_chown,cap_sys_chroot=ep /usr/bin/coolforkit-caps && \
     setcap cap_sys_admin=ep /usr/bin/coolmount && \
     adduser --quiet --system --group --home /opt/cool cool && \
     rm -rf /opt/cool && \

diff --git a/docker/from-source/ArchLinux b/docker/from-source/ArchLinux
@@ -20,7 +20,7 @@ COPY /start-collabora-online.sh /
 
 # set up Collabora Online (normally done by postinstall script of package)
 # Fix permissions
-RUN setcap cap_fowner,cap_chown,cap_sys_chroot=ep /usr/bin/coolforkit && \
+RUN setcap cap_fowner,cap_chown,cap_sys_chroot=ep /usr/bin/coolforkit-caps && \
     setcap cap_sys_admin=ep /usr/bin/coolmount && \
     useradd --system --user-group --create-home --home-dir /opt/cool cool && \
     rm -rf /opt/cool && \
@@ -38,4 +38,4 @@ RUN usermod -u 972 cool
 # switch to cool user (use numeric user id to be compatible with Kubernetes Pod Security Policies)
 USER 972
 
-CMD ["/start-collabora-online.sh"]
+CMD ["/start-collabora-online.sh"]
diff --git a/docker/from-source/Debian b/docker/from-source/Debian
@@ -24,7 +24,7 @@ COPY /start-collabora-online.sh /
 
 # set up Collabora Online (normally done by postinstall script of package)
 # Fix permissions
-RUN setcap cap_fowner,cap_chown,cap_sys_chroot=ep /usr/bin/coolforkit && \
+RUN setcap cap_fowner,cap_chown,cap_sys_chroot=ep /usr/bin/coolforkit-caps && \
     setcap cap_sys_admin=ep /usr/bin/coolmount && \
     adduser --quiet --system --group --home /opt/cool cool && \
     rm -rf /opt/cool && \

diff --git a/docker/from-source/Fedora b/docker/from-source/Fedora
@@ -17,7 +17,7 @@ COPY /start-collabora-online.sh /
 
 # set up Collabora Online (normally done by postinstall script of package)
 # Fix permissions
-RUN setcap cap_fowner,cap_chown,cap_sys_chroot=ep /usr/bin/coolforkit && \
+RUN setcap cap_fowner,cap_chown,cap_sys_chroot=ep /usr/bin/coolforkit-caps && \
     setcap cap_sys_admin=ep /usr/bin/coolmount && \
     groupadd -r cool && \
     useradd -g cool -r cool -d /opt/cool -s /bin/bash && \

diff --git a/docker/from-source/Ubuntu b/docker/from-source/Ubuntu
@@ -26,7 +26,7 @@ COPY /start-collabora-online.sh /
 
 # set up Collabora Online (normally done by postinstall script of package)
 # Fix permissions
-RUN setcap cap_fowner,cap_chown,cap_sys_chroot=ep /usr/bin/coolforkit && \
+RUN setcap cap_fowner,cap_chown,cap_sys_chroot=ep /usr/bin/coolforkit-caps && \
     setcap cap_sys_admin=ep /usr/bin/coolmount && \
     adduser --quiet --system --group --home /opt/cool cool && \
     rm -rf /opt/cool && \

diff --git a/docker/from-source/openSUSE b/docker/from-source/openSUSE
@@ -20,7 +20,7 @@ COPY /start-collabora-online.sh /
 
 # set up Collabora Online (normally done by postinstall script of package)
 # Fix permissions
-RUN setcap cap_fowner,cap_chown,cap_sys_chroot=ep /usr/bin/coolforkit && \
+RUN setcap cap_fowner,cap_chown,cap_sys_chroot=ep /usr/bin/coolforkit-caps && \
     setcap cap_sys_admin=ep /usr/bin/coolmount && \
     groupadd -r cool && \
     useradd -g cool -r cool -d /opt/cool -s /bin/bash && \

diff --git a/man/coolconfig.1 b/man/coolconfig.1
@@ -53,4 +53,4 @@ update\-system\-template
 .SS "generate\-proof\-key"
 The \fBgenerate\-proof\-key\fR command creates an RSA key pair in /etc/coolwsd for the WOPI Proof headers. The postinstall script of coolwsd package usually creates this RSA key pair in case of new installation.
 .SH "SEE ALSO"
-coolforkit(1), coolconvert(1), coolwsd(1), coolwsd-systemplate-setup(1), coolmount(1)
+coolforkit-ns(1), coolconvert(1), coolwsd(1), coolwsd-systemplate-setup(1), coolmount(1)
diff --git a/man/coolconvert.1 b/man/coolconvert.1
@@ -17,4 +17,4 @@ coolconvert OPTIONS FILE(S)
 \fB\-\-no\-check\-certificate\fR  Disable checking of SSL certs
 .PP
 .SH "SEE ALSO"
-coolwsd(1), coolforkit(1), coolconfig(1), coolwsd-systemplate-setup(1), coolmount(1)
+coolwsd(1), coolforkit-ns(1), coolconfig(1), coolwsd-systemplate-setup(1), coolmount(1)
diff --git a/man/coolforkit.1 → man/coolforkit-ns.1 b/man/coolforkit.1 → man/coolforkit-ns.1
@@ -1,8 +1,8 @@
-.TH COOLFORKIT "1" "May 2018" "coolforkit " "User Commands"
+.TH COOLFORKIT "1" "May 2018" "coolforkit-ns " "User Commands"
 .SH NAME
-coolforkit \- Utility that spawns LOK instances for Collabora Online
+coolforkit-ns \- Utility that spawns LOK instances for Collabora Online
 .SH SYNOPSIS
-coolforkit OPTIONS
+coolforkit-ns OPTIONS
 .SH DESCRIPTION
 Single-threaded process that spawns LibreOfficeKit (LOK) instances.
 .PP

diff --git a/man/coolmount.1 b/man/coolmount.1
@@ -8,4 +8,4 @@ This is a very tiny helper to allow overlay mounting.
 .PP
 \fBNote\fR: Running this standalone is not possible. It is used internally by coolwsd when it creates the jail for the document.
 .SH "SEE ALSO"
-coolwsd(1), coolconvert(1), coolconfig(1), coolwsd-systemplate-setup(1), coolforkit(1)
+coolwsd(1), coolconvert(1), coolconfig(1), coolwsd-systemplate-setup(1), coolforkit-ns(1)
diff --git a/man/coolstress.1 b/man/coolstress.1
@@ -36,4 +36,4 @@ in terms of keys-per-second, as well as creating unusual documents from a spell/
 perspective.
 
 .SH "SEE ALSO"
-coolforkit(1), coolconvert(1), coolwsd(1)
+coolforkit-ns(1), coolconvert(1), coolwsd(1)
diff --git a/man/coolwsd-systemplate-setup.1 b/man/coolwsd-systemplate-setup.1
@@ -6,4 +6,4 @@ coolwsd-systemplate-setup <chroot template directory for system libs to create>
 .SH DESCRIPTION
 coolwsd-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"
-coolforkit(1), coolconvert(1), coolconfig(1), coolwsd(1), coolmount(1)
+coolforkit-ns(1), coolconvert(1), coolconfig(1), coolwsd(1), coolmount(1)
diff --git a/man/coolwsd.1 b/man/coolwsd.1
@@ -33,4 +33,4 @@ coolwsd OPTIONS
 \fB\-\-use\-env\-vars\fR                Override coolwsd.xml config with options from the environment variables described in https://col.la/dockercodeconfigviaenv
 .PP
 .SH "SEE ALSO"
-coolforkit(1), coolconvert(1), coolconfig(1), coolwsd-systemplate-setup(1), coolmount(1)
+coolforkit-ns(1), coolconvert(1), coolconfig(1), coolwsd-systemplate-setup(1), coolmount(1)
diff --git a/wsd/COOLWSD.cpp b/wsd/COOLWSD.cpp
@@ -3516,7 +3516,7 @@ bool COOLWSD::createForKit()
     args.push_back("-tt");
     args.push_back("-s");
     args.push_back("256");
-    args.push_back(parentPath + "coolforkit");
+    args.push_back(parentPath + "coolforkit-caps");
 #elif VALGRIND_COOLFORKIT
     NoCapsForKit = true;
     NoSeccomp = true;
@@ -3533,7 +3533,7 @@ bool COOLWSD::createForKit()
     args.push_back("--error-limit=no");
     args.push_back("--num-callers=128");
     std::string nocapsCopy = parentPath + "coolforkit-nocaps";
-    FileUtil::copy(parentPath + "coolforkit", nocapsCopy, true, true);
+    FileUtil::copy(parentPath + "coolforkit-caps", nocapsCopy, true, true);
     args.push_back(nocapsCopy);
 #endif
     args.push_back("--systemplate=" + SysTemplate);
@@ -3582,12 +3582,12 @@ bool COOLWSD::createForKit()
     std::string forKitPath = std::move(parentPath);
     if (EnableMountNamespaces)
     {
-        forKitPath += "coolforkitns";
+        forKitPath += "coolforkit-ns";
         args.push_back("--namespace");
     }
     else
     {
-        forKitPath += "coolforkit";
+        forKitPath += "coolforkit-caps";
     }
 #endif