Changes between Version 4 and Version 5 of TracAdmin


Ignore:
Timestamp:
May 4, 2020, 5:16:45 PM (5 years ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified

  • TracAdmin

    v4 v5  
    1 = TracAdmin =
     1= TracAdmin
     2
     3[[PageOutline(2-5, Contents, floated)]]
    24[[TracGuideToc]]
    35
    4 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.
     6Trac 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.
    57
    6 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).
     8Some of those configurations can also be performed via the web administration module.
    79
    8 == Usage ==
     10== Usage
    911
    10 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:
     12For nearly every `trac-admin` command, you will need to specify the path to the TracEnvironment that you want to administer as the first argument:
    1113{{{
    1214trac-admin /path/to/projenv wiki list
    1315}}}
    1416
    15 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.
     17The 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.
    1618Also, `trac-admin --version` will tell you about the Trac version (e.g. 0.12) corresponding to the program.
    1719
    18 If you want to get a comprehensive list of the available commands and sub-commands, you need to specify an existing environment:
     20To get a comprehensive list of the available commands and sub-commands, specify an existing environment:
    1921{{{
    2022trac-admin /path/to/projenv help
    … …  
    2224
    2325Some commands have a more detailed help, which you can access by specifying the command's name as a subcommand for `help`:
    24 
    2526{{{
    2627trac-admin /path/to/projenv help <command>
    … …  
    2930=== `trac-admin <targetdir> initenv` === #initenv
    3031
    31 This subcommand is very important as it's the one used to create a TracEnvironment in the specified `<targetdir>`. That directory must not exist prior to the call.
     32This 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.
    3233
    3334[[TracAdminHelp(initenv)]]
    3435
    35 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.
     36It 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.
    3637See TracIni#GlobalConfiguration.
    3738
    38 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 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.
     39Note 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.
    3940
    40 == Interactive Mode ==
     41== Interactive Mode
    4142
    4243When passing the environment path as the only argument, `trac-admin` starts in interactive mode.
    … …  
    4445(on non-Windows environments, and when the Python `readline` module is available) and automatic repetition of the last command issued.
    4546
    46 Once you're in interactive mode, you can also get help on specific commands or subsets of commands:
     47Once you are in interactive mode, you can also get help on specific commands or subsets of commands:
    4748
    4849For example, to get an explanation of the `resync` command, run:
    4950{{{
    50 > help resync
     51$ help resync
    5152}}}
    5253
    5354To get help on all the Wiki-related commands, run:
    5455{{{
    55 > help wiki
     56$ help wiki
    5657}}}
    5758
    58 == Full Command Reference ==
     59== Full Command Reference
    5960
    60 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 <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.
     61You 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.
    6162
    6263[[TracAdminHelp()]]