如何在——help输出中显示命令行操作数描述

How to display commandline operand description in --help output

本文关键字：命令行 显示 操作数 描述 输出 help      更新时间：2023-10-16

我正在使用Boost。program_options解析POSIX实用程序实现的命令行。以cmp为例，

现在我想有一个额外的参数--help，它显示了所有参数的描述，这在这种情况下很重要。我:

po::options_description options("Options");
options.add_options()("help", "Show this help output.")
                     (",l", "(Lowercase ell.) Write the byte number (decimal) and the differing bytes (octal) for each difference.")
                     (",s", "Write nothing for differing files; return exit status only.")
po::positional_options_description operands;
operands.add("file1", 1);//, "A pathname of the first file to be compared. If file1 is '-', the standard input shall be used.")
operands.add("file2", 1);//, "A pathname of the second file to be compared. If file2 is '-', the standard input shall be used.");
po::variables_map vm;
po::store(po::command_line_parser(argc, argv).options(options).positional(operands).run(), vm);
po::notify(vm);
if(vm.count("help"))
{
  std::cout << "cmp: compare two filesnUsage: cmp [ -l | -s ] file1 file2n" << options;
  return 0;
}

无法显示file1和file2选项的描述。我当然可以将它们添加到options，但这会添加至少两个不想要的参数[-]-file{1,2}，这是我真的不想要的。我只想要--help的输出(没有明显的硬编码):

cmp: compare two files
Usage: cmp [ -l | -s ] file1 file2
Options:
  --help                Show this help output.
  -l                    (Lowercase ell.) Write the byte number (decimal) and the differing bytes (octal) for each difference.
  -s                    Write nothing for differing files; return exit status only.
Operands:
  file1                 A pathname of the first file to be compared. If file1 is '-', the standard input shall be used.
  file2                 A pathname of the second file to be compared. If file2 is '-', the standard input shall be used.

有没有什么方法可以在不破坏图书馆的情况下实现这一点?我认为这是非常基本的东西，但我在任何教程中都找不到。

UPDATE为了大家的利益，我提交了一个功能请求，希望以向后兼容的方式。

这并不理想，但是创建一个"虚拟"程序选项集，让boost::program_options格式化器为您格式化其帮助文本，然后通过快速替换删除虚线怎么样?

然后输出options帮助文本之外的帮助文本。

像这样:

po::options_description dummy_options("Operands");
dummy_options.add_options()
    ("file1", po::value<std::string>(), "A pathname of the first file to be compared. If file1 is '-', the standard input shall be used.")
    ("file2", po::value<std::string>(), "A pathname of the second file to be compared. If file2 is '-', the standard input shall be used.")
    ;
std::stringstream s;
s << dummy_options;
std::string dummy_help_text = s.str();
boost::replace_all(dummy_help_text, "--", "");
boost::replace_all(dummy_help_text, "arg", "     ");
std::cout << dummy_help_text << std::endl;

输出如下所示:

Operands:
  file1                 A pathname of the first file to be compared. If file1
                        is '-', the standard input shall be used.
  file2                 A pathname of the second file to be compared. If file2
                        is '-', the standard input shall be used.

这是不理想的，因为，除其他事项外，列之间的间距将不匹配其他options输出的帮助输出。但对于一些又快又脏的东西，这基本上是可行的。

无论如何，这是一个想法。

(我在Boost中没有看到任何东西。Program_Options API，它允许您以"正确"的方式执行此操作。https://stackoverflow.com/a/3621947/368896给出了一个提示，这类事情是不支持的，但这是3年前的事了。

相关文章：