Changes between Version 2 and Version 3 of TracAdmin


Ignore:
Timestamp:
2019-05-02T09:45:05-03:00 (5 years ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified

  • TracAdmin

    v2 v3  
    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 those operations 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:
     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:
    1313{{{
    1414trac-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.
     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.
    1818Also, `trac-admin --version` will tell you about the Trac version (e.g. 0.12) corresponding to the program.
    1919
    20 To get a comprehensive list of the available commands and sub-commands, specify an existing environment:
     20If you want to get a comprehensive list of the available commands and sub-commands, you need to specify an existing environment:
    2121{{{
    2222trac-admin /path/to/projenv help
    … …  
    2424
    2525Some commands have a more detailed help, which you can access by specifying the command's name as a subcommand for `help`:
     26
    2627{{{
    2728trac-admin /path/to/projenv help <command>
    … …  
    3031=== `trac-admin <targetdir> initenv` === #initenv
    3132
    32 This 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.
     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.
    3334
    3435[[TracAdminHelp(initenv)]]
    … …  
    3738See TracIni#GlobalConfiguration.
    3839
    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.
     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.
    4041
    4142== Interactive Mode
    … …  
    4546(on non-Windows environments, and when the Python `readline` module is available) and automatic repetition of the last command issued.
    4647
    47 Once you are in interactive mode, you can also get help on specific commands or subsets of commands:
     48Once you're in interactive mode, you can also get help on specific commands or subsets of commands:
    4849
    4950For example, to get an explanation of the `resync` command, run:
    5051{{{
    51 $ help resync
     52> help resync
    5253}}}
    5354
    5455To get help on all the Wiki-related commands, run:
    5556{{{
    56 $ help wiki
     57> help wiki
    5758}}}
    5859
    5960== Full Command Reference
    6061
    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.
     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.
    6263
    6364[[TracAdminHelp()]]