ScriptX [v0.4.3]

- Close #24 - Reworded cut to extract in the deb `control` file and other places.
- Instead of modifying a static man file, `make-deb` generates and compresses the man file. The man file created isn't perfect but it's better than having the man page to by out of sync with development. **NOTE:** With [Clap 3](clap-rs/clap#552) man pages generation should be possible.:w
- Replaced clap's description string with the `crate_description` macro. The `--help` application description will be the same as the one in `Cargo.toml`.
- Tweaked the wording in the `-v` option help string.

CHANGELOG.md

@@ -1,5 +1,15 @@
 # Changelog
 
+## ScriptX [v0.4.3](https://github.com/JoelMon/scriptx/releases/tag/v0.4.3) (2021-7-05)
+
+## Fix
+- Close #24 - Reworded cut to extract in the deb `control` file and other places.
+
+## Other
+- Instead of modifying a static man file, `make-deb` generates and compresses the man file. The man file created isn't perfect but it's better than having the man page to by out of sync with development. **NOTE:** With [Clap 3](https://github.com/clap-rs/clap/issues/552) man pages generation should be possible.:w
+- Replaced clap's description string with the `crate_description` macro. The `--help` application description will be the same as the one in `Cargo.toml`.
+- Tweaked the wording in the `-v` option help string.
+
 ## ScriptX [v0.4.2](https://github.com/JoelMon/scriptx/releases/tag/v0.4.2) (2021-7-04)
 ## New Feature
 - Close #21 - Added a progress bar to when using the `-a --all` flag.

Cargo.toml

@@ -1,11 +1,11 @@
 [package]
 name = "scriptx"
-version = "0.4.2"
+version = "0.4.3"
 authors = ["Joel Montes de Oca"]
 homepage = "https://joelmon.github.io/scriptx/"
 documentation = "https://github.com/JoelMon/scriptx/"
 edition = "2018"
-description = "ScriptX is a command line tool to cut scriptures out of the American Sign Language version of the New World Translation."
+description = "ScriptX is a command line tool to extract scriptures out of the American Sign Language version of the New World Translation."
 repository = "https://github.com/JoelMon/scriptx"
 readme = "README.md"
 license = "MIT"

deb/control

@@ -7,6 +7,6 @@ Priority: optional
 Urgency: low
 Depends: ffmpeg
 Maintainer: Joel Montes de Oca
-Description: ScriptX is a command line tool to cut scriptures out of the American Sign Language version of the New World Translation.
+Description: ScriptX is a command line tool to extract scriptures out of the American Sign Language version of the New World Translation.
 Homepage: https://joelmon.github.io/scriptx/
 

make-deb

@@ -15,9 +15,8 @@ mkdir -p $man_dir
 # Build binary and copy to bin_dir if pass
 cargo build --release && cp target/release/scriptx $bin_dir/scriptx
 
-# Copy and edit man file
-cp man/scriptx.1.man $man_dir/scriptx.1
-sed -i "s/ScriptX *.*.*/ScriptX $version/" $man_dir/scriptx.1
+# Generate and compress the man page, help2man has to be installed
+help2man -N -S Linux target/release/scriptx | gzip > $man_dir/scriptx.1.gz
 
 # copy and edit control file
 cp deb/control $debian_dir/control

src/main.rs

@@ -8,7 +8,7 @@ use indicatif::ProgressIterator;
 use std::process::Command;
 use std::u8;
 
-use clap::{crate_authors, crate_version, App, Arg, ArgGroup, ArgMatches};
+use clap::{crate_authors, crate_description, crate_version, App, Arg, ArgGroup, ArgMatches};
 
 use crate::ffwrappers::mpeg;
 use crate::ffwrappers::probe::Root;
@@ -18,11 +18,11 @@ use scriptx_errors::ScriptxErrors;
 fn main() -> Result<(), ScriptxErrors> {
     let m:ArgMatches = App::new("ScriptX")
         .author(crate_authors!())
-        .about("ScriptX cuts scriptures from the American Sign Language version of the New World Translation Bible.")
+        .about(crate_description!())
         .version(crate_version!())
         .arg(
             Arg::with_name("verse")
-                .help("The verse to be cut out. A single verse or a range of verses can be cut, eg. 2-5.")
+                .help("The verse to be extracted out. A single verse or a range of verses can be extracted. e.g. 2-5")
                 .short("v")
                 .long("verse")
                 .takes_value(true),