Changes between Version 1 and Version 2 of TracAdmin


Ignore:
Timestamp:
Apr 7, 2008, 11:15:27 AM (9 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 web interface thanks to the optional [http://trac.edgewall.org/wiki/WebAdmin WebAdmin] plugin, distributed separately for now. 
    67 
    78== Usage == 
    89 
     10You can get a comprehensive list of the available options, commands and sub-commands by invoking `trac-admin` with the `help` command: 
    911{{{ 
    10 Usage: trac-admin </path/to/projenv> [command [subcommand] [option ...]] 
     12trac-admin help 
     13}}} 
    1114 
    12 Invoking trac-admin without command starts interactive mode. 
    13  
    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                                       
     15Unless 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{{{ 
     17trac-admin /path/to/projenv wiki list 
    5318}}} 
    5419 
    5520== Interactive Mode == 
    5621 
    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. 
     22When passing the environment path as the only argument, `trac-admin` starts in interactive mode. 
     23Commands 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. 
    6025 
    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. 
     26Once you're in interactive mode, you can also get help on specific commands or subsets of commands: 
    6327 
     28For example, to get an explanation of the `resync` command, run: 
     29{{{ 
     30> help resync 
     31}}} 
     32 
     33To get help on a all the Wiki-related commands, run: 
     34{{{ 
     35> help wiki 
     36}}} 
    6437 
    6538---- 
    66 See Also: TracGuide, TracBackup, TracPermissions. TracEnvironment, TracIni 
     39See also: TracGuide, TracBackup, TracPermissions, TracEnvironment, TracIni