Edgewall Software

Changes between Version 58 and Version 59 of TracAdmin


Ignore:
Timestamp:
Mar 18, 2017, 4:30:58 PM (3 years ago)
Author:
Ryan J Ollos
Comment:

Minor edits.

Legend:

Unmodified
Added
Removed
Modified
  • TracAdmin

    v58 v59  
    11= TracAdmin
    22
    3 [[PageOutline(2-5, Contents, floated)]]
     3[[PageOutline(2-5, Contents, pullout)]]
    44[[TracGuideToc]]
    55[[TranslatedPages]]
    66
    7 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.
     7Trac 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.
    88
    9 Some of those configurations can also be performed via the web administration module.
     9Some of the configurations can also be performed via the web administration module.
    1010
    1111== Usage
    1212
    13 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:
    14 {{{
    15 trac-admin /path/to/projenv wiki list
     13For nearly every `trac-admin` command, the first argument must be the path to the TracEnvironment:
     14{{{#!sh
     15$ trac-admin /path/to/projenv wiki list
    1616}}}
    1717
    18 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.
    19 Also, `trac-admin --version` will tell you about the Trac version (e.g. 0.12) corresponding to the program.
     18The 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.
     19`trac-admin --version` will tell you about the Trac version (e.g. 1.2) corresponding to the program.
    2020
    21 To get a comprehensive list of the available commands and sub-commands, specify an existing environment:
    22 {{{
    23 trac-admin /path/to/projenv help
     21To get a comprehensive list of the available command and sub-command, specify the path to an environment:
     22{{{#!sh
     23$ trac-admin /path/to/projenv help
    2424}}}
    2525
    26 Some commands have a more detailed help, which you can access by specifying the command's name as a subcommand for `help`:
    27 {{{
    28 trac-admin /path/to/projenv help <command>
     26Some commands have more detailed help, which you can access by specifying the command's name as a subcommand for `help`:
     27{{{#!sh
     28$ trac-admin /path/to/projenv help <command>
    2929}}}
    3030
    3131When an error occurs in a `trac-admin` command the return value will be `2` and error messages are printed to `stderr`.
    3232
    33 === `trac-admin <targetdir> initenv` === #initenv
     33=== `trac-admin <targetdir> initenv` #initenv
    3434
    3535This 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.
     
    3737[[TracAdminHelp(initenv)]]
    3838
    39 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.
     39It 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.
    4040See TracIni#GlobalConfiguration.
    41 
    42 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.
    4341
    4442== Interactive Mode
    4543
    46 When passing the environment path as the only argument, `trac-admin` starts in interactive mode.
     44`trac-admin` starts in interactive mode when the environment path is the only argument.
    4745Commands can then be executed on the selected environment using the prompt, which offers tab-completion
    48 (on non-Windows environments, and when the Python `readline` module is available) and automatic repetition of the last command issued.
     46for non-Windows environments, and when the Python `readline` module is available. It also offers automatic repetition of the last command issued.
    4947
    5048Once you are in interactive mode, you can also get help on specific commands or subsets of commands:
    5149
    5250For example, to get an explanation of the `resync` command, run:
    53 {{{
     51{{{#!sh
    5452$ help resync
    5553}}}
    5654
    5755To get help on all the Wiki-related commands, run:
    58 {{{
     56{{{#!sh
    5957$ help wiki
    6058}}}
     
    6260== Full Command Reference
    6361
    64 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.
     62You 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 may add their own commands.
    6563
    6664[[TracAdminHelp()]]
    6765
    6866----
    69 See also: TracGuide, TracBackup, TracPermissions, TracEnvironment, TracIni, [trac:TracMigrate TracMigrate]
     67See also: TracBackup, TracEnvironment, TracIni, [trac:TracMigrate TracMigrate]