From 3019b424beddccaf5e9fd45785cb362e694d7d2f Mon Sep 17 00:00:00 2001 From: Max Erenberg <> Date: Thu, 28 Oct 2021 20:24:02 -0400 Subject: [PATCH] fix manpages --- .gitignore | 3 +++ README.md | 6 ++++-- docs/ceo.ini.5.scd | 12 ++++++------ docs/ceod.ini.5.scd | 46 ++++++++++++++++++++++----------------------- 4 files changed, 36 insertions(+), 31 deletions(-) diff --git a/.gitignore b/.gitignore index f2dcb59..24c32f2 100644 --- a/.gitignore +++ b/.gitignore @@ -1,3 +1,6 @@ +# If you update this file, please also update the extend-diff-ignore option +# in debian/source/options. + __pycache__/ /venv/ /dist/ diff --git a/README.md b/README.md index 38b8d68..74d310e 100644 --- a/README.md +++ b/README.md @@ -235,6 +235,8 @@ apt install devscripts debhelper git-buildpackage ``` Make sure to also install all of the packages in the 'Build-Depends' section in debian/control. +Make sure you git commit your changes *before* building the packages. + To build unsigned packages: ```sh gbp buildpackage --git-ignore-new --git-upstream-tree=BRANCH --git-upstream-branch=master -uc -us @@ -255,7 +257,7 @@ rm ../*.{xz,gz,dsc,build,buildinfo,changes,deb} ### Uploading Ask a syscom member for their dupload.conf file, and place it in your ~/.dupload.conf. -Then, from a CSC machine, run (from the parent directory): +Then, from a CSC machine, upload the changes file from the parent directory, e.g. ``` -dupload *.changes +dupload ceo_1.0.0-buster1_amd64.changes ``` diff --git a/docs/ceo.ini.5.scd b/docs/ceo.ini.5.scd index 1b823bc..7c6012e 100644 --- a/docs/ceo.ini.5.scd +++ b/docs/ceo.ini.5.scd @@ -13,23 +13,23 @@ ceo.ini - configuration file for ceo ceo.ini is an INI file with various sections which control the behaviour of *ceo*(1). # DEFAULTS SECTION - _base_domain_++ + _base\_domain_++ The domain name of CSC. Should be set to 'csclub.uwaterloo.ca'. - _uw_domain_++ + _uw\_domain_++ The domain of UW. Should be set to 'uwaterloo.ca'. # CEOD SECTION - _admin_host_++ + _admin\_host_++ The host with the ceod/admin Kerberos key. - _database_host_++ + _database\_host_++ The host with the root password for MySQL and PostgreSQL. - _mailman_host_++ + _mailman\_host_++ The host running Mailman. - _use_https_++ + _use\_https_++ Whether to use HTTPS when connecting to ceod. Should be set to 'true'. _port_++ diff --git a/docs/ceod.ini.5.scd b/docs/ceod.ini.5.scd index e713199..d530dec 100644 --- a/docs/ceod.ini.5.scd +++ b/docs/ceod.ini.5.scd @@ -13,59 +13,59 @@ ceod.ini - configuration file for ceod ceod.ini is an INI file with various sections which control the behaviour of ceod. # DEFAULTS SECTION - _base_domain_++ + _base\_domain_++ The domain name of CSC. Should be set to 'csclub.uwaterloo.ca'. # CEOD SECTION - _admin_host_++ + _admin\_host_++ The host with the ceod/admin Kerberos key. - _fs_root_host_++ + _fs\_root\_host_++ The host without NFS root squashing. - _database_host_++ + _database\_host_++ The host with the root password for MySQL and PostgreSQL. - _mailman_host_++ + _mailman\_host_++ The host running Mailman. - _use_https_++ + _use\_https_++ Whether to use HTTPS when connecting to ceod. Should be set to 'true'. _port_++ The port on which ceod is listening. # LDAP SECTION - _admin_principal_++ + _admin\_principal_++ The Kerberos principal which ceod should use for *kadmin*(1). - _server_url_++ + _server\_url_++ The primary CSC LDAP server URL. - _sasl_realm_++ + _sasl\_realm_++ The CSC SASL realm for LDAP. Should be 'CSCLUB.UWATERLOO.CA'. - _users_base_++ + _users\_base_++ The LDAP OU where users are stored. - _groups_base_++ + _groups\_base_++ The LDAP OU where groups are stored. - _sudo_base_++ + _sudo\_base_++ The LDAP OU where *sudo*(8) roles are stored. # UWLDAP SECTION - _server_url_++ + _server\_url_++ The UW LDAP server URL. _base_++ The LDAP OU where users are stored in the UW LDAP. # MEMBERS SECTION - _min_id_++ + _min\_id_++ The minimum UID number for members. - _max_id_++ + _max\_id_++ The maximum UID number for members. _home_++ @@ -75,10 +75,10 @@ ceod.ini is an INI file with various sections which control the behaviour of ceo The skeleton directory for new members. # CLUBS SECTION - _min_id_++ + _min\_id_++ The minimum UID number for club accounts. - _max_id_++ + _max\_id_++ The maximum UID number for club accounts. _home_++ @@ -88,23 +88,23 @@ ceod.ini is an INI file with various sections which control the behaviour of ceo The skeleton directory for new club accounts. # MAIL SECTION - _smtp_url_++ + _smtp\_url_++ The SMTP URL where ceod should send emails. - _smtp_starttls_++ + _smtp\_starttls_++ Whether ceod should use STARTTLS with the SMTP server or not. # MAILMAN3 SECTION - _api_base_url_++ + _api\_base\_url_++ The base URL of the Mailman 3 API. - _api_username_++ + _api\_username_++ The username to use when authenticating to the Mailman 3 API via HTTP Basic Auth. - _api_password_++ + _api\_password_++ The password to use when authenticating to the Mailman 3 API via HTTP Basic Auth. - _new_member_list_++ + _new\_member\_list_++ The mailing list to which new members should be subscribed. # AUXILIARY GROUPS SECTION