Changes between Version 1 and Version 2 of TracAdmin
- Timestamp:
- Sep 2, 2019, 4:56:56 PM (5 years 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 は強力なコマンドラインの管理ツールとともに配布されています。このツールで Trac を管理/設定し、インストールを用途に合わせてカスタマイズすることができます。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 ここに挙げる操作の一部は ''管理'' (英語版では ''Admin'') Web インタフェースでも実行することができます。バージョン 0.11 以降で [trac:WebAdmin] プラグインは Trac 本体に統合されました。 8 Some of the configurations can also be performed via the web administration module. 7 9 8 == 使い方 == #Usage10 == Usage 9 11 10 ほぼ全ての `trac-admin` コマンドにおいて、以下の例に示す通り、第1引数には管理対象とする TracEnvironment のパスを指定する必要があります:11 {{{ 12 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 13 15 }}} 14 16 15 唯一の例外は `help` コマンドで、 Environment を指定しない場合でも動作し、使用できるコマンドの簡易なリスト (`help` や `initenv` のような) を表示します。同じリストは、引数を指定せずに `trac-admin` コマンドを使用した場合も表示されます。 16 また `trac-admin --version` を使用すると (0.12 のような形式の) Trac のバージョンを表示します。 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. 17 19 18 使用できるコマンドやサブコマンドの完全なリストを取得したい場合は、 Environment のパスを指定してください:19 {{{ 20 trac-admin /path/to/projenv help20 To get a comprehensive list of the available command and sub-command, specify the path to an environment: 21 {{{#!sh 22 $ trac-admin /path/to/projenv help 21 23 }}} 22 24 23 一部のコマンドでは、 `help` のサブコマンドとしてコマンド名を指定することで、より詳細なヘルプをみることができます: 24 25 {{{ 26 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> 27 28 }}} 28 29 29 === `trac-admin <targetdir> initenv` === #initenv 30 When an error occurs in a `trac-admin` command the return value will be `2` and error messages are printed to `stderr`. 30 31 31 このサブコマンドは、指定された `<targetdir>` に TracEnvironment を作成する、とても重要なコマンドです。対象のディレクトリが実行時に存在するとエラーになります。 32 === `trac-admin <targetdir> initenv` #initenv 33 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. 32 35 33 36 [[TracAdminHelp(initenv)]] 34 37 35 `--inherit` オプションを使用すると、グローバルな設定ファイルを指定することができます。このファイルは複数の Environment 間で共有されます。共有する設定ファイルを後から設定したい場合は、 Environment に含まれる `conf/trac.ini` ファイルに `[inherit] file` オプションを設定してください。 Environment 作成時のオプションでグローバルな設定ファイルを指定すると、自動的に `conf/trac.ini` ファイルにオプションが記載され、重複するオプションについては作成時に設定する必要がなくなるというメリットがあります。 36 詳細は [TracIni#GlobalConfiguration TracIni#グローバルな設定] を参照してください。 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. 37 40 38 Note: Trac のバージョン 0.11 では `initenv` の最終引数 `<templatepath>` が廃止されました。この引数は以前のバージョンでは `templates` ディレクトリの場所を指定するのに使用されていました。現在のコマンドはワンライナーでは '`trac-admin /path/to/trac/ initenv <projectname> <db> <repostype> <repospath>`' となるので、以前と同じ引数で起動すると ''''`Wrong number of arguments to initenv: 4`'''' というエラーが発生します。このエラーが発生した場合、 '''古い''' バージョンの Trac に同梱されている `trac-admin` スクリプトが動いていると考えられます。 41 == Interactive Mode 39 42 40 == 対話モード == #InteractiveMode 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 45 when the Python `readline` module is available. It also offers automatic repetition of the last command issued. 41 46 42 `trac-admin` は TracEnvironment のパスだけを引数に指定して起動した場合、対話モードになります。 43 プロンプトから入力したコマンドは指定した TracEnvironment に対して実行します。 44 コマンドを Tab キーで補完する機能と、最後に実行したコマンドを繰り返す機能が提供されます (非 Windows 環境の場合、 Python が `readline` モジュールを使用できる必要があります) 。 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]. 45 48 46 一度対話モードで起動すると、特定のコマンドのヘルプやコマンドのサブセットを見ることができます:49 Once you are in interactive mode, you can also get help on specific commands or subsets of commands: 47 50 48 例えば、 `resync` コマンドの説明を得るためには以下のように実行します:49 {{{ 50 >help resync51 For example, to get an explanation of the `resync` command, run: 52 {{{#!sh 53 $ help resync 51 54 }}} 52 55 53 Wiki に関するすべてのコマンドのヘルプを得るためには、以下のように実行します:54 {{{ 55 >help wiki56 To get help on all the Wiki-related commands, run: 57 {{{#!sh 58 $ help wiki 56 59 }}} 57 60 58 == 完全なコマンドリファレンス == #FullCommandReference61 == Full Command Reference 59 62 60 以下に示すのは `trac-admin` で標準的に使用できる全てのコマンドの詳細なヘルプです。 `trac-admin <yourenv> help` で表示されるリストとは一致しないこともありますが、 Environment で無効化されているコンポーネントに由来するコマンドは表示されず、逆に Environment で有効化されているプラグインによって提供されるコマンドが別途表示されるためです。 63 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 may add their own commands. 61 64 62 65 [[TracAdminHelp()]] 63 66 64 67 ---- 65 See also: Trac Guide, TracBackup, TracPermissions, TracEnvironment, TracIni, [trac:TracMigrate TracMigrate]68 See also: TracBackup, TracEnvironment, TracIni, [trac:TracMigrate TracMigrate]