From 9a57ade27e64f3aabd15b7b9b05b7fcf7f4e819e Mon Sep 17 00:00:00 2001 From: Bryan Newbold Date: Sat, 13 Jun 2020 20:33:51 -0700 Subject: infrastructure for CLI .deb and manpage --- rust/Makefile | 8 ++++++++ rust/fatcat-cli/Cargo.toml | 14 +++++++++++++- rust/fatcat-cli/README.md | 2 ++ rust/fatcat-cli/fatcat-cli.1 | 25 +++++++++++++++++++++++++ rust/fatcat-cli/fatcat-cli.1.scdoc | 17 +++++++++++++++++ 5 files changed, 65 insertions(+), 1 deletion(-) create mode 100644 rust/fatcat-cli/README.md create mode 100644 rust/fatcat-cli/fatcat-cli.1 create mode 100644 rust/fatcat-cli/fatcat-cli.1.scdoc (limited to 'rust') diff --git a/rust/Makefile b/rust/Makefile index e0940e3..8e2bc4b 100644 --- a/rust/Makefile +++ b/rust/Makefile @@ -20,3 +20,11 @@ fmt: ## Run syntax re-formatting .PHONY: build build: ## Build cargo build + +.PHONY: manpage +manpage: ## Rebuild manpage using scdoc + scdoc < fatcat-cli/fatcat-cli.1.scdoc > fatcat-cli/fatcat-cli.1 + +.PHONY: deb +deb: ## Build debian packages (.deb files) + cargo deb -p fatcat-cli diff --git a/rust/fatcat-cli/Cargo.toml b/rust/fatcat-cli/Cargo.toml index 09dd492..d258d74 100644 --- a/rust/fatcat-cli/Cargo.toml +++ b/rust/fatcat-cli/Cargo.toml @@ -4,8 +4,9 @@ version = "0.3.0-dev" edition = "2018" authors = ["Bryan Newbold "] license = "AGPL-3+" +#license-file = "../../LICENSE.AGPLv3.txt" description = "CLI tool for fatcat.wiki, an open digital catalog of research papers" -readme = "README_cli.md" +readme = "fatcat-cli/README.md" homepage = "https://fatcat.wiki" repository = "https://github.com/internetarchive/fatcat" keywords = ["cli", "fatcat", "digital-library"] @@ -39,3 +40,14 @@ tempfile = "3" [dev-dependencies] assert_cmd = "1" + + +[package.metadata.deb] +maintainer = "Bryan Newbold " +depends = "$auto" +section = "utility" +priority = "optional" +assets = [ + ["target/release/fatcat-cli", "usr/bin/", "755"], + ["fatcat-cli.1", "usr/share/man/man1/", "644"], +] diff --git a/rust/fatcat-cli/README.md b/rust/fatcat-cli/README.md new file mode 100644 index 0000000..1652d61 --- /dev/null +++ b/rust/fatcat-cli/README.md @@ -0,0 +1,2 @@ + +`fatcat-cli` README. diff --git a/rust/fatcat-cli/fatcat-cli.1 b/rust/fatcat-cli/fatcat-cli.1 new file mode 100644 index 0000000..7223deb --- /dev/null +++ b/rust/fatcat-cli/fatcat-cli.1 @@ -0,0 +1,25 @@ +.\" Generated by scdoc 1.9.0 +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.nh +.ad l +.\" Begin generated content: +.TH "fatcat-cli" "1" "2020-06-14" "fatcat.wiki CLI Manual Page" +.P +.SH NAME +.P +fatcat-cli - something something +.P +.SH SYNOPSIS +.P +.SH DESCRIPTION +.P +.SH OPTIONS +.P +.SH EXAMPLES +.P +Some examples of usage will go here, like: +.P +.RS 4 +fatcat-cli get thing +.RE diff --git a/rust/fatcat-cli/fatcat-cli.1.scdoc b/rust/fatcat-cli/fatcat-cli.1.scdoc new file mode 100644 index 0000000..32a155d --- /dev/null +++ b/rust/fatcat-cli/fatcat-cli.1.scdoc @@ -0,0 +1,17 @@ +fatcat-cli(1) "fatcat.wiki CLI Manual Page" + +# NAME + +fatcat-cli - something something + +# SYNOPSIS + +# DESCRIPTION + +# OPTIONS + +# EXAMPLES + +Some examples of usage will go here, like: + + fatcat-cli get thing -- cgit v1.2.3