Using mangen with a different binary name

[pepa65]

In my Cargo.toml I have a different binary name specified under [[bin]], but mangen only uses the package name everywhere, which is fine, except for the command line... Under the SYNOPSIS I would like to have the actual name of the generated binary, otherwise the manpage is incorrect.

[epage]

For SYNOPSIS, we are using the bin name as told to clap, see

clap/clap_mangen/src/render.rs

Line 33 in d2874a5

let name = cmd.get_bin_name().unwrap_or_else(|| cmd.get_name());

So you could override that to be what you want.

#5738 would have us switch the derive from the default name being the package name to being the binary name.

[pepa65]

Unsure of where to set this. In my build.rs there is a line cmd.set_bin_name("qr"); which doesn't affect the Man rendering.

[epage]

Unsure as it seems to work for me

#!/usr/bin/env nargo
---
[dependencies]
clap = { version = "4", features = ["derive"] }
clap_mangen = "0.2"
---

use clap::Parser;

#[derive(Parser, Debug)]
struct Cli {
}

fn main() {
    use clap::CommandFactory as _;

    let mut cmd = Cli::command();
    cmd.set_bin_name("something-bizarre");

    let man = clap_mangen::Man::new(cmd);
    let mut buffer: Vec<u8> = Default::default();
    man.render(&mut buffer).unwrap();

    let buffer = String::from_utf8_lossy(&buffer);
    println!("{buffer}");
}

$ ./clap-5767.rs
warning: `package.edition` is unspecified, defaulting to `2021`
   Compiling clap-5767 v0.0.0 (/home/epage/src/personal/dump)
    Finished `dev` profile [unoptimized + debuginfo] target(s) in 0.32s
     Running `/home/epage/.cargo/target/c2/6111c09365ea43/debug/clap-5767`
.ie \n(.g .ds Aq \(aq
.el .ds Aq '
.TH clap-5767 1  "clap-5767 "
.SH NAME
clap\-5767
.SH SYNOPSIS
\fBsomething\-bizarre\fR [\fB\-h\fR|\fB\-\-help\fR]
.SH DESCRIPTION
.SH OPTIONS
.TP
\fB\-h\fR, \fB\-\-help\fR
Print help

[pepa65]

Thanks for your confirmation, somehow can't get it to work. Using clap v3.2.12, so that shouldn't be the problem, right?

[epage]

Yes as we didn't use bin name back in those releases of clap_mangen

[pepa65]

OK, I'll leave my work-around in place, and hope to use more up-to-date clap in the future. Sorry, I should have reported my versions in the first place (I thought they would be most recent, but a version was set...).