re-generate docs

README.md

@@ -39,7 +39,7 @@ $ cargo install registry-backup --git https://git.shipyard.rs/jstrong/registry-b
 ```console
 $ ./target/release/registry-backup --help
 
-registry-backup 0.4.0-rc.2
+registry-backup 0.4.0-rc.3
 Jonathan Strong <jstrong@shipyard.rs>
 Download all .crate files from a registry server
 
@@ -60,22 +60,40 @@ OPTIONS:
             `config.json` file), the token to include using the Authorization HTTP header
 
     -o, --output-path <PATH>
-            Directory where downloaded .crate files will be saved to [default: output]
+            Directory where downloaded .crate files will be saved to
+            
+            [default: output]
 
         --overwrite-existing
             Download files when if .crate file already exists in output dir for a given crate
             version, and overwrite the existing file with the new one. Default behavior is to skip
             downloading if .crate file already exists
 
+        --output-format <FORMAT>
+            What format to use for the output filenames. Works the same as Cargo's registry syntax
+            for the "dl" key in the `config.json` file in a reigstry index. See [Cargo
+            docs](https://doc.rust-lang.org/cargo/reference/registries.html#index-format) for
+            additional details. Not specifying this field is equivalent to specifying
+            "{crate}/{version}/download", the default.
+            
+            The resulting path specified by the format should be relative; it will be joined with
+            the --output-path. (i.e. it should not start with "/".)
+
     -U, --user-agent <USER_AGENT>
-            Value of user-agent HTTP header [default: registry-backup/v0.4.0-rc.2]
+            Value of user-agent HTTP header
+            
+            [default: registry-backup/v0.4.0-rc.3]
 
     -R, --requests-per-second <INT>
-            Requests to registry server will not exceed this rate [default: 100]
+            Requests to registry server will not exceed this rate
+            
+            [default: 100]
 
     -M, --max-concurrent-requests <INT>
             Independent of the requests per second rate limit, no more than
-            `max_concurrent_requests` will be in flight at any given moment [default: 50]
+            `max_concurrent_requests` will be in flight at any given moment
+            
+            [default: 50]
 
     -c, --config-file <PATH>
             Specify configuration values using the provided TOML file, instead of via command line
@@ -174,7 +192,7 @@ The commands that mirror cargo commands (e.g. `just test`) are included for the
 
 This file is generated using a template (`doc/README.tera.md`) rendered using updated outputs of the CLI menu, config sample, and other values.
 
-This version of `README.md` was generated at `Thu, 15 Sep 2022 19:59:56 +0000` based on git commit `7bb27176`.
+This version of `README.md` was generated at `Thu, 15 Sep 2022 20:19:54 +0000` based on git commit `18920486`.
 
 To (re-)generate the `README.md` file, use the justfile command:
 

doc/cli-menu.txt

@@ -1,4 +1,4 @@
-registry-backup 0.4.0-rc.2
+registry-backup 0.4.0-rc.3
 Jonathan Strong <jstrong@shipyard.rs>
 Download all .crate files from a registry server
 
@@ -19,22 +19,40 @@ OPTIONS:
             `config.json` file), the token to include using the Authorization HTTP header
 
     -o, --output-path <PATH>
-            Directory where downloaded .crate files will be saved to [default: output]
+            Directory where downloaded .crate files will be saved to
+            
+            [default: output]
 
         --overwrite-existing
             Download files when if .crate file already exists in output dir for a given crate
             version, and overwrite the existing file with the new one. Default behavior is to skip
             downloading if .crate file already exists
 
+        --output-format <FORMAT>
+            What format to use for the output filenames. Works the same as Cargo's registry syntax
+            for the "dl" key in the `config.json` file in a reigstry index. See [Cargo
+            docs](https://doc.rust-lang.org/cargo/reference/registries.html#index-format) for
+            additional details. Not specifying this field is equivalent to specifying
+            "{crate}/{version}/download", the default.
+            
+            The resulting path specified by the format should be relative; it will be joined with
+            the --output-path. (i.e. it should not start with "/".)
+
     -U, --user-agent <USER_AGENT>
-            Value of user-agent HTTP header [default: registry-backup/v0.4.0-rc.2]
+            Value of user-agent HTTP header
+            
+            [default: registry-backup/v0.4.0-rc.3]
 
     -R, --requests-per-second <INT>
-            Requests to registry server will not exceed this rate [default: 100]
+            Requests to registry server will not exceed this rate
+            
+            [default: 100]
 
     -M, --max-concurrent-requests <INT>
             Independent of the requests per second rate limit, no more than
-            `max_concurrent_requests` will be in flight at any given moment [default: 50]
+            `max_concurrent_requests` will be in flight at any given moment
+            
+            [default: 50]
 
     -c, --config-file <PATH>
             Specify configuration values using the provided TOML file, instead of via command line