是否有办法让拍手对待 - ?和-h一样吗?

时间:2017-12-11 05:21:16

标签: rust command-line-interface rust-crates clap

clap crate为-h选项实现了内置行为,但-?似乎没有做同样的事情。有没有办法告诉它这样做?

3 个答案:

答案 0 :(得分:0)

从Clap 2.29.0开始,没有为同一选项添加多个短名称的内置方法。

App::help_short允许您覆盖默认的-h选项以获取帮助,但该函数接受字符串it only cares about the first character (after stripping leading dashes)Arg::short the same。{/ p>

您可以将-?选项定义为单独选项,并通过调用App::print_help自行处理。这样可以在帮助文本中单独显示-?,但您可以选择hide

答案 1 :(得分:0)

试图将此作为评论,但不适合。

至少在类Unix系统上,你将遇到的另一个问题是大多数shell为'?'赋予特殊含义。我有一个Rust程序,只打印出它在命令行中找到的参数。

> $ cargo run one two three
    Finished dev [unoptimized + debuginfo] target(s) in 0.0 secs
     Running `target/debug/cmdl one two three`
["target/debug/cmdl", "one", "two", "three"]
args len: 4
arg: target/debug/cmdl
arg: one
arg: two
arg: three

当我通过-?时:

> $ cargo run -?
zsh: no matches found: -?

如果我引用它并将-?放在其前面,我可以传递--

> $ cargo run -- "-?"
    Finished dev [unoptimized + debuginfo] target(s) in 0.0 secs
     Running `target/debug/cmdl '-?'`
["target/debug/cmdl", "-?"]
args len: 2
arg: target/debug/cmdl
arg: -?

对于寻求帮助的人来说,似乎有点期待,但也许在OP的平台上更友好。我正在使用Mac OS X.

<强>更新

类Unix系统上的大多数基于Bourne的shell都能解释?作为用于匹配文件名中单个字符的通配符通配符。我不知道鱼,但我已经检查了下面的/ bin / sh,/ bin / ksh,/ bin / bash和/ bin / zsh。

如果使用 - ?作为这些shell的命令行选项,并且工作目录中有一个由连字符后跟单个字符组成的文件名,程序将看到文件名而不是“ - ?”因为shell会在命令行进入你的程序之前进行替换。

有些贝壳(特别是zsh)会绊倒 - ?甚至在检查文件之前,如我原来的消息中所述。

如下图所示,如果 - ?用引号括起来,外壳不会弄乱,但这不是我希望大多数人知道的东西。我甚至不相信自己要记住,当我想找到一个我不熟悉的程序的帮助页面时。

$ /bin/sh
$ ls
-a      -bb     -ccc    a       bb      ccc
$ echo -?
-a
$ echo ?
a
$ echo ??
-a bb
$ echo "-?"
-?

$ /bin/ksh
$ ls
-a      -bb     -ccc    a       bb      ccc
$ echo ?
a
$ echo -?
-a
$ echo ??
-a bb
$ echo "-?"
-?

$ /bin/bash
$ ls
-a      -bb     -ccc    a       bb      ccc
$ echo ?
a
$ echo -?
-a
$ echo ??
-a bb
$ echo "-?"
-?

$ /bin/zsh
$ ls
-a   -bb  -ccc a    bb   ccc
$ echo ?
a
$ echo -?
-a
$ echo ??
-a bb
$ echo "-?"
-?

答案 2 :(得分:0)

我在clap repository打开了一个问题。作者/主要撰稿人已在那里回答。这是代码的副本,它回答了问题:

extern crate clap;

use std::env;
use std::process;

use clap::{App, Arg};

fn main() {
    // We build the App instance and save it, so we can
    // use it later if needed
    let mut app = App::new("prog").arg(
        Arg::with_name("help")
            .short("?")
            .help("Also prints the help message"),
    );

    // We call this method which will do all the
    //parsing, but not consume our App instance
    let res = app.get_matches_from_safe_borrow(env::args_os());

    // This calls all the normal clap error messages
    // if one should exist
    let matches = res.unwrap_or_else(|e| e.exit());

    // Now we check for ?
    if matches.is_present("help") {
        let _ = app.print_help();
        println!(""); // adds a newline
        process::exit(0);
    }

    // Now we can use matches like normal...
}