Changes between Version 1 and Version 2 of TracAdmin
- Timestamp:
- 2023-04-20T18:30:58Z (19 months ago)
Legend:
- Unmodified
- Added
- Removed
- Modified
-
TracAdmin
v1 v2 1 = TracAdmin = 1 = TracAdmin 2 3 [[PageOutline(2-5, Contents, pullout)]] 2 4 [[TracGuideToc]] 3 5 4 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. 5 7 6 Some of th ose operations can also be performed via the ''Admin'' web interface, an updated version of the [http://trac.edgewall.org/wiki/WebAdmin WebAdmin] plugin now integrated within Trac (since version 0.11).8 Some of the configurations can also be performed via the web administration module. 7 9 8 == Usage ==10 == Usage 9 11 10 You can get a comprehensive list of the available options, commands and sub-commands by invoking `trac-admin` with the `help` command:. 11 {{{ 12 trac-admin help 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 13 15 }}} 14 16 15 Unless you're executing the `help`, `about` or `version` sub-commands, you'll need to specify the path to the TracEnvironment that you want to administer as the first argument, for example: 16 {{{ 17 trac-admin /path/to/projenv wiki list 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 20 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 18 23 }}} 19 24 20 == Interactive Mode == 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 }}} 21 29 22 When passing the environment path as the only argument, `trac-admin` starts in interactive mode. 23 Commands can then be executed on the selected environment using the prompt, which offers tab-completion 24 (on non-Windows environments, and when the Python `readline` module is available) and automatic repetition of the last command issued. 30 When an error occurs in a `trac-admin` command the return value will be `2` and any error messages are printed to `stderr`. 25 31 26 Once you're in interactive mode, you can also get help on specific commands or subsets of commands: 32 === `trac-admin <targetdir> initenv` #initenv 27 33 28 For example, to get an explanation of the `resync` command, run: 29 {{{ 30 > help resync 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. 35 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 42 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. 45 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]. 47 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 50 $ help resync 31 51 }}} 32 52 33 53 To get help on all the Wiki-related commands, run: 34 {{{ 35 >help wiki54 {{{#!sh 55 $ help wiki 36 56 }}} 37 57 38 == Full Command Reference == 58 == Full Command Reference 59 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. 39 61 40 62 [[TracAdminHelp()]] 41 63 42 43 === Notes ===44 45 The `initenv` also supports an extra `--inherit` option, which can be used to specify the `[inherit] file` option at environment creation time so that only the options ''not'' already specified in the global configuration file will be written in the conf/trac.ini file of the newly created environment.46 See TracIni#GlobalConfiguration.47 48 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.49 50 64 ---- 51 See also: Trac Guide, TracBackup, TracPermissions, TracEnvironment, TracIni, [trac:TracMigrate TracMigrate]65 See also: TracBackup, TracEnvironment, TracIni, [trac:TracMigrate TracMigrate]
