Rename binaries installed in /usr/bin to have less generic names

Closes: #925543

12 files changed, 156 insertions, 227 deletions

diff --git a/debian/dirs b/debian/dirs
index 9d2a980c..c318f88f 100644
--- a/debian/dirs
+++ b/debian/dirs
@@ -1,3 +1,4 @@
 etc/matrix-synapse
 var/lib/matrix-synapse
 var/log/matrix-synapse
+usr/libexec/matrix-synapse
diff --git a/debian/hash_password.1 b/debian/hash_password.1
index 383f4529..4ad24185 100644
--- a/debian/hash_password.1
+++ b/debian/hash_password.1
@@ -1,90 +1 @@
-.\" generated with Ronn/v0.7.3
-.\" http://github.com/rtomayko/ronn/tree/0.7.3
-.
-.TH "HASH_PASSWORD" "1" "February 2017" "" ""
-.
-.SH "NAME"
-\fBhash_password\fR \- Calculate the hash of a new password, so that passwords can be reset
-.
-.SH "SYNOPSIS"
-\fBhash_password\fR [\fB\-p\fR|\fB\-\-password\fR [password]] [\fB\-c\fR|\fB\-\-config\fR \fIfile\fR]
-.
-.SH "DESCRIPTION"
-\fBhash_password\fR calculates the hash of a supplied password using bcrypt\.
-.
-.P
-\fBhash_password\fR takes a password as an parameter either on the command line or the \fBSTDIN\fR if not supplied\.
-.
-.P
-It accepts an YAML file which can be used to specify parameters like the number of rounds for bcrypt and password_config section having the pepper value used for the hashing\. By default \fBbcrypt_rounds\fR is set to \fB10\fR\.
-.
-.P
-The hashed password is written on the \fBSTDOUT\fR\.
-.
-.SH "FILES"
-A sample YAML file accepted by \fBhash_password\fR is described below:
-.
-.P
-bcrypt_rounds: 17 password_config: pepper: "random hashing pepper"
-.
-.SH "OPTIONS"
-.
-.TP
-\fB\-p\fR, \fB\-\-password\fR
-Read the password form the command line if [password] is supplied\. If not, prompt the user and read the password form the \fBSTDIN\fR\. It is not recommended to type the password on the command line directly\. Use the STDIN instead\.
-.
-.TP
-\fB\-c\fR, \fB\-\-config\fR
-Read the supplied YAML \fIfile\fR containing the options \fBbcrypt_rounds\fR and the \fBpassword_config\fR section containing the \fBpepper\fR value\.
-.
-.SH "EXAMPLES"
-Hash from the command line:
-.
-.IP "" 4
-.
-.nf
-
-$ hash_password \-p "p@ssw0rd"
-$2b$12$VJNqWQYfsWTEwcELfoSi4Oa8eA17movHqqi8\.X8fWFpum7SxZ9MFe
-.
-.fi
-.
-.IP "" 0
-.
-.P
-Hash from the STDIN:
-.
-.IP "" 4
-.
-.nf
-
-$ hash_password
-Password:
-Confirm password:
-$2b$12$AszlvfmJl2esnyhmn8m/kuR2tdXgROWtWxnX\.rcuAbM8ErLoUhybG
-.
-.fi
-.
-.IP "" 0
-.
-.P
-Using a config file:
-.
-.IP "" 4
-.
-.nf
-
-$ hash_password \-c config\.yml
-Password:
-Confirm password:
-$2b$12$CwI\.wBNr\.w3kmiUlV3T5s\.GT2wH7uebDCovDrCOh18dFedlANK99O
-.
-.fi
-.
-.IP "" 0
-.
-.SH "COPYRIGHT"
-This man page was written by Rahul De <\fIrahulde@swecha\.net\fR> for Debian GNU/Linux distribution\.
-.
-.SH "SEE ALSO"
-synctl(1), synapse_port_db(1), register_new_matrix_user(1)
+.so man1/synapse_hash_password.1
diff --git a/debian/manpages b/debian/manpages
index 2c305835..fae28d3b 100644
--- a/debian/manpages
+++ b/debian/manpages
@@ -1,4 +1,4 @@
 debian/hash_password.1
 debian/register_new_matrix_user.1
-debian/synapse_port_db.1
+debian/synapse_*.1
 debian/synctl.1
