Changes between Version 1 and Version 2 of Trac Admin

Timestamp:

Jul 4, 2008, 2:09:42 PM (16 years ago)

Author:

trac

Comment:

--

Trac Admin

@@ -1 +1 @@
 = TracAdmin =
+[[TracGuideToc]]
 
-Trac is distributed with a powerful configuration tool. This tool can be used 
-to configure and customize your Trac-installation to better fit your needs.
+Trac is distributed with a powerful command-line configuration tool. This tool can be used  to configure and customize your Trac-installation to better fit your needs.
+
+Some of those operations can also be performed via the ''Admin'' web interface, an updated version of the [http://trac.edgewall.org/wiki/WebAdmin WebAdmin] plugin now integrated within Trac (since version 0.11).
 
 == Usage ==
 
+You can get a comprehensive list of the available options, commands and sub-commands by invoking `trac-admin` with the `help` command:.
 {{{
-Usage: trac-admin <dbfile> [command [subcommand] [option ...]]
-
-Invoking trac-admin without command starts interactive mode.
-
-about                               -- Shows information about trac-admin
-help                                -- Show documentation
-initdb                              -- Create and initializes a new database
-config list                         -- Show current configuration
-config set <option> <value>         -- Set config
-wiki list                           -- List wiki pages
-wiki export <page> [file]           -- Export wiki page to file or stdout
-wiki import <page> [file]           -- Import wiki page from file or stdin
-wiki dump <directory>               -- Export all wiki pages to files named by title
-permission list                     -- List permission rules
-permission add <user> <action>      -- Add a new permission rule
-permission remove <user> <action>   -- Remove permission rule
-component list                      -- Show available components
-component add <name> <owner>        -- Add a new component
-component rename <name> <newname>   -- Rename a component
-component remove <name>             -- Remove/uninstall component
-component chown <name> <owner>      -- Change component ownership
-priority list                       -- Show possible ticket priorities
-priority add <value>                -- Add a priority value option
-priority change <value> <newvalue>  -- Change a priority value
-priority remove <value>             -- Remove priority value
-severity list                       -- Show possible ticket priorities
-severity add <value>                -- Add a severity value option
-severity change <value> <newvalue>  -- Change a severity value
-severity remove <value>             -- Remove severity value
-version list                        -- Show versions
-version add <name> [time]           -- Add version
-version rename <name> <newname>     -- Rename version
-version time <name> <time>          -- Set version date/time
-version remove <name>               -- Remove version
-milestone list                      -- Show milestones
-milestone add <name> [time]         -- Add milestone
-milestone rename <name> <newname>   -- Rename milestone
-milestone time <name> <time>        -- Set milestone date/time
-milestone remove <name>             -- Remove milestone
+trac-admin help
 }}}
 
-== Interactive mode ==
+Unless you're executing the `help`, `about` or `version` sub-commands, you'll need to specify the path to the TracEnvironment that you want to administer as the first argument, for example:
+{{{
+trac-admin /path/to/projenv wiki list
+}}}
 
-'''trac-admin''' starts in an interactive mode when started with the database 
-filename as the only argument. Commands can then be executed on the selected 
-database using the tab-completing prompt.
+== Interactive Mode ==
+
+When passing the environment path as the only argument, `trac-admin` starts in interactive mode.
+Commands can then be executed on the selected environment using the prompt, which offers tab-completion
+(on non-Windows environments, and when the Python `readline` module is available) and automatic repetition of the last command issued.
+
+Once you're in interactive mode, you can also get help on specific commands or subsets of commands:
+
+For example, to get an explanation of the `resync` command, run:
+{{{
+> help resync
+}}}
+
+To get help on all the Wiki-related commands, run:
+{{{
+> help wiki
+}}}
+
+== Full Command Reference ==
+
+[[TracAdminHelp()]]
+
+=== Notes ===
+
+The `initenv` also supports an extra `--inherit` option, which can be used to specify the `[inherit] file` option at environment creation time so that only the options ''not'' already specified in the global configuration file will be written in the conf/trac.ini file of the newly created environment.
+See TracIni#GlobalConfiguration.
+----
+See also: TracGuide, TracBackup, TracPermissions, TracEnvironment, TracIni, TracMigrate