Edgewall Software

Changes between Version 2 and Version 3 of Trac Admin


Ignore:
Timestamp:
Dec 10, 2015 6:49:23 AM (2 years ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • Trac Admin

    v2 v3  
    1 = TracAdmin =
     1= TracAdmin
     2
     3[[PageOutline(2-5, Contents, floated)]]
    24[[TracGuideToc]]
    35
    46Trac 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 == Usage ==
     8Some of those operations can also be performed via the web administration module.
    79
    8 You can get a comprehensive list of the available options, commands and sub-commands by invoking `trac-admin` with the `help` command:
    9 {{{
    10 trac-admin help
    11 }}}
     10== Usage
    1211
    13 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'll need to specify the path to the TracEnvironment that you want to administer as the first argument, for example:
    1413{{{
    1514trac-admin /path/to/projenv wiki list
    1615}}}
    1716
    18 == Interactive Mode ==
     17The 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.
     18Also, `trac-admin --version` will tell you about the Trac version (e.g. 0.12) corresponding to the program.
     19
     20If you want to get a comprehensive list of the available commands and sub-commands, you need to 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
     27{{{
     28trac-admin /path/to/projenv help <command>
     29}}}
     30
     31=== `trac-admin <targetdir> initenv` === #initenv
     32
     33This 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.
     34
     35[[TracAdminHelp(initenv)]]
     36
     37It 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.
     38See TracIni#GlobalConfiguration.
     39
     40Note 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.
     41
     42== Interactive Mode
    1943
    2044When passing the environment path as the only argument, `trac-admin` starts in interactive mode.
     
    2953}}}
    3054
    31 To get help on a all the Wiki-related commands, run:
     55To get help on all the Wiki-related commands, run:
    3256{{{
    3357> help wiki
    3458}}}
    3559
     60== Full Command Reference
     61
     62You'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.
     63
     64[[TracAdminHelp()]]
     65
    3666----
    37 See also: TracGuide, TracBackup, TracPermissions, TracEnvironment, TracIni
     67See also: TracGuide, TracBackup, TracPermissions, TracEnvironment, TracIni, [trac:TracMigrate TracMigrate]