Changes between Version 13 and Version 14 of TracAdmin
- Timestamp:
- Jan 24, 2024, 9:58:09 AM (11 months ago)
Legend:
- Unmodified
- Added
- Removed
- Modified
-
TracAdmin
v13 v14 1 1 = TracAdmin 2 2 3 [[PageOutline(2-5, Contents, floated)]]3 [[PageOutline(2-5, Contents, pullout)]] 4 4 [[TracGuideToc]] 5 5 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.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. 7 7 8 Some of th ose configurations can also be performed via the web administration module.8 Some of the configurations can also be performed via the web administration module. 9 9 10 10 == Usage 11 11 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 list12 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 15 }}} 16 16 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.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. 19 19 20 To get a comprehensive list of the available commands and sub-commands, specify an existing environment:21 {{{ 22 trac-admin /path/to/projenv help20 To get a comprehensive list of the available commands and sub-commands, specify the path to an environment followed by the subcommand `help`: 21 {{{#!sh 22 $ trac-admin /path/to/projenv help 23 23 }}} 24 24 25 Some commands have amore 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>25 Some 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 28 }}} 29 29 30 === `trac-admin <targetdir> initenv` === #initenv 30 When an error occurs in a `trac-admin` command the return value will be `2` and any error messages are printed to `stderr`. 31 32 === `trac-admin <targetdir> initenv` #initenv 31 33 32 34 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. … … 34 36 [[TracAdminHelp(initenv)]] 35 37 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 createdenvironment's `conf/trac.ini` file.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. 37 39 See 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.40 40 41 41 == Interactive Mode 42 42 43 When passing the environment path as the only argument, `trac-admin` starts in interactive mode. 44 Commands 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. 43 `trac-admin` starts in interactive mode when the environment path is the only argument. 44 Commands can then be executed on the selected environment using the prompt, which offers tab-completion when the Python `readline` module is available. It also offers automatic repetition of the last command issued. 46 45 47 Once you are in interactive mode, you can also get help on specific commands or subsets of commands: 46 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]. 48 47 49 For example, to get an explanation of the `resync` command, run:50 {{{ 48 In interactive mode, you can also get help on specific commands or subsets of commands. For example, to get an explanation of the `resync` command, run: 49 {{{#!sh 51 50 $ help resync 52 51 }}} 53 52 54 53 To get help on all the Wiki-related commands, run: 55 {{{ 54 {{{#!sh 56 55 $ help wiki 57 56 }}} … … 59 58 == Full Command Reference 60 59 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 canadd their own commands.60 The commands available by default in `trac-admin` are listed below. 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. 62 61 63 62 [[TracAdminHelp()]] 64 63 65 64 ---- 66 See also: Trac Guide, TracBackup, TracPermissions, TracEnvironment, TracIni, [trac:TracMigrate TracMigrate]65 See also: TracBackup, TracEnvironment, TracIni, [trac:TracMigrate TracMigrate]