From fb2a2b2ce1c7fffdd880c36efa40453c2e87a75e Mon Sep 17 00:00:00 2001 From: Jordan Dominion Date: Sun, 21 Apr 2024 10:23:14 -0400 Subject: [PATCH 1/4] Add manpages installation. Add `tgs-configure` manpage Closes #1801 --- build/package/deb/install_artifacts.sh | 1 + build/package/deb/man/man1/tgs-configure.1 | 16 ++++++++++++++++ 2 files changed, 17 insertions(+) create mode 100644 build/package/deb/man/man1/tgs-configure.1 diff --git a/build/package/deb/install_artifacts.sh b/build/package/deb/install_artifacts.sh index dead938fa2..47e355981a 100755 --- a/build/package/deb/install_artifacts.sh +++ b/build/package/deb/install_artifacts.sh @@ -1,3 +1,4 @@ #!/usr/bin/sh -e cd artifacts && for f in $(find * -type f); do install -D "$f" "$1/opt/tgstation-server/$f"; done +cd ../build/package/deb/man && for f in $(find * -type f); do install -D "$f" "$1/usr/local/man/$f"; done diff --git a/build/package/deb/man/man1/tgs-configure.1 b/build/package/deb/man/man1/tgs-configure.1 new file mode 100644 index 0000000000..a100936d70 --- /dev/null +++ b/build/package/deb/man/man1/tgs-configure.1 @@ -0,0 +1,16 @@ +.TH TGS-CONFIGURE 1 +.SH NAME +tgs-configure \- tgstation-server interactive configuration file generator +.SH SYNOPSIS +.B tgs-configure +.SH DESCRIPTION +.B tgs-configure +.SH OPTIONS +The +.B tgs-configure + command does not take any options. +modifies the tgstation-server configuration file stored in /etc/tgstation-server/appsettings.Production.yml. +.SH BUGS +See issue tracker at https://github.com/tgstation/tgstation-server/issues. +.SH AUTHOR +Jordan Dominion (Cyberboss@users.noreply.github.com) From 7b336a19a25954723fb37c71fb207d5895494c1b Mon Sep 17 00:00:00 2001 From: Jordan Dominion Date: Sun, 21 Apr 2024 10:35:47 -0400 Subject: [PATCH 2/4] Add missing `libgdiplus` install to .deb package script --- build/package/deb/build_package.sh | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/build/package/deb/build_package.sh b/build/package/deb/build_package.sh index 0732f96486..1a25546da8 100755 --- a/build/package/deb/build_package.sh +++ b/build/package/deb/build_package.sh @@ -19,7 +19,8 @@ apt-get install -y \ ca-certificates \ curl \ gnupg \ - xmlstarlet + xmlstarlet \ + libgdiplus declare repo_version=$(if command -v lsb_release &> /dev/null; then lsb_release -r -s; else grep -oP '(?<=^VERSION_ID=).+' /etc/os-release | tr -d '"'; fi) curl -L https://packages.microsoft.com/config/ubuntu/$repo_version/packages-microsoft-prod.deb -o packages-microsoft-prod.deb From 01dfda32ccfdf26a0a14f124abb8c4c66890c2d2 Mon Sep 17 00:00:00 2001 From: Jordan Dominion Date: Sun, 21 Apr 2024 13:07:20 -0400 Subject: [PATCH 3/4] Improve manpages. Adjust description wording --- README.md | 2 +- build/package/deb/man/man1/tgs-configure.1 | 2 ++ build/package/deb/man/man7/tgstation-server.7 | 11 +++++++++++ 3 files changed, 14 insertions(+), 1 deletion(-) create mode 100644 build/package/deb/man/man7/tgstation-server.7 diff --git a/README.md b/README.md index ac54b0fde5..92b8f72509 100644 --- a/README.md +++ b/README.md @@ -6,7 +6,7 @@ [![forthebadge](http://forthebadge.com/images/badges/made-with-c-sharp.svg)](http://forthebadge.com) [![forinfinityandbyond](https://user-images.githubusercontent.com/5211576/29499758-4efff304-85e6-11e7-8267-62919c3688a9.gif)](https://www.reddit.com/r/SS13/comments/5oplxp/what_is_the_main_problem_with_byond_as_an_engine/dclbu1a) [![forthebadge](http://forthebadge.com/images/badges/built-with-love.svg)](http://forthebadge.com) -This is a toolset to manage production BYOND servers. It includes the ability to update the server without having to stop or shutdown the server (the update will take effect on a "reboot" of the server), the ability to start the server and restart it if it crashes, as well as systems for managing code and game files, and locally merging GitHub Pull Requests for test deployments. +This is a toolset to manage production DreamMaker servers. It includes the ability to update the server without having to stop or shutdown the server (the update will take effect on a "reboot" of the server), the ability to start the server and restart it if it crashes, as well as systems for managing code and game files, and locally merging GitHub Pull Requests for test deployments. ## Setup diff --git a/build/package/deb/man/man1/tgs-configure.1 b/build/package/deb/man/man1/tgs-configure.1 index a100936d70..43c8564684 100644 --- a/build/package/deb/man/man1/tgs-configure.1 +++ b/build/package/deb/man/man1/tgs-configure.1 @@ -10,6 +10,8 @@ The .B tgs-configure command does not take any options. modifies the tgstation-server configuration file stored in /etc/tgstation-server/appsettings.Production.yml. +.SH SEE ALSO +tgstation-server(7) .SH BUGS See issue tracker at https://github.com/tgstation/tgstation-server/issues. .SH AUTHOR diff --git a/build/package/deb/man/man7/tgstation-server.7 b/build/package/deb/man/man7/tgstation-server.7 new file mode 100644 index 0000000000..8f3127ecc5 --- /dev/null +++ b/build/package/deb/man/man7/tgstation-server.7 @@ -0,0 +1,11 @@ +.TH TGSTATION-SERVER 7 +.SH NAME +tgstation-server \- A production scale tool for DreamMaker server management +.SH DESCRIPTION +This is a toolset to manage production DreamMaker servers. It includes the ability to update the server without having to stop or shutdown the server (the update will take effect on a "reboot" of the server), the ability to start the server and restart it if it crashes, as well as systems for managing code and game files, and locally merging GitHub Pull Requests for test deployments. +.SH SEE ALSO +tgs-configure(1) +.SH BUGS +See issue tracker at https://github.com/tgstation/tgstation-server/issues. +.SH AUTHOR +Jordan Dominion (Cyberboss@users.noreply.github.com) From 40d69f3b0cb1c25dd07aba75a26c7d7db03d9c91 Mon Sep 17 00:00:00 2001 From: Jordan Dominion Date: Sun, 21 Apr 2024 13:59:06 -0400 Subject: [PATCH 4/4] Fix manpages installation --- build/package/deb/{man/man1 => debian/man}/tgs-configure.1 | 0 build/package/deb/{man/man7 => debian/man}/tgstation-server.7 | 0 build/package/deb/debian/manpages | 2 ++ build/package/deb/install_artifacts.sh | 1 - 4 files changed, 2 insertions(+), 1 deletion(-) rename build/package/deb/{man/man1 => debian/man}/tgs-configure.1 (100%) rename build/package/deb/{man/man7 => debian/man}/tgstation-server.7 (100%) create mode 100644 build/package/deb/debian/manpages diff --git a/build/package/deb/man/man1/tgs-configure.1 b/build/package/deb/debian/man/tgs-configure.1 similarity index 100% rename from build/package/deb/man/man1/tgs-configure.1 rename to build/package/deb/debian/man/tgs-configure.1 diff --git a/build/package/deb/man/man7/tgstation-server.7 b/build/package/deb/debian/man/tgstation-server.7 similarity index 100% rename from build/package/deb/man/man7/tgstation-server.7 rename to build/package/deb/debian/man/tgstation-server.7 diff --git a/build/package/deb/debian/manpages b/build/package/deb/debian/manpages new file mode 100644 index 0000000000..b78c157959 --- /dev/null +++ b/build/package/deb/debian/manpages @@ -0,0 +1,2 @@ +debian/man/tgs-configure.1 +debian/man/tgstation-server.7 diff --git a/build/package/deb/install_artifacts.sh b/build/package/deb/install_artifacts.sh index 47e355981a..dead938fa2 100755 --- a/build/package/deb/install_artifacts.sh +++ b/build/package/deb/install_artifacts.sh @@ -1,4 +1,3 @@ #!/usr/bin/sh -e cd artifacts && for f in $(find * -type f); do install -D "$f" "$1/opt/tgstation-server/$f"; done -cd ../build/package/deb/man && for f in $(find * -type f); do install -D "$f" "$1/usr/local/man/$f"; done