Changes between Version 1 and Version 2 of TracAdmin


Ignore:
Timestamp:
Jan 16, 2006, 10:33:18 AM (14 years ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • TracAdmin

    v1 v2  
    11= TracAdmin =
     2[[TracGuideToc]]
    23
    3 Trac is distributed with a powerful configuration tool. This tool can be used
    4 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.
    55
    66== Usage ==
    77
     8You can get a comprehensive list of the available options, commands and sub-commands by invoking `trac-admin` with the `help` command:
    89{{{
    9 Usage: trac-admin <dbfile> [command [subcommand] [option ...]]
    10 
    11 Invoking trac-admin without command starts interactive mode.
    12 
    13 about                               -- Shows information about trac-admin
    14 help                                -- Show documentation
    15 initdb                              -- Create and initializes a new database
    16 config list                         -- Show current configuration
    17 config set <option> <value>         -- Set config
    18 wiki list                           -- List wiki pages
    19 wiki export <page> [file]           -- Export wiki page to file or stdout
    20 wiki import <page> [file]           -- Import wiki page from file or stdin
    21 wiki dump <directory>               -- Export all wiki pages to files named by title
    22 permission list                     -- List permission rules
    23 permission add <user> <action>      -- Add a new permission rule
    24 permission remove <user> <action>   -- Remove permission rule
    25 component list                      -- Show available components
    26 component add <name> <owner>        -- Add a new component
    27 component rename <name> <newname>   -- Rename a component
    28 component remove <name>             -- Remove/uninstall component
    29 component chown <name> <owner>      -- Change component ownership
    30 priority list                       -- Show possible ticket priorities
    31 priority add <value>                -- Add a priority value option
    32 priority change <value> <newvalue>  -- Change a priority value
    33 priority remove <value>             -- Remove priority value
    34 severity list                       -- Show possible ticket priorities
    35 severity add <value>                -- Add a severity value option
    36 severity change <value> <newvalue>  -- Change a severity value
    37 severity remove <value>             -- Remove severity value
    38 version list                        -- Show versions
    39 version add <name> [time]           -- Add version
    40 version rename <name> <newname>     -- Rename version
    41 version time <name> <time>          -- Set version date/time
    42 version remove <name>               -- Remove version
    43 milestone list                      -- Show milestones
    44 milestone add <name> [time]         -- Add milestone
    45 milestone rename <name> <newname>   -- Rename milestone
    46 milestone time <name> <time>        -- Set milestone date/time
    47 milestone remove <name>             -- Remove milestone
     10trac-admin help
    4811}}}
    4912
    50 == Interactive mode ==
     13Unless 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:
     14{{{
     15trac-admin /path/to/projenv wiki list
     16}}}
    5117
    52 '''trac-admin''' starts in an interactive mode when started with the database
    53 filename as the only argument. Commands can then be executed on the selected
    54 database using the tab-completing prompt.
     18== Interactive Mode ==
     19
     20When passing the environment path as the only argument, `trac-admin` starts in interactive mode.
     21Commands can then be executed on the selected environment using the prompt, which offers tab-completion
     22(on non-Windows environments, and when the Python `readline` module is available) and automatic repetition of the last command issued.
     23
     24Once you're in interactive mode, you can also get help on specific commands or subsets of commands:
     25
     26For example, to get an explanation of the `resync` command, run:
     27{{{
     28> help resync
     29}}}
     30
     31To get help on a all the Wiki-related commands, run:
     32{{{
     33> help wiki
     34}}}
     35
     36----
     37See also: TracGuide, TracBackup, TracPermissions, TracEnvironment, TracIni