fleshed out missing help system data
This commit is contained in:
		@@ -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))
 | 
			
		||||
 
 | 
			
		||||
@@ -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.
 | 
			
		||||
 
 | 
			
		||||
							
								
								
									
										9
									
								
								src/bottles/help/activate
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										9
									
								
								src/bottles/help/activate
									
									
									
									
									
										Normal 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
									
								
							
							
						
						
									
										3
									
								
								src/bottles/help/active
									
									
									
									
									
										Normal 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
									
								
							
							
						
						
									
										5
									
								
								src/bottles/help/config
									
									
									
									
									
										Normal 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
									
								
							
							
						
						
									
										4
									
								
								src/bottles/help/list
									
									
									
									
									
										Normal 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.
 | 
			
		||||
@@ -49,7 +49,7 @@ map<string, CommandFunction> cellar::commands::core_commands() {
 | 
			
		||||
                    cog.out("cellar::help::set_details(\"{0}\", R\"(".format(name))
 | 
			
		||||
                    with open("src/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))
 | 
			
		||||
 
 | 
			
		||||
@@ -1,2 +1,2 @@
 | 
			
		||||
version print_version Prints version information.
 | 
			
		||||
help help_command
 | 
			
		||||
help help_command Hello, there!
 | 
			
		||||
 
 | 
			
		||||
							
								
								
									
										3
									
								
								src/help/help
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										3
									
								
								src/help/help
									
									
									
									
									
										Normal file
									
								
							@@ -0,0 +1,3 @@
 | 
			
		||||
cellar help [<command>]
 | 
			
		||||
 | 
			
		||||
Prints a list of commands and their descriptions, or specify <command> for details about a specific command.
 | 
			
		||||
@@ -39,7 +39,7 @@ DLL_PUBLIC map<string, CommandFunction> cellar::commands::launch_commands() {
 | 
			
		||||
                    cog.out("cellar::help::set_details(\"{0}\", R\"(".format(name))
 | 
			
		||||
                    with open("src/launch/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))
 | 
			
		||||
 
 | 
			
		||||
							
								
								
									
										8
									
								
								src/launch/help/launch
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										8
									
								
								src/launch/help/launch
									
									
									
									
									
										Normal file
									
								
							@@ -0,0 +1,8 @@
 | 
			
		||||
cellar launch <args> ...
 | 
			
		||||
 | 
			
		||||
Launch WINE with the specified arguments (including, but not limited to, the
 | 
			
		||||
Windows program of your choice).
 | 
			
		||||
 | 
			
		||||
"cellar launch" will automatically modify your system's environment variables
 | 
			
		||||
and WINE arguments as defined in the bottle's configuration file (cellar.json).
 | 
			
		||||
No changes are made by default.
 | 
			
		||||
		Reference in New Issue
	
	Block a user