forked from lix-project/lix
Add 'nix help' manpage
This commit is contained in:
parent
e6bea9c9b1
commit
daf365b0b7
17
src/nix/help.md
Normal file
17
src/nix/help.md
Normal file
|
@ -0,0 +1,17 @@
|
||||||
|
R""(
|
||||||
|
|
||||||
|
# Examples
|
||||||
|
|
||||||
|
* Show help about `nix` in general:
|
||||||
|
|
||||||
|
```console
|
||||||
|
# nix help
|
||||||
|
```
|
||||||
|
|
||||||
|
* Show help about a particular subcommand:
|
||||||
|
|
||||||
|
```console
|
||||||
|
# nix help flake info
|
||||||
|
```
|
||||||
|
|
||||||
|
)""
|
|
@ -205,21 +205,14 @@ struct CmdHelp : Command
|
||||||
|
|
||||||
std::string description() override
|
std::string description() override
|
||||||
{
|
{
|
||||||
return "show help about 'nix' or a particular subcommand";
|
return "show help about `nix` or a particular subcommand";
|
||||||
}
|
}
|
||||||
|
|
||||||
Examples examples() override
|
std::string doc() override
|
||||||
{
|
{
|
||||||
return {
|
return
|
||||||
Example{
|
#include "help.md"
|
||||||
"To show help about 'nix' in general:",
|
;
|
||||||
"nix help"
|
|
||||||
},
|
|
||||||
Example{
|
|
||||||
"To show help about a particular subcommand:",
|
|
||||||
"nix help run"
|
|
||||||
},
|
|
||||||
};
|
|
||||||
}
|
}
|
||||||
|
|
||||||
void run() override
|
void run() override
|
||||||
|
|
Loading…
Reference in a new issue