]> the.earth.li Git - onak.git/commitdiff
Rename keyd(ctl) to onak-keyd(ctl)
authorJonathan McDowell <noodles@earth.li>
Thu, 17 Jul 2025 09:15:20 +0000 (10:15 +0100)
committerJonathan McDowell <noodles@earth.li>
Thu, 17 Jul 2025 09:15:20 +0000 (10:15 +0100)
keyd is a very generic name for this, and there's at least one other
program out there we conflict with as a result. Given it's a daemon
there's no real cost to us from prepending onak- to clearly
disambiguate.

.gitignore
debian/onak.init
debian/onak.service
keydb/CMakeLists.txt
keydb/keyd.8 [deleted file]
keydb/keydctl.8 [deleted file]
keydb/onak-keyd.8 [new file with mode: 0644]
keydb/onak-keydctl.8 [new file with mode: 0644]

index 8aa78ecbe91dd3be77af9a4c260eb9ce50030b31..98997c0dd81fd35e1c26ee912a6d45248e1125d5 100644 (file)
@@ -3,9 +3,9 @@ hashquery
 lookup
 onak
 gpgwww
-keyd
-keydctl
 maxpath
+onak-keyd
+onak-keydctl
 onak-mail.pl
 onak.ini
 sixdegrees
index 9ab011bd4286a892f43a62adf67e29894106d2eb..570b307fbf883707d1b9bd4272c7c75aa484f91e 100644 (file)
@@ -16,7 +16,7 @@
 
 PATH=/sbin:/usr/sbin:/bin:/usr/bin
 DESC="PGP Keyserver backend"
-NAME=keyd
+NAME=onak-keyd
 DAEMON=/usr/sbin/$NAME
 DAEMON_ARGS=""
 SCRIPTNAME=/etc/init.d/onak
@@ -48,7 +48,7 @@ case "$1" in
        ;;
   stop)
        [ "$VERBOSE" != no ] && log_daemon_msg "Stopping $DESC" "$NAME"
-       /usr/bin/keydctl quit
+       /usr/bin/onak-keydctl quit
        start-stop-daemon --stop --oknodo --user onak --exec $DAEMON
        case "$?" in
                0) [ "$VERBOSE" != no ] && log_end_msg 0 ;;
@@ -57,7 +57,7 @@ case "$1" in
        ;;
   restart|force-reload)
        [ "$VERBOSE" != no ] && log_daemon_msg "Restarting $DESC" "$NAME"
-       /usr/bin/keydctl quit
+       /usr/bin/onak-keydctl quit
        start-stop-daemon --stop --oknodo --user onak --exec $DAEMON
        start-stop-daemon --start --oknodo --user onak --chuid onak \
                --exec $DAEMON
index 44b6149009ba2b08198c476b0be5fdf3b94c780e..1be45dc576beceaa9a1e7fee0f57f676d974ad35 100644 (file)
@@ -1,12 +1,12 @@
 [Unit]
 Description=Backend caching key daemon for onak OpenPGP keyserver
-Documentation=man:keyd
+Documentation=man:onak-keyd
 Requires=onak.socket
 
 [Service]
 User=onak
-ExecStart=/usr/sbin/keyd -f
-ExecStop=/usr/bin/keydctl quit
+ExecStart=/usr/sbin/onak-keyd -f
+ExecStop=/usr/bin/onak-keydctl quit
 
 [Install]
 WantedBy=multi-user.target
index 7567b6c61efbad2570f2d7fdb8291ae85960d5f1..64c4215e3fcba255409f77bb4dfa9ea71216fb39 100644 (file)
@@ -30,22 +30,22 @@ endif()
 if (KEYD STREQUAL "ON")
        LIST(APPEND BACKENDS keyd)
 
