aboutsummaryrefslogtreecommitdiff
path: root/raw-wiki-dump/TracAdmin.md
diff options
context:
space:
mode:
Diffstat (limited to 'raw-wiki-dump/TracAdmin.md')
-rw-r--r--raw-wiki-dump/TracAdmin.md66
1 files changed, 66 insertions, 0 deletions
diff --git a/raw-wiki-dump/TracAdmin.md b/raw-wiki-dump/TracAdmin.md
new file mode 100644
index 0000000..8274773
--- /dev/null
+++ b/raw-wiki-dump/TracAdmin.md
@@ -0,0 +1,66 @@
+# TracAdmin
+
+[[PageOutline(2-5, Contents, floated)]]
+[[TracGuideToc]]
+
+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 configurations can also be performed via the web administration module.
+
+## Usage
+
+For nearly every `trac-admin` command, you will need to specify the path to the TracEnvironment that you want to administer as the first argument:
+```
+trac-admin /path/to/projenv wiki list
+```
+
+The only exception is for the `help` command, but even in this case if you omit the environment, you will only get a very succinct list of commands (`help` and `initenv`), the same list you would get when invoking `trac-admin` alone.
+Also, `trac-admin --version` will tell you about the Trac version (e.g. 0.12) corresponding to the program.
+
+To get a comprehensive list of the available commands and sub-commands, specify an existing environment:
+```
+trac-admin /path/to/projenv help
+```
+
+Some commands have a more detailed help, which you can access by specifying the command's name as a subcommand for `help`:
+```
+trac-admin /path/to/projenv help <command>
+```
+
+### `trac-admin <targetdir> initenv` === #initenv
+
+This subcommand is very important as is the one used to create a TracEnvironment in the specified `<targetdir>`. That directory must not exist prior to the call.
+
+[[TracAdminHelp(initenv)]]
+
+It supports an extra `--inherit` option, which can be used to specify a global configuration file which can be used to share settings between several environments. You can also inherit from a shared configuration afterwards, by setting the `[inherit] file` option in the `conf/trac.ini` file in your newly created environment, but the advantage of specifying the inherited configuration file at environment creation time is that only the options *not* already specified in the global configuration file will be written in the created environment's `conf/trac.ini` file.
+See TracIni#GlobalConfiguration.
+
+Note that in version 0.11 of Trac, `initenv` lost an extra last argument `<templatepath>`, which was used in previous versions to point to the `templates` folder. If you are using the one-liner `trac-admin /path/to/trac/ initenv <projectname> <db> <repostype> <repospath>` in the above and get an error that reads `Wrong number of arguments to initenv: 4`, then this is because you are using a `trac-admin` script from an **older** version of Trac.
+
+## 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 are 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
+
+You will find below the detailed help for all the commands available by default in `trac-admin`. Note that this may not match the list given by `trac-admin <yourenv> help`, as the commands pertaining to components disabled in that environment won't be available and conversely some plugins activated in the environment can add their own commands.
+
+[[TracAdminHelp()]]
+
+----
+See also: TracGuide, TracBackup, TracPermissions, TracEnvironment, TracIni, [trac:TracMigrate TracMigrate]