Changes between Version 6 and Version 7 of TracAdmin


Ignore:
Timestamp:
03/07/18 16:17:30 (17 months ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • TracAdmin

    v6 v7  
    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 [http://trac.edgewall.org/wiki/WebAdmin 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 You can get a comprehensive list of the available options, commands and sub-commands by invoking `trac-admin` with the `help` command:.
    11 {{{
    12 trac-admin help
    13 }}}
    14 
    15 Unless 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:
     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:
    1613{{{
    1714trac-admin /path/to/projenv wiki list
    1815}}}
    1916
    20 == Interactive Mode ==
     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.
     18Also, `trac-admin --version` will tell you about the Trac version (e.g. 0.12) corresponding to the program.
     19
     20To get a comprehensive list of the available commands and sub-commands, specify an existing environment:
     21{{{
     22trac-admin /path/to/projenv help
     23}}}
     24
     25Some commands have a more detailed help, which you can access by specifying the command's name as a subcommand for `help`:
     26{{{
     27trac-admin /path/to/projenv help <command>
     28}}}
     29
     30=== `trac-admin <targetdir> initenv` === #initenv
     31
     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.
     33
     34[[TracAdminHelp(initenv)]]
     35
     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.
     37See TracIni#GlobalConfiguration.
     38
     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.
     40
     41== Interactive Mode
    2142
    2243When passing the environment path as the only argument, `trac-admin` starts in interactive mode.
     
    2445(on non-Windows environments, and when the Python `readline` module is available) and automatic repetition of the last command issued.
    2546
    26 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:
    2748
    2849For example, to get an explanation of the `resync` command, run:
    2950{{{
    30 > help resync
     51$ help resync
    3152}}}
    3253
    3354To get help on all the Wiki-related commands, run:
    3455{{{
    35 > help wiki
     56$ help wiki
    3657}}}
    3758
    38 == Full Command Reference ==
     59== Full Command Reference
     60
     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.
    3962
    4063[[TracAdminHelp()]]
    4164
    42 
    43 === Notes ===
    44 
    45 The `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.
    46 See TracIni#GlobalConfiguration.
    47 
    48 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.
    49 
    5065----
    5166See also: TracGuide, TracBackup, TracPermissions, TracEnvironment, TracIni, [trac:TracMigrate TracMigrate]
    52