-       add_executable(keyd keyd.c)
-       target_link_libraries(keyd libonak)
-       add_executable(keydctl keydctl.c ../onak-conf.c)
-       target_link_libraries(keydctl libonak)
-       target_compile_definitions(keydctl PRIVATE
+       add_executable(onak-keyd keyd.c)
+       target_link_libraries(onak-keyd libonak)
+       add_executable(onak-keydctl keydctl.c ../onak-conf.c)
+       target_link_libraries(onak-keydctl libonak)
+       target_compile_definitions(onak-keydctl PRIVATE
                CONFIGDIR="${CMAKE_INSTALL_FULL_SYSCONFDIR}")
 
        if (SYSTEMD_FOUND)
-               target_include_directories(keyd SYSTEM PUBLIC
+               target_include_directories(onak-keyd SYSTEM PUBLIC
                        ${SYSTEMD_INCLUDE_DIRS})
-               target_link_libraries(keyd ${SYSTEMD_LIBRARIES})
+               target_link_libraries(onak-keyd ${SYSTEMD_LIBRARIES})
        endif()
 
-       install(TARGETS keydctl RUNTIME DESTINATION ${CMAKE_INSTALL_BINDIR})
-       install(TARGETS keyd RUNTIME DESTINATION ${CMAKE_INSTALL_SBINDIR})
-       install(FILES keyd.8 keydctl.8
+       install(TARGETS onak-keydctl RUNTIME DESTINATION ${CMAKE_INSTALL_BINDIR})
+       install(TARGETS onak-keyd RUNTIME DESTINATION ${CMAKE_INSTALL_SBINDIR})
+       install(FILES onak-keyd.8 onak-keydctl.8
                DESTINATION ${CMAKE_INSTALL_MANDIR}/man8/)
 endif()
 
diff --git a/keydb/keyd.8 b/keydb/keyd.8
deleted file mode 100644 (file)
index 93cb31f..0000000
+++ /dev/null
@@ -1,42 +0,0 @@
-.TH KEYD 8
-.SH NAME
-keyd \- Backend key serving daemon for the onak PGP keyserver 
-.SH SYNOPSIS
-.PP
-.B keyd
-[
-.B options
-]
-.SH DESCRIPTION
-.PP
-keyd is a backend daemon for the onak PGP keyserver. It listens on a Unix
-socket for connections from the various CGI and mail front ends and
-handles talking to the backend database. It is intended to be of use in
-high load keyservers to reduce the time spent in connecting and
-disconnecting from the key database.
-.PP
-keyd is currently fairly alpha code; it is only recommended that you use
-it if you know what you are doing.
-.SS "Options"
-.TP
-\fB\-c \fIFILE\fR\fR
-Use \fIFILE\fR as the config file instead of the default.
-.TP
-\fB\-f\fR
-Run in the foreground rather than forking and daemonising.
-.TP
-\fB\-h\fR
-Display help text.
-.SH FILES
-.br
-.nf
-.\" set tabstop to longest possible filename, plus a wee bit
-.ta \w'/usr/lib/perl/getopts.pl   'u
-\fI/etc/onak.ini\fR    default configuration file
-.SH NOTES
-This man page could probably do with some more details.
-.SH "SEE ALSO"
-.BR onak (1)
-.SH AUTHOR
-onak was written by Jonathan McDowell <noodles@earth.li>. It can be found at
-http://www.earth.li/projectpurple/progs/onak.html
diff --git a/keydb/keydctl.8 b/keydb/keydctl.8
deleted file mode 100644 (file)
index 430da37..0000000
+++ /dev/null
@@ -1,51 +0,0 @@
-.TH KEYD 8
-.SH NAME
-keydctl \- control an onak keyd instance
-.SH SYNOPSIS
-.PP
-.B keydctl
-[
-.B options
-]
-.B command
-.SH DESCRIPTION
-.PP
-keydctl is a command line client for interacting with a backend keyd
-daemon. It's intended to perform functions that are specifically related
-to keyd rather than being generic keyserver functions. See
-.BR onak(1)
-for details about how to perform key related operations.
-.SS "Options"
-.TP
-\fB\-c \fIFILE\fR\fR
-Use \fIFILE\fR as the config file instead of the default.
-.TP
-\fB\-h\fR
-Display help text.
-.SS "Commands"
-.TP
-.B check
-Query if keyd is running and accepting commands. Returns 0 if it is, 1
-otherwise. Outputs nothing to stdout/stderr.
-.TP
-.B quit
-Request that keyd exits cleanly
-.TP
-.B status
-Display the status of a running keyd. Currently the protocol version in use,
-when keyd was started, the number of client connections seen and a breakdown
-of the commands seen.
-.SH FILES
-.br
-.nf
-.\" set tabstop to longest possible filename, plus a wee bit
-.ta \w'/usr/lib/perl/getopts.pl   'u
-\fI/etc/onak.ini\fR    default configuration file
-.SH NOTES
-This man page could probably do with some more details.
-.SH "SEE ALSO"
-.BR onak (1)
-.BR keyd (8)
-.SH AUTHOR
-onak was written by Jonathan McDowell <noodles@earth.li>. It can be found at
-http://www.earth.li/projectpurple/progs/onak.html
diff --git a/keydb/onak-keyd.8 b/keydb/onak-keyd.8
new file mode 100644 (file)
index 0000000..36aac45
--- /dev/null
@@ -0,0 +1,42 @@
+.TH KEYD 8
+.SH NAME
+onak-keyd \- Backend key serving daemon for the onak PGP keyserver
+.SH SYNOPSIS
+.PP
+.B onak-keyd
+[
+.B options
+]
+.SH DESCRIPTION
+.PP
+keyd is a backend daemon for the onak PGP keyserver. It listens on a Unix
+socket for connections from the various CGI and mail front ends and
+handles talking to the backend database. It is intended to be of use in
+high load keyservers to reduce the time spent in connecting and
+disconnecting from the key database.
+.PP
+keyd is currently fairly alpha code; it is only recommended that you use
+it if you know what you are doing.
+.SS "Options"
+.TP
+\fB\-c \fIFILE\fR\fR
+Use \fIFILE\fR as the config file instead of the default.
+.TP
+\fB\-f\fR
+Run in the foreground rather than forking and daemonising.
+.TP
+\fB\-h\fR
+Display help text.
+.SH FILES
+.br
+.nf
+.\" set tabstop to longest possible filename, plus a wee bit
+.ta \w'/usr/lib/perl/getopts.pl   'u
+\fI/etc/onak.ini\fR    default configuration file
+.SH NOTES
+This man page could probably do with some more details.
+.SH "SEE ALSO"
+.BR onak (1)
+.SH AUTHOR
+onak was written by Jonathan McDowell <noodles@earth.li>. It can be found at
+https://www.earth.li/projectpurple/progs/onak.html
diff --git a/keydb/onak-keydctl.8 b/keydb/onak-keydctl.8
new file mode 100644 (file)
index 0000000..58afba1
--- /dev/null
@@ -0,0 +1,51 @@
+.TH KEYD 8
+.SH NAME
+onak-keydctl \- control an onak keyd instance
+.SH SYNOPSIS
+.PP
+.B onak-keydctl
+[
+.B options
+]
+.B command
+.SH DESCRIPTION
+.PP
+keydctl is a command line client for interacting with a backend onak-keyd
+daemon. It's intended to perform functions that are specifically related
+to onak-keyd rather than being generic keyserver functions. See
+.BR onak(1)
+for details about how to perform key related operations.
+.SS "Options"
+.TP
+\fB\-c \fIFILE\fR\fR
+Use \fIFILE\fR as the config file instead of the default.
+.TP
+\fB\-h\fR
+Display help text.
+.SS "Commands"
+.TP
+.B check
+Query if onak-keyd is running and accepting commands. Returns 0 if it is, 1
+otherwise. Outputs nothing to stdout/stderr.
+.TP
+.B quit
+Request that onak-keyd exits cleanly
+.TP
+.B status
+Display the status of a running onak-keyd. Currently the protocol version in use,
+when onak-keyd was started, the number of client connections seen and a breakdown
+of the commands seen.
+.SH FILES
+.br
+.nf
+.\" set tabstop to longest possible filename, plus a wee bit
+.ta \w'/usr/lib/perl/getopts.pl   'u
+\fI/etc/onak.ini\fR    default configuration file
+.SH NOTES
+This man page could probably do with some more details.
+.SH "SEE ALSO"
+.BR onak (1)
+.BR onak-keyd (8)
+.SH AUTHOR
+onak was written by Jonathan McDowell <noodles@earth.li>. It can be found at
+https://www.earth.li/projectpurple/progs/onak.html