gibuu is hosted by Hepforge, IPPP Durham
GiBUU

# Changes between Version 3 and Version 4 of TracAdmin

Ignore:
Timestamp:
Jul 17, 2018, 3:10:47 PM (15 months ago)
Comment:

--

### Legend:

Unmodified
 v3 = TracAdmin = = TracAdmin [[PageOutline(2-5, Contents, pullout)]] [[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. 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 [trac:WebAdmin] plugin now integrated within Trac (since version 0.11). Some of the configurations can also be performed via the web administration module. == Usage == == Usage For nearly every trac-admin command, 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 For nearly every trac-admin command, the first argument must be the path to the TracEnvironment: {{{#!sh $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'll only get a very succinct list of commands (help and initenv), the same list you'd 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. 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. trac-admin --version will tell you about the Trac version (e.g. 1.2) corresponding to the program. If you want to get a comprehensive list of the available commands and sub-commands, you need to specify an existing environment: {{{ trac-admin /path/to/projenv help To get a comprehensive list of the available command and sub-command, specify the path to an environment: {{{#!sh$ 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 Some commands have more detailed help, which you can access by specifying the command's name as a subcommand for help: {{{#!sh $trac-admin /path/to/projenv help }}} === trac-admin initenv === #initenv When an error occurs in a trac-admin command the return value will be 2 and error messages are printed to stderr. This subcommand is very important as it's the one used to create a TracEnvironment in the specified . That directory must not exist prior to the call. === trac-admin initenv #initenv This subcommand is very important as is the one used to create a TracEnvironment in the specified . 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 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. It supports the --inherit option, which specifies a global configuration file for sharing 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. The advantage of specifying the inherited configuration file at environment creation time is that only the options ''not'' specified in the global configuration file will be written to the environment's conf/trac.ini file. See TracIni#GlobalConfiguration. Note that in version 0.11 of Trac, initenv lost an extra last argument , 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 ' 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. == Interactive Mode == Interactive Mode == trac-admin starts in interactive mode when the environment path is the only argument. Commands can then be executed on the selected environment using the prompt, which offers tab-completion for non-Windows environments, and when the Python readline module is available. It also offers automatic repetition of the last command issued. 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: 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 {{{#!sh$ help resync }}} To get help on all the Wiki-related commands, run: {{{ > help wiki {{{#!sh \$ help wiki }}} == Full Command Reference == == Full Command Reference You'll 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 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. 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 help, as the commands pertaining to components disabled in that environment won't be available and conversely some plugins activated in the environment may add their own commands. [[TracAdminHelp()]] ---- See also: TracGuide, TracBackup, TracPermissions, TracEnvironment, TracIni, [trac:TracMigrate TracMigrate] See also: TracBackup, TracEnvironment, TracIni, [trac:TracMigrate TracMigrate]