Changes between Initial Version and Version 1 of TracAdmin


Ignore:
Timestamp:
Feb 24, 2010, 12:11:38 AM (5 years ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • TracAdmin

    v1 v1  
     1= TracAdmin =
     2[[TracGuideToc]]
     3
     4Trac 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.
     5
     6Some 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).
     7
     8== Usage ==
     9
     10You can get a comprehensive list of the available options, commands and sub-commands by invoking `trac-admin` with the `help` command:.
     11{{{
     12trac-admin help
     13}}}
     14
     15Unless 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:
     16{{{
     17trac-admin /path/to/projenv wiki list
     18}}}
     19
     20== Interactive Mode ==
     21
     22When passing the environment path as the only argument, `trac-admin` starts in interactive mode.
     23Commands can then be executed on the selected environment using the prompt, which offers tab-completion
     24(on non-Windows environments, and when the Python `readline` module is available) and automatic repetition of the last command issued.
     25
     26Once you're in interactive mode, you can also get help on specific commands or subsets of commands:
     27
     28For example, to get an explanation of the `resync` command, run:
     29{{{
     30> help resync
     31}}}
     32
     33To get help on all the Wiki-related commands, run:
     34{{{
     35> help wiki
     36}}}
     37
     38== Full Command Reference ==
     39
     40[[TracAdminHelp()]]
     41
     42
     43=== Notes ===
     44
     45The `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.
     46See TracIni#GlobalConfiguration.
     47
     48Note 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 getting an error that reads ''''`Wrong number of arguments to initenv: 4`'''', then this is because you're using a `trac-admin` script from an '''older''' version of Trac.
     49
     50----
     51See also: TracGuide, TracBackup, TracPermissions, TracEnvironment, TracIni, [trac:TracMigrate TracMigrate]