Changes between Version 1 and Version 2 of TracAdmin


Ignore:
Timestamp:
Apr 13, 2011, 9:05:35 PM (7 years ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • TracAdmin

    v1 v2  
    22[[TracGuideToc]]
    33
    4 Trac is distributed with a powerful configuration tool. This tool can be used
    5 to configure and customize your Trac-installation to better fit your needs.
     4Trac 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
     6Some of those operations can also be performed via the ''Admin'' web interface, an updated version of the [trac:WebAdmin] plugin now integrated within Trac (since version 0.11).
    67
    78== Usage ==
    89
     10For 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:
    911{{{
    10 Usage: trac-admin </path/to/projenv> [command [subcommand] [option ...]]
     12trac-admin /path/to/projenv wiki list
     13}}}
    1114
    12 Invoking trac-admin without command starts interactive mode.
     15The 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.
     16Also, `trac-admin --version` will tell you about the Trac version (e.g. 0.12) corresponding to the program.
    1317
    14 about                                             -- Shows information about trac-admin                   
    15 help                                              -- Show documentation                                   
    16 initenv                                           -- Create and initialize a new environment interactively
    17 initenv <projectname> <repospath> <templatepath>  -- Create and initialize a new environment from arguments
    18 hotcopy <backupdir>                               -- Make a hot backup copy of an environment.             
    19 resync                                            -- Re-synchronize trac with the repository               
    20 upgrade                                           -- Upgrade database to current version.                 
    21 wiki list                                         -- List wiki pages                                       
    22 wiki export <page> [file]                         -- Export wiki page to file or stdout                   
    23 wiki import <page> [file]                         -- Import wiki page from file or stdin                   
    24 wiki dump <directory>                             -- Export all wiki pages to files named by title         
    25 wiki load <directory>                             -- Import all wiki pages from directory                 
    26 wiki upgrade                                      -- Upgrade default wiki pages to current version         
    27 permission list                                   -- List permission rules                                 
    28 permission add <user> <action> [action] [...]     -- Add a new permission rule                             
    29 permission remove <user> <action> [action] [...]  -- Remove permission rule                               
    30 component list                                    -- Show available components                             
    31 component add <name> <owner>                      -- Add a new component                                   
    32 component rename <name> <newname>                 -- Rename a component                                   
    33 component remove <name>                           -- Remove/uninstall component                           
    34 component chown <name> <owner>                    -- Change component ownership                           
    35 priority list                                     -- Show possible ticket priorities                       
    36 priority add <value>                              -- Add a priority value option                           
    37 priority change <value> <newvalue>                -- Change a priority value                               
    38 priority remove <value>                           -- Remove priority value                                 
    39 severity list                                     -- Show possible ticket priorities                       
    40 severity add <value>                              -- Add a severity value option                           
    41 severity change <value> <newvalue>                -- Change a severity value                               
    42 severity remove <value>                           -- Remove severity value                                 
    43 version list                                      -- Show versions                                         
    44 version add <name> [time]                         -- Add version                                           
    45 version rename <name> <newname>                   -- Rename version                                       
    46 version time <name> <time>                        -- Set version date (Format: "Jun 3, 2003")             
    47 version remove <name>                             -- Remove version                                       
    48 milestone list                                    -- Show milestones                                       
    49 milestone add <name> [time]                       -- Add milestone                                         
    50 milestone rename <name> <newname>                 -- Rename milestone                                     
    51 milestone time <name> <time>                      -- Set milestone date (Format: "Jun 3, 2003")           
    52 milestone remove <name>                           -- Remove milestone                                     
     18If you want to get a comprehensive list of the available commands and sub-commands, you need to specify an existing environment:
     19{{{
     20trac-admin /path/to/projenv help
    5321}}}
     22
     23Some commands have a more detailed help, which you can access by specifying the command's name as a subcommand for `help`:
     24
     25{{{
     26trac-admin /path/to/projenv help <command>
     27}}}
     28
     29=== `trac-admin <targetdir> initenv` === #initenv
     30
     31This 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.
     32
     33[[TracAdminHelp(initenv)]]
     34
     35It supports an extra `--inherit` option, which can be used to specify a global configuration file which can be used 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 created environment's `conf/trac.ini` file.
     36See TracIni#GlobalConfiguration.
     37
     38Note 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.
    5439
    5540== Interactive Mode ==
    5641
    57 When passed the database filename as only argument, '''trac-admin''' starts in interactive mode.
    58 Commands can then be executed on the selected database using the prompt, which offers tab-completion
    59 (on non-Windows environments) and automatic repetition of the last command issued.
     42When passing the environment path as the only argument, `trac-admin` starts in interactive mode.
     43Commands can then be executed on the selected environment using the prompt, which offers tab-completion
     44(on non-Windows environments, and when the Python `readline` module is available) and automatic repetition of the last command issued.
    6045
    61 == A Note on Configuration ==
    62 For configuration of the Trac environment, Trac 0.7 introduced a new storage format, including a separate config file used for settings. See TracIni for details.
     46Once you're in interactive mode, you can also get help on specific commands or subsets of commands:
    6347
     48For example, to get an explanation of the `resync` command, run:
     49{{{
     50> help resync
     51}}}
     52
     53To get help on all the Wiki-related commands, run:
     54{{{
     55> help wiki
     56}}}
     57
     58== Full Command Reference ==
     59
     60You'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.
     61
     62[[TracAdminHelp()]]
    6463
    6564----
    66 See Also: TracGuide, TracBackup, TracPermissions. TracEnvironment, TracIni
     65See also: TracGuide, TracBackup, TracPermissions, TracEnvironment, TracIni, [trac:TracMigrate TracMigrate]