Changes between Version 2 and Version 3 of TracAdmin


Ignore:
Timestamp:
Mar 18, 2021, 4:57:27 AM (3 years ago)
Author:
anonymous
Comment:

--

Legend:

Unmodified
Added
Removed
Modified

  • TracAdmin

    v2 v3  
    1 = TracAdmin
     1TracAdmin
    22
    3 [[PageOutline(2-5, Contents, pullout)]]
    4 [[TracGuideToc]]
     3PageOutline(2-5, Contents, pullout)
     4TracGuideToc
    55
    66Trac 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.
    … …  
    88Some of the configurations can also be performed via the web administration module.
    99
    10 == Usage
     10 Usage
    1111
    12 For 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
    15 }}}
     12For nearly every `trac-admin` command, the first argument must be the path to the TracEnvironment
    1613
    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 `trac-admin --version` will tell you about the Trac version (e.g. 1.2) corresponding to the program.
     14$ trac-admin /path/to/projenv list
    1915
    20 To get a comprehensive list of the available command and sub-command, specify the path to an environment:
    21 {{{#!sh
     16The 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.
     17`trac admin version` will tell you about the Trac version (e.g. 1.2) corresponding to the program.
     18
     19To get a comprehensive list of the available command and sub-command, specify the path to an environment
     20
    2221$ trac-admin /path/to/projenv help
    23 }}}
    2422
    2523Some 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>
    28 }}}
     24
     25$ trac-admin /path/toprojenv help <command>
     26
    2927
    3028When an error occurs in a `trac-admin` command the return value will be `2` and error messages are printed to `stderr`.
    3129
    32 === `trac-admin <targetdir> initenv` #initenv
     30 `trac-admin <targetdir> initenv` initenv
    3331
    3432This 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.
     33TracAdminHelp(initenv)
    3534
    36 [[TracAdminHelp(initenv)]]
    37 
    38 It 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.
    39 See TracIni#GlobalConfiguration.
    40 
    41 == Interactive Mode
     35It supports the `no one 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 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.
     36See TracIni my GlobalConfiguration.
     37Interactive
    4238
    4339`trac-admin` starts in interactive mode when the environment path is the only argument.
    … …  
    4541when the Python `readline` module is available. It also offers automatic repetition of the last command issued.
    4642
    47 The `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].
     43The `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
    4844
    4945Once you are in interactive mode, you can also get help on specific commands or subsets of commands:
    5046
    5147For example, to get an explanation of the `resync` command, run:
    52 {{{#!sh
     48
    5349$ help resync
    54 }}}
    5550
    56 To get help on all the Wiki-related commands, run:
    57 {{{#!sh
     51To get help on all the related commands, run:
     52
    5853$ help wiki
    59 }}}
    60 
    61 == Full Command Reference
     54 Full Command Reference
    6255
    6356You 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.
    6457
    65 [[TracAdminHelp()]]
     58TracAdminHelp()
    6659
    67 ----
    68 See also: TracBackup, TracEnvironment, TracIni, [trac:TracMigrate TracMigrate]
     60See also: TracBackup, TracEnvironment, TracIni, trac:TracMigrate TracMigrate