diff --git a/debian/matrix-synapse.links b/debian/matrix-synapse.links
new file mode 100644
index 00000000..7b678390
--- /dev/null
+++ b/debian/matrix-synapse.links
@@ -0,0 +1,13 @@
+/usr/libexec/matrix-synapse/export_signing_key              /usr/bin/synapse_export_signing_key
+/usr/libexec/matrix-synapse/generate_config                 /usr/bin/synapse_generate_config
+/usr/libexec/matrix-synapse/generate_log_config             /usr/bin/synapse_generate_log_config
+/usr/libexec/matrix-synapse/generate_signing_key            /usr/bin/synapse_generate_signing_key
+/usr/libexec/matrix-synapse/hash_password                   /usr/bin/synapse_hash_password
+/usr/libexec/matrix-synapse/register_new_matrix_user        /usr/bin/synapse_register_new_matrix_user
+/usr/libexec/matrix-synapse/synapse_homeserver              /usr/bin/synapse_homeserver
+/usr/libexec/matrix-synapse/synapse_port_db                 /usr/bin/synapse_port_db
+/usr/libexec/matrix-synapse/synapse_review_recent_signups   /usr/bin/synapse_review_recent_signups
+/usr/libexec/matrix-synapse/synapse_worker                  /usr/bin/synapse_worker
+/usr/libexec/matrix-synapse/synctl                          /usr/bin/synctl
+/usr/libexec/matrix-synapse/update_synapse_database         /usr/bin/synapse_update_database
+/usr/libexec/matrix-synapse/update_synapse_database         /usr/bin/update_synapse_database
diff --git a/debian/register_new_matrix_user.1 b/debian/register_new_matrix_user.1
index 99156a73..314d47e7 100644
--- a/debian/register_new_matrix_user.1
+++ b/debian/register_new_matrix_user.1
@@ -1,72 +1 @@
-.\" generated with Ronn/v0.7.3
-.\" http://github.com/rtomayko/ronn/tree/0.7.3
-.
-.TH "REGISTER_NEW_MATRIX_USER" "1" "February 2017" "" ""
-.
-.SH "NAME"
-\fBregister_new_matrix_user\fR \- Used to register new users with a given home server when registration has been disabled
-.
-.SH "SYNOPSIS"
-\fBregister_new_matrix_user\fR options\.\.\.
-.
-.SH "DESCRIPTION"
-\fBregister_new_matrix_user\fR registers new users with a given home server when registration has been disabled\. For this to work, the home server must be configured with the \'registration_shared_secret\' option set\.
-.
-.P
-This accepts the user credentials like the username, password, is user an admin or not and registers the user onto the homeserver database\. Also, a YAML file containing the shared secret can be provided\. If not, the shared secret can be provided via the command line\.
-.
-.P
-By default it assumes the home server URL to be \fBhttps://localhost:8448\fR\. This can be changed via the \fBserver_url\fR command line option\.
-.
-.SH "FILES"
-A sample YAML file accepted by \fBregister_new_matrix_user\fR is described below:
-.
-.IP "" 4
-.
-.nf
-
-registration_shared_secret: "s3cr3t"
-.
-.fi
-.
-.IP "" 0
-.
-.SH "OPTIONS"
-.
-.TP
-\fB\-u\fR, \fB\-\-user\fR
-Local part of the new user\. Will prompt if omitted\.
-.
-.TP
-\fB\-p\fR, \fB\-\-password\fR
-New password for user\. Will prompt if omitted\. Supplying the password on the command line is not recommended\. Use the STDIN instead\.
-.
-.TP
-\fB\-a\fR, \fB\-\-admin\fR
-Register new user as an admin\. Will prompt if omitted\.
-.
-.TP
-\fB\-c\fR, \fB\-\-config\fR
-Path to server config file containing the shared secret\.
-.
-.TP
-\fB\-k\fR, \fB\-\-shared\-secret\fR
-Shared secret as defined in server config file\. This is an optional parameter as it can be also supplied via the YAML file\.
-.
-.TP
-\fBserver_url\fR
-URL of the home server\. Defaults to \'https://localhost:8448\'\.
-.
-.SH "EXAMPLES"
-.
-.nf
-
-$ register_new_matrix_user \-u user1 \-p p@ssword \-a \-c config\.yaml
-.
-.fi
-.
-.SH "COPYRIGHT"
-This man page was written by Rahul De <\fIrahulde@swecha\.net\fR> for Debian GNU/Linux distribution\.
-.
-.SH "SEE ALSO"
-synctl(1), synapse_port_db(1), hash_password(1)
+.so man1/synapse_register_new_matrix_user.1
diff --git a/debian/rules b/debian/rules
index f1f77b5a..2590b942 100755
--- a/debian/rules
+++ b/debian/rules
@@ -14,6 +14,7 @@ override_dh_auto_install:
 	sed -i \
 		-e 's,#!/usr/bin/env perl,#!/usr/bin/perl,' \
 		debian/*/usr/bin/*
+	mv debian/*/usr/bin/* debian/*/usr/libexec/*/
 
 override_dh_installdocs:
 	dh_installdocs
diff --git a/debian/synapse_hash_password.1 b/debian/synapse_hash_password.1
new file mode 100644
index 00000000..a481dc10
--- /dev/null
+++ b/debian/synapse_hash_password.1
@@ -0,0 +1,58 @@
+.\" generated with Ronn-NG/v0.9.1
+.\" http://github.com/apjanke/ronn-ng/tree/0.9.1
+.TH "SYNAPSE_HASH_PASSWORD" "1" "March 2022" ""
+.SH "NAME"
+\fBsynapse_hash_password\fR \- Calculate the hash of a new password, so that passwords can be reset
+.SH "SYNOPSIS"
+\fBsynapse_hash_password\fR [\fB\-p\fR|\fB\-\-password\fR [password]] [\fB\-c\fR|\fB\-\-config\fR \fIfile\fR]
+.SH "DESCRIPTION"
+\fBsynapse_hash_password\fR calculates the hash of a supplied password using bcrypt\.
+.P
+\fBsynapse_hash_password\fR takes a password as an parameter either on the command line or the \fBSTDIN\fR if not supplied\.
+.P
+It accepts an YAML file which can be used to specify parameters like the number of rounds for bcrypt and password_config section having the pepper value used for the hashing\. By default \fBbcrypt_rounds\fR is set to \fB10\fR\.
+.P
+The hashed password is written on the \fBSTDOUT\fR\.
+.SH "FILES"
+A sample YAML file accepted by \fBsynapse_hash_password\fR is described below:
+.P
+bcrypt_rounds: 17 password_config: pepper: "random hashing pepper"
+.SH "OPTIONS"
+.TP
+\fB\-p\fR, \fB\-\-password\fR
+Read the password form the command line if [password] is supplied\. If not, prompt the user and read the password form the \fBSTDIN\fR\. It is not recommended to type the password on the command line directly\. Use the STDIN instead\.
+.TP
+\fB\-c\fR, \fB\-\-config\fR
+Read the supplied YAML \fIfile\fR containing the options \fBbcrypt_rounds\fR and the \fBpassword_config\fR section containing the \fBpepper\fR value\.
+.SH "EXAMPLES"
+Hash from the command line:
+.IP "" 4
+.nf
+$ synapse_hash_password \-p "p@ssw0rd"
+$2b$12$VJNqWQYfsWTEwcELfoSi4Oa8eA17movHqqi8\.X8fWFpum7SxZ9MFe
+.fi
+.IP "" 0
+.P
+Hash from the STDIN:
+.IP "" 4
+.nf
+$ synapse_hash_password
+Password:
+Confirm password:
+$2b$12$AszlvfmJl2esnyhmn8m/kuR2tdXgROWtWxnX\.rcuAbM8ErLoUhybG
+.fi
+.IP "" 0
+.P
+Using a config file:
+.IP "" 4
+.nf
+$ synapse_hash_password \-c config\.yml
+Password:
+Confirm password:
+$2b$12$CwI\.wBNr\.w3kmiUlV3T5s\.GT2wH7uebDCovDrCOh18dFedlANK99O
+.fi
+.IP "" 0
+.SH "COPYRIGHT"
+This man page was written by Rahul De «rahulde@swecha\.net» for Debian GNU/Linux distribution\.
+.SH "SEE ALSO"
+synctl(1), synapse_port_db(1), synapse_register_new_matrix_user(1)
diff --git a/debian/hash_password.ronn b/debian/synapse_hash_password.ronn
index 0b2afa73..710e9940 100644
--- a/debian/hash_password.ronn
+++ b/debian/synapse_hash_password.ronn
@@ -1,15 +1,15 @@
-hash_password(1) -- Calculate the hash of a new password, so that passwords can be reset
-========================================================================================
+synapse_hash_password(1) -- Calculate the hash of a new password, so that passwords can be reset
+================================================================================================
 
 ## SYNOPSIS
 
-`hash_password` [`-p`|`--password` [password]] [`-c`|`--config` <file>]
+`synapse_hash_password` [`-p`\|`--password` [password]] [`-c`\|`--config` <file>]
 
 ## DESCRIPTION
 
-**hash_password** calculates the hash of a supplied password using bcrypt.
+**synapse_hash_password** calculates the hash of a supplied password using bcrypt.
 
-`hash_password` takes a password as an parameter either on the command line
+`synapse_hash_password` takes a password as an parameter either on the command line
 or the `STDIN` if not supplied.
 
 It accepts an YAML file which can be used to specify parameters like the
@@ -20,7 +20,7 @@ The hashed password is written on the `STDOUT`.
 
 ## FILES
 
-A sample YAML file accepted by `hash_password` is described below:
+A sample YAML file accepted by `synapse_hash_password` is described below:
 
   bcrypt_rounds: 17
   password_config:
@@ -42,19 +42,19 @@ A sample YAML file accepted by `hash_password` is described below:
 
 Hash from the command line:
 
-    $ hash_password -p "p@ssw0rd"
+    $ synapse_hash_password -p "p@ssw0rd"
     $2b$12$VJNqWQYfsWTEwcELfoSi4Oa8eA17movHqqi8.X8fWFpum7SxZ9MFe
 
 Hash from the STDIN:
 
-    $ hash_password
+    $ synapse_hash_password
     Password:
     Confirm password:
     $2b$12$AszlvfmJl2esnyhmn8m/kuR2tdXgROWtWxnX.rcuAbM8ErLoUhybG
 
 Using a config file:
 
-    $ hash_password -c config.yml
+    $ synapse_hash_password -c config.yml
     Password:
     Confirm password:
     $2b$12$CwI.wBNr.w3kmiUlV3T5s.GT2wH7uebDCovDrCOh18dFedlANK99O
@@ -66,4 +66,4 @@ for Debian GNU/Linux distribution.
 
 ## SEE ALSO
 
-synctl(1), synapse_port_db(1), register_new_matrix_user(1)
+synctl(1), synapse_port_db(1), synapse_register_new_matrix_user(1)
diff --git a/debian/synapse_port_db.1 b/debian/synapse_port_db.1
index 4e6bc048..1e517686 100644
--- a/debian/synapse_port_db.1
+++ b/debian/synapse_port_db.1
@@ -1,83 +1,56 @@
-.\" generated with Ronn/v0.7.3
-.\" http://github.com/rtomayko/ronn/tree/0.7.3
-.
-.TH "SYNAPSE_PORT_DB" "1" "February 2017" "" ""
-.
+.\" generated with Ronn-NG/v0.9.1
+.\" http://github.com/apjanke/ronn-ng/tree/0.9.1
+.TH "SYNAPSE_PORT_DB" "1" "March 2022" ""
 .SH "NAME"
 \fBsynapse_port_db\fR \- A script to port an existing synapse SQLite database to a new PostgreSQL database\.
-.
 .SH "SYNOPSIS"
 \fBsynapse_port_db\fR [\-v] \-\-sqlite\-database=\fIdbfile\fR \-\-postgres\-config=\fIyamlconfig\fR [\-\-curses] [\-\-batch\-size=\fIbatch\-size\fR]
-.
 .SH "DESCRIPTION"
 \fBsynapse_port_db\fR ports an existing synapse SQLite database to a new PostgreSQL database\.
-.
 .P
 SQLite database is specified with \fB\-\-sqlite\-database\fR option and PostgreSQL configuration required to connect to PostgreSQL database is provided using \fB\-\-postgres\-config\fR configuration\. The configuration is specified in YAML format\.
-.
 .SH "OPTIONS"
-.
 .TP
 \fB\-v\fR
 Print log messages in \fBdebug\fR level instead of \fBinfo\fR level\.
-.
 .TP
 \fB\-\-sqlite\-database\fR
 The snapshot of the SQLite database file\. This must not be currently used by a running synapse server\.
-.
 .TP
 \fB\-\-postgres\-config\fR
 The database config file for the PostgreSQL database\.
-.
 .TP
 \fB\-\-curses\fR
 Display a curses based progress UI\.
-.
 .SH "CONFIG FILE"
 The postgres configuration file must be a valid YAML file with the following options\.
-.
-.IP "\(bu" 4
+.IP "\[ci]" 4
 \fBdatabase\fR: Database configuration section\. This section header can be ignored and the options below may be specified as top level keys\.
-.
-.IP "\(bu" 4
+.IP "\[ci]" 4
 \fBname\fR: Connector to use when connecting to the database\. This value must be \fBpsycopg2\fR\.
-.
-.IP "\(bu" 4
+.IP "\[ci]" 4
 \fBargs\fR: DB API 2\.0 compatible arguments to send to the \fBpsycopg2\fR module\.
-.
-.IP "\(bu" 4
+.IP "\[ci]" 4
 \fBdbname\fR \- the database name
-.
-.IP "\(bu" 4
+.IP "\[ci]" 4
 \fBuser\fR \- user name used to authenticate
-.
-.IP "\(bu" 4
+.IP "\[ci]" 4
 \fBpassword\fR \- password used to authenticate
-.
-.IP "\(bu" 4
+.IP "\[ci]" 4
 \fBhost\fR \- database host address (defaults to UNIX socket if not provided)
-.
-.IP "\(bu" 4
+.IP "\[ci]" 4
 \fBport\fR \- connection port number (defaults to 5432 if not provided)
-.
 .IP "" 0
 
-.
-.IP "\(bu" 4
-\fBsynchronous_commit\fR: Optional\. Default is True\. If the value is \fBFalse\fR, enable asynchronous commit and don\'t wait for the server to call fsync before ending the transaction\. See: https://www\.postgresql\.org/docs/current/static/wal\-async\-commit\.html
-.
+.IP "\[ci]" 4
+\fBsynchronous_commit\fR: Optional\. Default is True\. If the value is \fBFalse\fR, enable asynchronous commit and don't wait for the server to call fsync before ending the transaction\. See: https://www\.postgresql\.org/docs/current/static/wal\-async\-commit\.html
 .IP "" 0
 
-.
 .IP "" 0
-.
 .P
 Following example illustrates the configuration file format\.
-.
 .IP "" 4
-.
 .nf
-
 database:
   name: psycopg2
   args:
@@ -86,13 +59,9 @@ database:
     password: ORohmi9Eet=ohphi
     host: localhost
   synchronous_commit: false
-.
 .fi
-.
 .IP "" 0
-.
 .SH "COPYRIGHT"
-This man page was written by Sunil Mohan Adapa <\fIsunil@medhas\.org\fR> for Debian GNU/Linux distribution\.
-.
+This man page was written by Sunil Mohan Adapa «sunil@medhas\.org» for Debian GNU/Linux distribution\.
 .SH "SEE ALSO"
-synctl(1), hash_password(1), register_new_matrix_user(1)
+synctl(1), synapse_hash_password(1), synapse_register_new_matrix_user(1)
diff --git a/debian/synapse_port_db.ronn b/debian/synapse_port_db.ronn
index fcb32ebd..07465c3d 100644
--- a/debian/synapse_port_db.ronn
+++ b/debian/synapse_port_db.ronn
@@ -84,4 +84,4 @@ Debian GNU/Linux distribution.
 
 ## SEE ALSO
 
-synctl(1), hash_password(1), register_new_matrix_user(1)
+synctl(1), synapse_hash_password(1), synapse_register_new_matrix_user(1)
diff --git a/debian/synapse_register_new_matrix_user.1 b/debian/synapse_register_new_matrix_user.1
new file mode 100644
index 00000000..34a5f95f
--- /dev/null
+++ b/debian/synapse_register_new_matrix_user.1
@@ -0,0 +1,47 @@
+.\" generated with Ronn-NG/v0.9.1
+.\" http://github.com/apjanke/ronn-ng/tree/0.9.1
+.TH "SYNAPSE_REGISTER_NEW_MATRIX_USER" "1" "March 2022" ""
+.SH "NAME"
+\fBsynapse_register_new_matrix_user\fR \- Used to register new users with a given home server when registration has been disabled
+.SH "SYNOPSIS"
+\fBsynapse_register_new_matrix_user\fR options\|\.\|\.\|\.
+.SH "DESCRIPTION"
+\fBsynapse_register_new_matrix_user\fR registers new users with a given home server when registration has been disabled\. For this to work, the home server must be configured with the 'registration_shared_secret' option set\.
+.P
+This accepts the user credentials like the username, password, is user an admin or not and registers the user onto the homeserver database\. Also, a YAML file containing the shared secret can be provided\. If not, the shared secret can be provided via the command line\.
+.P
+By default it assumes the home server URL to be \fBhttps://localhost:8448\fR\. This can be changed via the \fBserver_url\fR command line option\.
+.SH "FILES"
+A sample YAML file accepted by \fBsynapse_register_new_matrix_user\fR is described below:
+.IP "" 4
+.nf
+registration_shared_secret: "s3cr3t"
+.fi
+.IP "" 0
+.SH "OPTIONS"
+.TP
+\fB\-u\fR, \fB\-\-user\fR
+Local part of the new user\. Will prompt if omitted\.
+.TP
+\fB\-p\fR, \fB\-\-password\fR
+New password for user\. Will prompt if omitted\. Supplying the password on the command line is not recommended\. Use the STDIN instead\.
+.TP
+\fB\-a\fR, \fB\-\-admin\fR
+Register new user as an admin\. Will prompt if omitted\.
+.TP
+\fB\-c\fR, \fB\-\-config\fR
+Path to server config file containing the shared secret\.
+.TP
+\fB\-k\fR, \fB\-\-shared\-secret\fR
+Shared secret as defined in server config file\. This is an optional parameter as it can be also supplied via the YAML file\.
+.TP
+\fBserver_url\fR
+URL of the home server\. Defaults to 'https://localhost:8448'\.
+.SH "EXAMPLES"
+.nf
+$ synapse_register_new_matrix_user \-u user1 \-p p@ssword \-a \-c config\.yaml
+.fi
+.SH "COPYRIGHT"
+This man page was written by Rahul De «rahulde@swecha\.net» for Debian GNU/Linux distribution\.
+.SH "SEE ALSO"
+synctl(1), synapse_port_db(1), synapse_hash_password(1)
diff --git a/debian/register_new_matrix_user.ronn b/debian/synapse_register_new_matrix_user.ronn
index 4c22e74d..c4a3b1b3 100644
--- a/debian/register_new_matrix_user.ronn
+++ b/debian/synapse_register_new_matrix_user.ronn
@@ -1,13 +1,13 @@
-register_new_matrix_user(1) -- Used to register new users with a given home server when registration has been disabled
-======================================================================================================================
+synapse_register_new_matrix_user(1) -- Used to register new users with a given home server when registration has been disabled
+==============================================================================================================================
 
 ## SYNOPSIS
 
-`register_new_matrix_user` options...
+`synapse_register_new_matrix_user` options...
 
 ## DESCRIPTION
 
-**register_new_matrix_user** registers new users with a given home server when
+**synapse_register_new_matrix_user** registers new users with a given home server when
 registration has been disabled. For this to work, the home server must be
 configured with the 'registration_shared_secret' option set.
 
@@ -21,7 +21,7 @@ This can be changed via the `server_url` command line option.
 
 ## FILES
 
-A sample YAML file accepted by `register_new_matrix_user` is described below:
+A sample YAML file accepted by `synapse_register_new_matrix_user` is described below:
 
     registration_shared_secret: "s3cr3t"
 
@@ -49,7 +49,7 @@ A sample YAML file accepted by `register_new_matrix_user` is described below:
 
 ## EXAMPLES
 
-    $ register_new_matrix_user -u user1 -p p@ssword -a -c config.yaml
+    $ synapse_register_new_matrix_user -u user1 -p p@ssword -a -c config.yaml
 
 ## COPYRIGHT
 
@@ -58,4 +58,4 @@ for Debian GNU/Linux distribution.
 
 ## SEE ALSO
 
-synctl(1), synapse_port_db(1), hash_password(1)
+synctl(1), synapse_port_db(1), synapse_hash_password(1)