Edgewall Software

Changes between Version 1 and Version 2 of 0.12/TracAdmin


Ignore:
Timestamp:
Jul 17, 2012, 9:37:02 PM (10 years ago)
Author:
Christian Boos
Comment:

replace call to [[TracAdminHelp]] macro by content generated on b.e.o (0.12.4dev)

Legend:

Unmodified
Added
Removed
Modified
  • 0.12/TracAdmin

    v1 v2  
    3232This 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.
    3333
    34 [[TracAdminHelp(initenv)]]
     34//(the following static content was generated by the `[[TracAdminHelp(initenv)]]` macro in a Trac 0.12.4dev-r10971 instance)//
     35{{{
     36initenv [<projectname> <db> [<repostype> <repospath>]]
     37
     38    Create and initialize a new environment
     39
     40    If no arguments are given, then the required parameters are requested
     41    interactively.
     42
     43    One or more optional arguments --inherit=PATH can be used to specify the
     44    "[inherit] file" option at environment creation time, so that only the
     45    options not already specified in one of the global configuration files are
     46    written to the conf/trac.ini file of the newly created environment.
     47    Relative paths are resolved relative to the "conf" directory of the new
     48    environment.
     49
     50}}}
    3551
    3652It 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.
     
    6177You'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.
    6278
    63 [[TracAdminHelp()]]
     79//(the following static content was generated by the `[[TracAdminHelp()]]` macro in a Trac 0.12.4dev-r10971 instance)//
     80{{{
     81help
     82
     83    Show documentation
     84
     85initenv [<projectname> <db> [<repostype> <repospath>]]
     86
     87    Create and initialize a new environment
     88
     89    If no arguments are given, then the required parameters are requested
     90    interactively.
     91
     92    One or more optional arguments --inherit=PATH can be used to specify the
     93    "[inherit] file" option at environment creation time, so that only the
     94    options not already specified in one of the global configuration files are
     95    written to the conf/trac.ini file of the newly created environment.
     96    Relative paths are resolved relative to the "conf" directory of the new
     97    environment.
     98
     99attachment add <realm:id> <path> [author] [description]
     100
     101    Attach a file to a resource
     102
     103    The resource is identified by its realm and identifier. The attachment will
     104    be named according to the base name of the file.
     105
     106attachment export <realm:id> <name> [destination]
     107
     108    Export an attachment from a resource to a file or stdout
     109
     110    The resource is identified by its realm and identifier. If no destination
     111    is specified, the attachment is output to stdout.
     112
     113attachment list <realm:id>
     114
     115    List attachments of a resource
     116
     117    The resource is identified by its realm and identifier.
     118
     119attachment remove <realm:id> <name>
     120
     121    Remove an attachment from a resource
     122
     123    The resource is identified by its realm and identifier.
     124
     125changeset added <repos> <rev> [rev] [...]
     126
     127    Notify trac about changesets added to a repository
     128
     129    This command should be called from a post-commit hook. It will trigger a
     130    cache update and notify components about the addition.
     131
     132changeset modified <repos> <rev> [rev] [...]
     133
     134    Notify trac about changesets modified in a repository
     135
     136    This command should be called from a post-revprop hook after revision
     137    properties like the commit message, author or date have been changed. It
     138    will trigger a cache update for the given revisions and notify components
     139    about the change.
     140
     141component add <name> <owner>
     142
     143    Add a new component
     144
     145component chown <name> <owner>
     146
     147    Change component ownership
     148
     149component list
     150
     151    Show available components
     152
     153component remove <name>
     154
     155    Remove/uninstall a component
     156
     157component rename <name> <newname>
     158
     159    Rename a component
     160
     161config get <section> <option>
     162
     163    Get the value of the given option in "trac.ini"
     164
     165config remove <section> <option>
     166
     167    Remove the specified option from "trac.ini"
     168
     169config set <section> <option> <value>
     170
     171    Set the value for the given option in "trac.ini"
     172
     173deploy <directory>
     174
     175    Extract static resources from Trac and all plugins
     176
     177hotcopy <backupdir>
     178
     179    Make a hot backup copy of an environment
     180
     181milestone add <name> [due]
     182
     183    Add milestone
     184
     185milestone completed <name> <completed>
     186
     187    Set milestone complete date
     188
     189    The <completed> date must be specified in the "YYYY-MM-DD" format.
     190    Alternatively, "now" can be used to set the completion date to the current
     191    time. To remove the completion date from a milestone, specify an empty
     192    string ("").
     193
     194milestone due <name> <due>
     195
     196    Set milestone due date
     197
     198    The <due> date must be specified in the "YYYY-MM-DD" format. Alternatively,
     199    "now" can be used to set the due date to the current time. To remove the
     200    due date from a milestone, specify an empty string ("").
     201
     202milestone list
     203
     204    Show milestones
     205
     206milestone remove <name>
     207
     208    Remove milestone
     209
     210milestone rename <name> <newname>
     211
     212    Rename milestone
     213
     214permission add <user> <action> [action] [...]
     215
     216    Add a new permission rule
     217
     218permission list [user]
     219
     220    List permission rules
     221
     222permission remove <user> <action> [action] [...]
     223
     224    Remove a permission rule
     225
     226priority add <value>
     227
     228    Add a priority value option
     229
     230priority change <value> <newvalue>
     231
     232    Change a priority value
     233
     234priority list
     235
     236    Show possible ticket priorities
     237
     238priority order <value> up|down
     239
     240    Move a priority value up or down in the list
     241
     242priority remove <value>
     243
     244    Remove a priority value
     245
     246repository add <repos> <dir> [type]
     247
     248    Add a source repository
     249
     250repository alias <name> <target>
     251
     252    Create an alias for a repository
     253
     254repository list
     255
     256    List source repositories
     257
     258repository remove <repos>
     259
     260    Remove a source repository
     261
     262repository resync <repos> [rev]
     263
     264    Re-synchronize trac with repositories
     265
     266    When [rev] is specified, only that revision is synchronized. Otherwise, the
     267    complete revision history is synchronized. Note that this operation can
     268    take a long time to complete. If synchronization gets interrupted, it can
     269    be resumed later using the `sync` command.
     270
     271    To synchronize all repositories, specify "*" as the repository.
     272
     273repository set <repos> <key> <value>
     274
     275    Set an attribute of a repository
     276
     277    The following keys are supported: alias, description, dir, hidden, name,
     278    type, url
     279
     280repository sync <repos> [rev]
     281
     282    Resume synchronization of repositories
     283
     284    It works like `resync`, except that it doesn't clear the already
     285    synchronized changesets, so it's a better way to resume an interrupted
     286    `resync`.
     287
     288    See `resync` help for detailed usage.
     289
     290resolution add <value>
     291
     292    Add a resolution value option
     293
     294resolution change <value> <newvalue>
     295
     296    Change a resolution value
     297
     298resolution list
     299
     300    Show possible ticket resolutions
     301
     302resolution order <value> up|down
     303
     304    Move a resolution value up or down in the list
     305
     306resolution remove <value>
     307
     308    Remove a resolution value
     309
     310session add <sid[:0|1]> [name] [email]
     311
     312    Create a session for the given sid
     313
     314    Populates the name and email attributes for the given session. Adding a
     315    suffix ':0' to the sid makes the session unauthenticated, and a suffix ':1'
     316    makes it authenticated (the default if no suffix is specified).
     317
     318session delete <sid[:0|1]> [...]
     319
     320    Delete the session of the specified sid
     321
     322    An sid suffix ':0' operates on an unauthenticated session with the given
     323    sid, and a suffix ':1' on an authenticated session (the default).
     324    Specifying the sid 'anonymous' will delete all anonymous sessions.
     325
     326session list [sid[:0|1]] [...]
     327
     328    List the name and email for the given sids
     329
     330    Specifying the sid 'anonymous' lists all unauthenticated sessions, and
     331    'authenticated' all authenticated sessions. '*' lists all sessions, and is
     332    the default if no sids are given.
     333
     334    An sid suffix ':0' operates on an unauthenticated session with the given
     335    sid, and a suffix ':1' on an authenticated session (the default).
     336
     337session purge <age>
     338
     339    Purge all anonymous sessions older than the given age
     340
     341    Age may be specified as a relative time like "90 days ago", or in YYYYMMDD
     342    format.
     343
     344session set <name|email> <sid[:0|1]> <value>
     345
     346    Set the name or email attribute of the given sid
     347
     348    An sid suffix ':0' operates on an unauthenticated session with the given
     349    sid, and a suffix ':1' on an authenticated session (the default).
     350
     351severity add <value>
     352
     353    Add a severity value option
     354
     355severity change <value> <newvalue>
     356
     357    Change a severity value
     358
     359severity list
     360
     361    Show possible ticket severities
     362
     363severity order <value> up|down
     364
     365    Move a severity value up or down in the list
     366
     367severity remove <value>
     368
     369    Remove a severity value
     370
     371ticket remove <number>
     372
     373    Remove ticket
     374
     375ticket_type add <value>
     376
     377    Add a ticket type
     378
     379ticket_type change <value> <newvalue>
     380
     381    Change a ticket type
     382
     383ticket_type list
     384
     385    Show possible ticket types
     386
     387ticket_type order <value> up|down
     388
     389    Move a ticket type up or down in the list
     390
     391ticket_type remove <value>
     392
     393    Remove a ticket type
     394
     395upgrade
     396
     397    Upgrade database to current version
     398
     399version add <name> [time]
     400
     401    Add version
     402
     403version list
     404
     405    Show versions
     406
     407version remove <name>
     408
     409    Remove version
     410
     411version rename <name> <newname>
     412
     413    Rename version
     414
     415version time <name> <time>
     416
     417    Set version date
     418
     419    The <time> must be specified in the "YYYY-MM-DD" format. Alternatively,
     420    "now" can be used to set the version date to the current time. To remove
     421    the date from a version, specify an empty string ("").
     422
     423wiki dump <directory> [page] [...]
     424
     425    Export wiki pages to files named by title
     426
     427    Individual wiki page names can be specified after the directory. A name
     428    ending with a * means that all wiki pages starting with that prefix should
     429    be dumped. If no name is specified, all wiki pages are dumped.
     430
     431wiki export <page> [file]
     432
     433    Export wiki page to file or stdout
     434
     435wiki import <page> [file]
     436
     437    Import wiki page from file or stdin
     438
     439wiki list
     440
     441    List wiki pages
     442
     443wiki load <path> [...]
     444
     445    Import wiki pages from files
     446
     447    If a given path is a file, it is imported as a page with the name of the
     448    file. If a path is a directory, all files in that directory are imported.
     449
     450wiki remove <page>
     451
     452    Remove wiki page
     453
     454wiki rename <page> <new_name>
     455
     456    Rename wiki page
     457
     458wiki replace <path> [...]
     459
     460    Replace the content of wiki pages from files (DANGEROUS!)
     461
     462    This command replaces the content of the last version of one or more wiki
     463    pages with new content. The previous content is lost, and no new entry is
     464    created in the page history. The metadata of the page (time, author) is not
     465    changed either.
     466
     467    If a given path is a file, it is imported as a page with the name of the
     468    file. If a path is a directory, all files in that directory are imported.
     469
     470    WARNING: This operation results in the loss of the previous content and
     471    cannot be undone. It may be advisable to backup the current content using
     472    "wiki dump" beforehand.
     473
     474wiki upgrade
     475
     476    Upgrade default wiki pages to current version
     477
     478}}}
    64479
    65480----