help.hpp
Go to the documentation of this file.
1 /* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
26 #ifndef NFD_TOOLS_NFDC_HELP_HPP
27 #define NFD_TOOLS_NFDC_HELP_HPP
28 
29 #include "command-parser.hpp"
30 
31 namespace nfd {
32 namespace tools {
33 namespace nfdc {
34 
35 void
36 helpList(std::ostream& os, const CommandParser& parser,
37  ParseMode mode = ParseMode::ONE_SHOT, const std::string& noun = "");
38 
41 void
42 help(ExecuteContext& ctx, const CommandParser& parser);
43 
46 void
47 registerHelpCommand(CommandParser& parser);
48 
49 } // namespace nfdc
50 } // namespace tools
51 } // namespace nfd
52 
53 #endif // NFD_TOOLS_NFDC_HELP_HPP
nfd::tools::nfdc::help
void help(ExecuteContext &ctx, const CommandParser &parser)
the 'help' command
Definition: help.cpp:76
nfd
Copyright (c) 2014-2015, Regents of the University of California, Arizona Board of Regents...
Definition: algorithm.hpp:32
nfd::tools::nfdc::registerHelpCommand
void registerHelpCommand(CommandParser &parser)
registers 'help' command
Definition: help.cpp:91
nfd::tools::nfdc::ParseMode
ParseMode
indicates which mode is the parser operated in
Definition: command-parser.hpp:52
nfd::tools::nfdc::helpList
void helpList(std::ostream &os, const CommandParser &parser, ParseMode mode, const std::string &noun)
Definition: help.cpp:40