From db3cf3e42d93112278f5e86cca2c886627ef48b2 Mon Sep 17 00:00:00 2001 From: Ava Hahn Date: Mon, 22 Apr 2024 13:26:34 +0100 Subject: tools: Add unitctl CLI * Pull in entire unit-rust-sdk project * not included: CLA, COC, License * not included: duplicate openapi spec * not included: CI workflows * not included: changelog tooling * not included: commitsar tooling * not included: OpenAPI Web UI feature * update links in unitctl manpage * remove IDE configuration from .gitignore * rename Containerfile.debian to Dockerfile * simplify call to uname * keep Readmes and Makefiles to 80 character lines * outline specifically how to build unitctl for any desired target, and where to then find the binary for use * remove a section on the vision of the CLI which was superfluous given the state of completeness of the code and its use in unit * remove out of date feature proposals from readme * makefile: do not run when Rustup is not present * bump mio version to latest * generate openapi client library on demand * generate-openapi only runs when not present * generate-openapi now a dependency of binary build targets * deleted autogenerated code * reverted readme and Cargo document to autogenerated state * add additional build requirement to Readme Co-developed-by: Elijah Zupancic Signed-off-by: Elijah Zupancic Signed-off-by: Ava Hahn Reviewed-by: Andrew Clayton # non rust stuff [ tools/cli => tools/unitctl and subject tweak - Andrew ] Signed-off-by: Andrew Clayton --- tools/unitctl/man/unitctl.1 | 27 +++++++++++++++++++++++++++ 1 file changed, 27 insertions(+) create mode 100644 tools/unitctl/man/unitctl.1 (limited to 'tools/unitctl/man') diff --git a/tools/unitctl/man/unitctl.1 b/tools/unitctl/man/unitctl.1 new file mode 100644 index 00000000..1bd725c6 --- /dev/null +++ b/tools/unitctl/man/unitctl.1 @@ -0,0 +1,27 @@ +.\" Manpage for unitctl +.\" +.TH UNITCTL "1" "2022-12-29" "%%VERSION%%" "unitctl" +.SH NAME +unitctl \- NGINX UNIT Control Utility +.SH SYNOPSIS +unitctl [\fI\,FLAGS\/\fR] [\fI\,OPTIONS\/\fR] [\fI\,FILE\/\fR]... +.SH DESCRIPTION +WRITE ME +. +.SH "REPORTING BUGS" +Report any issues on the project issue tracker at: +.br +\fB\fR +. +.SH ACKNOWLEDGEMENTS +WRITE ME +. +.SH AUTHOR +Elijah Zupancic \fB\fR +. +.SH COPYRIGHT +Copyright \(co 2022 F5. All Rights Reserved. +.br +License: Apache License 2.0 (Apache-2.0) +.br +Full License Text: -- cgit From 0dcd3a91995d5ad0a9d27347bba22d1e8eae08b1 Mon Sep 17 00:00:00 2001 From: Gabor Javorszky Date: Mon, 16 Sep 2024 11:28:18 +0100 Subject: tools/unitctl: rename UNIT -> Unit The correct capitalisation of the name of the software is Unit, not all caps. Signed-off-by: Gabor Javorszky [ A bunch more s/UNIT/Unit/ - Andrew ] Signed-off-by: Andrew Clayton --- tools/unitctl/man/unitctl.1 | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'tools/unitctl/man') diff --git a/tools/unitctl/man/unitctl.1 b/tools/unitctl/man/unitctl.1 index 1bd725c6..0d775b6f 100644 --- a/tools/unitctl/man/unitctl.1 +++ b/tools/unitctl/man/unitctl.1 @@ -2,7 +2,7 @@ .\" .TH UNITCTL "1" "2022-12-29" "%%VERSION%%" "unitctl" .SH NAME -unitctl \- NGINX UNIT Control Utility +unitctl \- NGINX Unit Control Utility .SH SYNOPSIS unitctl [\fI\,FLAGS\/\fR] [\fI\,OPTIONS\/\fR] [\fI\,FILE\/\fR]... .SH DESCRIPTION -- cgit