fleshed out missing help system data

This commit is contained in:
Nicholas O'Connor
2017-03-25 09:31:29 -07:00
parent 3dc004d27a
commit 26dc361eec
11 changed files with 40 additions and 8 deletions

View File

@@ -39,7 +39,7 @@ DLL_PUBLIC map<string, CommandFunction> cellar::commands::bottles_commands() {
cog.out("cellar::help::set_details(\"{0}\", R\"(".format(name))
with open("src/bottles/help/" + name) as detailsfile:
for detail in detailsfile:
cog.out(detail)
cog.out(detail, dedent=True, trimblanklines=True)
cog.out(")\");")
else:
print("-- No details are available for the {0} command.".format(name))

View File

@@ -1,4 +1,4 @@
list print_bottles
active print_active_bottle
activate switch_active_bottle
config config_command
list print_bottles List all available WINE bottles.
active print_active_bottle Get the currently active WINE bottle.
activate switch_active_bottle Switch the active WINE bottle.
config config_command Change configuration options.

View File

@@ -0,0 +1,9 @@
cellar activate <bottle>
Marks a given WINE bottle as "active". <bottle> can be one of the following:
- An absolute path, or a relative path (prefixed with "./")
- A simple string, which is assumed to be a suffix for a cellar-managed WINE
bottle. For instance, "cellar activate example" would set the active WINE
bottle to "~/.wine.example".
- As above, with the ".wine." prefix. cellar will accept this, but will throw
warnings about it.

3
src/bottles/help/active Normal file
View File

@@ -0,0 +1,3 @@
cellar active
Prints the name of the active WINE bottle, as specified in cellar.json.

5
src/bottles/help/config Normal file
View File

@@ -0,0 +1,5 @@
cellar config get <key>
cellar config set <key> <value>
The first command prints the contents of <key> from cellar.json in the active
WINE bottle. The second command sets <key> in the same file to <value>.

4
src/bottles/help/list Normal file
View File

@@ -0,0 +1,4 @@
cellar list
Prints a list of all cellar managable WINE bottles in your home directory, and
some basic information about them.