docs: Set bin_name for subcommands and use full title

PaulYuuu · PaulYuuu · commit 3e0bb1eb2973 · 2024-05-17T12:13:17.000+08:00
`bin_name` will be displayed in the `SYNOPSIS` section, with this, the
generated man pages have correct name and synopsis.

Also, remove `.title("bootc")` to let the subcommands have their own
titles.

Signed-off-by: Yihuang Yu &lt;yihyu@redhat.com&gt;
diff --git a/docs/src/man/bootc-edit.md b/docs/src/man/bootc-edit.md
@@ -4,7 +4,7 @@ bootc-edit - Apply full changes to the host specification
 
 # SYNOPSIS
 
-**bootc-edit** \[**-f**\|**\--filename**\] \[**\--quiet**\]
+**bootc edit** \[**-f**\|**\--filename**\] \[**\--quiet**\]
 \[**-h**\|**\--help**\] \[**-V**\|**\--version**\]
 
 # DESCRIPTION
diff --git a/docs/src/man/bootc-install-print-configuration.md b/docs/src/man/bootc-install-print-configuration.md
@@ -7,7 +7,7 @@ processes using \`install to-filesystem\` that want to honor e.g.
 
 # SYNOPSIS
 
-**bootc-install-print-configuration** \[**-h**\|**\--help**\]
+**bootc install print-configuration** \[**-h**\|**\--help**\]
 \[**-V**\|**\--version**\]
 
 # DESCRIPTION
diff --git a/docs/src/man/bootc-install-to-disk.md b/docs/src/man/bootc-install-to-disk.md
@@ -4,7 +4,7 @@ bootc-install-to-disk - Install to the target block device
 
 # SYNOPSIS
 
-**bootc-install-to-disk** \[**\--wipe**\] \[**\--block-setup**\]
+**bootc install to-disk** \[**\--wipe**\] \[**\--block-setup**\]
 \[**\--filesystem**\] \[**\--root-size**\] \[**\--source-imgref**\]
 \[**\--target-transport**\] \[**\--target-imgref**\]
 \[**\--enforce-container-sigpolicy**\] \[**\--target-ostree-remote**\]
diff --git a/docs/src/man/bootc-install-to-existing-root.md b/docs/src/man/bootc-install-to-existing-root.md
@@ -5,7 +5,7 @@ root filesystem
 
 # SYNOPSIS
 
-**bootc-install-to-existing-root** \[**\--replace**\]
+**bootc install to-existing-root** \[**\--replace**\]
 \[**\--source-imgref**\] \[**\--target-transport**\]
 \[**\--target-imgref**\] \[**\--enforce-container-sigpolicy**\]
 \[**\--target-ostree-remote**\] \[**\--skip-fetch-check**\]
diff --git a/docs/src/man/bootc-install-to-filesystem.md b/docs/src/man/bootc-install-to-filesystem.md
@@ -4,7 +4,7 @@ bootc-install-to-filesystem - Install to the target filesystem
 
 # SYNOPSIS
 
-**bootc-install-to-filesystem** \[**\--root-mount-spec**\]
+**bootc install to-filesystem** \[**\--root-mount-spec**\]
 \[**\--boot-mount-spec**\] \[**\--replace**\]
 \[**\--acknowledge-destructive**\] \[**\--skip-finalize**\]
 \[**\--source-imgref**\] \[**\--target-transport**\]
diff --git a/docs/src/man/bootc-install.md b/docs/src/man/bootc-install.md
@@ -4,7 +4,7 @@ bootc-install - Install the running container to a target
 
 # SYNOPSIS
 
-**bootc-install** \[**-h**\|**\--help**\] \[**-V**\|**\--version**\]
+**bootc install** \[**-h**\|**\--help**\] \[**-V**\|**\--version**\]
 \<*subcommands*\>
 
 # DESCRIPTION
diff --git a/docs/src/man/bootc-rollback.md b/docs/src/man/bootc-rollback.md
@@ -7,7 +7,7 @@ queued upgrade) then it will be discarded
 
 # SYNOPSIS
 
-**bootc-rollback** \[**-h**\|**\--help**\] \[**-V**\|**\--version**\]
+**bootc rollback** \[**-h**\|**\--help**\] \[**-V**\|**\--version**\]
 
 # DESCRIPTION
 
diff --git a/docs/src/man/bootc-status.md b/docs/src/man/bootc-status.md
@@ -4,7 +4,7 @@ bootc-status - Display status
 
 # SYNOPSIS
 
-**bootc-status** \[**\--json**\] \[**\--booted**\]
+**bootc status** \[**\--json**\] \[**\--booted**\]
 \[**-h**\|**\--help**\] \[**-V**\|**\--version**\]
 
 # DESCRIPTION
diff --git a/docs/src/man/bootc-switch.md b/docs/src/man/bootc-switch.md
@@ -4,7 +4,7 @@ bootc-switch - Target a new container image reference to boot
 
 # SYNOPSIS
 
-**bootc-switch** \[**\--quiet**\] \[**\--transport**\]
+**bootc switch** \[**\--quiet**\] \[**\--transport**\]
 \[**\--enforce-container-sigpolicy**\] \[**\--ostree-remote**\]
 \[**\--retain**\] \[**-h**\|**\--help**\] \[**-V**\|**\--version**\]
 \<*TARGET*\>
diff --git a/docs/src/man/bootc-upgrade.md b/docs/src/man/bootc-upgrade.md
@@ -4,7 +4,7 @@ bootc-upgrade - Download and queue an updated container image to apply
 
 # SYNOPSIS
 
-**bootc-upgrade** \[**\--quiet**\] \[**\--check**\] \[**\--apply**\]
+**bootc upgrade** \[**\--quiet**\] \[**\--check**\] \[**\--apply**\]
 \[**-h**\|**\--help**\] \[**-V**\|**\--version**\]
 
 # DESCRIPTION
diff --git a/docs/src/man/bootc-usr-overlay.md b/docs/src/man/bootc-usr-overlay.md
@@ -5,7 +5,7 @@ will be discarded on reboot
 
 # SYNOPSIS
 
-**bootc-usr-overlay** \[**-h**\|**\--help**\] \[**-V**\|**\--version**\]
+**bootc usr-overlay** \[**-h**\|**\--help**\] \[**-V**\|**\--version**\]
 
 # DESCRIPTION
 
diff --git a/lib/src/docgen.rs b/lib/src/docgen.rs
@@ -15,6 +15,8 @@ pub fn generate_manpages(directory: &Utf8Path) -> Result<()> {
 fn generate_one(directory: &Utf8Path, cmd: Command) -> Result<()> {
     let version = env!("CARGO_PKG_VERSION");
     let name = cmd.get_name();
+    let bin_name = cmd.get_bin_name()
+        .unwrap_or_else(|| name);
     let path = directory.join(format!("{name}.8"));
     println!("Generating {path}...");
 
@@ -26,7 +28,6 @@ fn generate_one(directory: &Utf8Path, cmd: Command) -> Result<()> {
         .with_context(|| format!("opening {path}"))
         .map(std::io::BufWriter::new)?;
     clap_mangen::Man::new(cmd.clone())
-        .title("bootc")
         .section("8")
         .source(format!("bootc {version}"))
         .render(&mut out)
@@ -36,10 +37,16 @@ fn generate_one(directory: &Utf8Path, cmd: Command) -> Result<()> {
 
     for subcmd in cmd.get_subcommands().filter(|c| !c.is_hide_set()) {
         let subname = format!("{}-{}", name, subcmd.get_name());
+        let bin_name =  format!("{} {}", bin_name, subcmd.get_name());
         // SAFETY: Latest clap 4 requires names are &'static - this is
         // not long-running production code, so we just leak the names here.
         let subname = &*std::boxed::Box::leak(subname.into_boxed_str());
-        let subcmd = subcmd.clone().name(subname).alias(subname).version(version);
+        let bin_name = &*std::boxed::Box::leak(bin_name.into_boxed_str());
+        let subcmd = subcmd.clone()
+            .name(subname)
+            .alias(subname)
+            .bin_name(bin_name)
+            .version(version);
         generate_one(directory, subcmd.clone().name(subname).version(version))?;
     }
     Ok(())
