Line data Source code
1 : /**
2 : * @file
3 : *
4 : * @brief
5 : *
6 : * @copyright BSD License (see LICENSE.md or https://www.libelektra.org)
7 : */
8 :
9 : #ifndef INFO_HPP
10 : #define INFO_HPP
11 :
12 : #include "coloredkdbio.hpp"
13 : #include <command.hpp>
14 :
15 : #include <kdb.hpp>
16 :
17 : class InfoCommand : public Command
18 : {
19 : public:
20 : InfoCommand ();
21 : ~InfoCommand ();
22 :
23 429 : virtual std::string getShortOptions () override
24 : {
25 1287 : return "lc";
26 : }
27 :
28 429 : virtual std::string getSynopsis () override
29 : {
30 1287 : return "<plugin name> [<clause name>]";
31 : }
32 :
33 507 : virtual std::string getShortHelpText () override
34 : {
35 1521 : return "Print information about a plugin.";
36 : }
37 :
38 429 : virtual std::string getLongHelpText () override
39 : {
40 : return "Print out the information of a specific plugin's contract.\n"
41 : "\n"
42 : "E.g.\n"
43 : "Print out all information about dump plugin:\n"
44 : " kdb info dump\n"
45 : "\n"
46 : "Print out the licence of the resolver plugin:\n"
47 1287 : " kdb info resolver licence\n";
48 : }
49 :
50 : virtual int execute (Cmdline const & cmdline) override;
51 : };
52 :
53 : #endif
|