Changes between Version 4 and Version 5 of TracAdmin


Ignore:
Timestamp:
Aug 1, 2023, 3:35:37 PM (17 months ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified

  • TracAdmin

    v4 v5  
    11= TracAdmin
    22
    3 [[PageOutline(2-5, Contents, floated)]]
     3[[PageOutline(2-5, Contents, pullout)]]
    44[[TracGuideToc]]
    55
    6 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.
    77
    8 Some of those configurations can also be performed via the web administration module.
     8Some of the configurations can also be performed via the web administration module.
    99
    1010== Usage
    1111
    12 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:
    13 {{{
    14 trac-admin /path/to/projenv wiki list
     12For nearly every `trac-admin` command, the first argument must be the path to the TracEnvironment:
     13{{{#!sh
     14$ trac-admin /path/to/projenv wiki list
    1515}}}
    1616
    17 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.
    18 Also, `trac-admin --version` will tell you about the Trac version (e.g. 0.12) corresponding to the program.
     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.
     18`trac-admin --version` will tell you about the Trac version (e.g. 1.2) corresponding to the program.
    1919
    20 To get a comprehensive list of the available commands and sub-commands, specify an existing environment:
    21 {{{
    22 trac-admin /path/to/projenv help
     20To get a comprehensive list of the available command and sub-command, specify the path to an environment:
     21{{{#!sh
     22$ trac-admin /path/to/projenv help
    2323}}}
    2424
    25 Some commands have a more detailed help, which you can access by specifying the command's name as a subcommand for `help`:
    26 {{{
    27 trac-admin /path/to/projenv help <command>
     25Some commands have more detailed help, which you can access by specifying the command's name as a subcommand for `help`:
     26{{{#!sh
     27$ trac-admin /path/to/projenv help <command>
    2828}}}
    2929
    30 === `trac-admin <targetdir> initenv` === #initenv
     30When an error occurs in a `trac-admin` command the return value will be `2` and error messages are printed to `stderr`.
     31
     32=== `trac-admin <targetdir> initenv` #initenv
    3133
    3234This 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.
    … …  
    3436[[TracAdminHelp(initenv)]]
    3537
    36 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.
     38It 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.
    3739See TracIni#GlobalConfiguration.
    38 
    39 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.
    4040
    4141== Interactive Mode
    4242
    43 When passing the environment path as the only argument, `trac-admin` starts in interactive mode.
     43`trac-admin` starts in interactive mode when the environment path is the only argument.
    4444Commands can then be executed on the selected environment using the prompt, which offers tab-completion
    45 (on non-Windows environments, and when the Python `readline` module is available) and automatic repetition of the last command issued.
     45when the Python `readline` module is available. It also offers automatic repetition of the last command issued.
     46
     47The `readline` module should be available on all Unix-compatible platforms. For Windows, support can be obtained by installing [https://pypi.python.org/pypi/pyreadline pyreadline].
    4648
    4749Once you are in interactive mode, you can also get help on specific commands or subsets of commands:
    4850
    4951For example, to get an explanation of the `resync` command, run:
    50 {{{
     52{{{#!sh
    5153$ help resync
    5254}}}
    5355
    5456To get help on all the Wiki-related commands, run:
    55 {{{
     57{{{#!sh
    5658$ help wiki
    5759}}}
    … …  
    5961== Full Command Reference
    6062
    61 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.
     63You 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.
    6264
    6365[[TracAdminHelp()]]
    6466
    6567----
    66 See also: TracGuide, TracBackup, TracPermissions, TracEnvironment, TracIni, [trac:TracMigrate TracMigrate]
     68See also: TracBackup, TracEnvironment, TracIni, [trac:TracMigrate TracMigrate]