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

Question

我正在使用 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 files\nUsage: cmp [ -l | -s ] file1 file2\n" << 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.

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

更新为了大家的利益，我为此提交了feature request，希望以向后兼容的方式。

Answer 1

这并不理想，但是如何创建一个“虚拟”程序选项集，让 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 岁现在。）