kutil 0.0.6

Kutil utilities collection
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48

use {
    clap::*,
    clap_mangen::*,
    std::{io, path::*},
};

//
// Manual
//

/// Clap command to generate manual pages in the troff format.
///
/// Manual pages are usually located in "/usr/share/man/" (for everybody) or "~/.local/share/man/"
/// (for the current user). User commands are under the "man1/" subdirectory.
///
/// To see all supported paths:
///
/// ```
/// man --where
/// ```
///
/// To test:
///
/// ```
/// mkdir --parents ~/.local/share/man/man1/
/// mycommand manual ~/.local/share/man/man1/
/// man mycommand
/// ```
#[derive(Args, Clone, Debug)]
pub struct Manual {
    /// output path
    #[arg(default_value = "/usr/share/man/man1/")]
    pub path: PathBuf,

    /// show this help
    #[arg(long, short = 'h', action = ArgAction::Help)]
    pub help: Option<bool>,
}

impl Manual {
    /// Run command.
    pub fn run<ParserT>(&self) -> io::Result<()>
    where
        ParserT: Parser,
    {
        generate_to(ParserT::command(), &self.path)
    }
}