Edgewall Software

Changes between Version 56 and Version 57 of TracAdmin


Ignore:
Timestamp:
Jan 31, 2016, 11:23:41 AM (8 years ago)
Author:
figaro
Comment:

Further cosmetic changes

Legend:

Unmodified
Added
Removed
Modified
  • TracAdmin

    v56 v57  
    55[[TranslatedPages]]
    66
    7 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.
     7Trac 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.
    88
    9 Some of those operations can also be performed via the web administration module.
     9Some of those configurations can also be performed via the web administration module.
    1010
    1111== Usage
    1212
    13 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:
     13For nearly every `trac-admin` command, you will need to specify the path to the TracEnvironment that you want to administer as the first argument:
    1414{{{
    1515trac-admin /path/to/projenv wiki list
    1616}}}
    1717
    18 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.
     18The 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.
    1919Also, `trac-admin --version` will tell you about the Trac version (e.g. 0.12) corresponding to the program.
    2020
    21 If you want to get a comprehensive list of the available commands and sub-commands, you need to specify an existing environment:
     21To get a comprehensive list of the available commands and sub-commands, specify an existing environment:
    2222{{{
    2323trac-admin /path/to/projenv help
     
    2525
    2626Some commands have a more detailed help, which you can access by specifying the command's name as a subcommand for `help`:
    27 
    2827{{{
    2928trac-admin /path/to/projenv help <command>
     
    3231=== `trac-admin <targetdir> initenv` === #initenv
    3332
    34 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.
     33This 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.
    3534
    3635[[TracAdminHelp(initenv)]]
     
    3938See TracIni#GlobalConfiguration.
    4039
    41 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.
     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 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.
    4241
    4342== Interactive Mode
     
    4746(on non-Windows environments, and when the Python `readline` module is available) and automatic repetition of the last command issued.
    4847
    49 Once you're in interactive mode, you can also get help on specific commands or subsets of commands:
     48Once you are in interactive mode, you can also get help on specific commands or subsets of commands:
    5049
    5150For example, to get an explanation of the `resync` command, run:
    5251{{{
    53 > help resync
     52$ help resync
    5453}}}
    5554
    5655To get help on all the Wiki-related commands, run:
    5756{{{
    58 > help wiki
     57$ help wiki
    5958}}}
    6059
    6160== Full Command Reference
    6261
    63 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.
     62You 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.
    6463
    6564[[TracAdminHelp()]]