| 1 | <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" |
|---|
| 2 | "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> |
|---|
| 3 | |
|---|
| 4 | <html xmlns="http://www.w3.org/1999/xhtml"> |
|---|
| 5 | <head> |
|---|
| 6 | <meta name="generator" content= |
|---|
| 7 | "HTML Tidy for Linux/x86 (vers 1st December 2004), see www.w3.org" /> |
|---|
| 8 | |
|---|
| 9 | <title>Annex: Declarations in FCM central/user configuration file</title> |
|---|
| 10 | <meta name="author" content="FCM development team" /> |
|---|
| 11 | <meta name="descriptions" content="User Guide Annex" /> |
|---|
| 12 | <meta name="keywords" content="FCM, user guide, annex" /> |
|---|
| 13 | <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> |
|---|
| 14 | <link rel="stylesheet" type="text/css" href="style.css" /> |
|---|
| 15 | <script type="text/javascript" src="fcm.js"> |
|---|
| 16 | </script> |
|---|
| 17 | </head> |
|---|
| 18 | |
|---|
| 19 | <body onload= |
|---|
| 20 | "javascript: FCM.load('doc/user_guide/', null, [['.', 'FCM User Guide']]);"> |
|---|
| 21 | <div id="document-info"> |
|---|
| 22 | <address id="fcm-js-trail"></address> |
|---|
| 23 | |
|---|
| 24 | <address id="fcm-js-maintenance"></address> |
|---|
| 25 | </div> |
|---|
| 26 | |
|---|
| 27 | <h1>Annex: Declarations in FCM central/user configuration file</h1> |
|---|
| 28 | |
|---|
| 29 | <p>Please note that setting labels in both the central and the user |
|---|
| 30 | configuration files are case insensitive.</p> |
|---|
| 31 | |
|---|
| 32 | <p>N.B. almost all settings in the Fcm::Config module can be modified using |
|---|
| 33 | the central/user configuration file. However, most users should only ever |
|---|
| 34 | need to use the following.</p> |
|---|
| 35 | |
|---|
| 36 | <dl> |
|---|
| 37 | <dt> |
|---|
| 38 | SET::URL::<pck><br /> |
|---|
| 39 | <del>SET::REPOS::<pck></del> |
|---|
| 40 | </dt> |
|---|
| 41 | |
|---|
| 42 | <dd> |
|---|
| 43 | <p>This declares a URL keyword for the package <pck>. The value of |
|---|
| 44 | the declaration must be a valid Subversion <URL>. Once declared, |
|---|
| 45 | the URL keyword <pck> will be associated with the specified URL. In |
|---|
| 46 | subsequent invocations of the <code>fcm</code> command, the following |
|---|
| 47 | expansion may take place:</p> |
|---|
| 48 | |
|---|
| 49 | <ul> |
|---|
| 50 | <li><samp>fcm:<pck></samp>: replaced by |
|---|
| 51 | <samp><URL></samp>.</li> |
|---|
| 52 | |
|---|
| 53 | <li><samp>fcm:<pck>_tr</samp> or <samp>fcm:<pck>-tr</samp>: |
|---|
| 54 | replaced by <samp><URL>/trunk</samp></li> |
|---|
| 55 | |
|---|
| 56 | <li><samp>fcm:<pck>_br</samp> or <samp>fcm:<pck>-br</samp>: |
|---|
| 57 | replaced by <samp><URL>/branches</samp></li> |
|---|
| 58 | |
|---|
| 59 | <li><samp>fcm:<pck>_tg</samp> or <samp>fcm:<pck>-tg</samp>: |
|---|
| 60 | replaced by <samp><URL>/tags</samp></li> |
|---|
| 61 | </ul> |
|---|
| 62 | |
|---|
| 63 | <p>Example:</p> |
|---|
| 64 | <pre> |
|---|
| 65 | # Associate "var" with "svn://server/VAR_svn/var" |
|---|
| 66 | set::url::var svn://server/VAR_svn/var |
|---|
| 67 | |
|---|
| 68 | # "fcm:var" is now the same as "svn://server/VAR_svn/var" |
|---|
| 69 | </pre> |
|---|
| 70 | </dd> |
|---|
| 71 | |
|---|
| 72 | <dt>SET::REVISION::<pck>::<keyword></dt> |
|---|
| 73 | |
|---|
| 74 | <dd> |
|---|
| 75 | <p>This declares <keyword> to be the revision number for the |
|---|
| 76 | package <pck>. The <keyword> string can contain any |
|---|
| 77 | characters except spaces. It must not contain only digits (as digits are |
|---|
| 78 | treated as revision numbers). It must not be the Subversion revision |
|---|
| 79 | keywords HEAD, BASE, COMMITTED and PREV. It cannot begin and end with a |
|---|
| 80 | pair of curly brackets (as this will be parsed as a revision date). The |
|---|
| 81 | package <pck> must be associated with a URL using the |
|---|
| 82 | SET::URL::<pck> declaration described above before this declaration |
|---|
| 83 | can make sense. Once defined, <keyword> can be used anywhere in |
|---|
| 84 | place the defined revision number.</p> |
|---|
| 85 | |
|---|
| 86 | <p>Example:</p> |
|---|
| 87 | <pre> |
|---|
| 88 | set::revision::var::v22.0 8410 |
|---|
| 89 | |
|---|
| 90 | # E.g. "fcm list -r v22.0 fcm:var" is now the same as |
|---|
| 91 | # "fcm list -r 8410 fcm:var". |
|---|
| 92 | </pre> |
|---|
| 93 | </dd> |
|---|
| 94 | |
|---|
| 95 | <dt>SET::URL_BROWSER_MAPPING_DEFAULT::<key></dt> |
|---|
| 96 | |
|---|
| 97 | <dd> |
|---|
| 98 | <p>These declarations are used to change the global default for mapping a |
|---|
| 99 | version control system URL to its corresponding web browser URL. |
|---|
| 100 | <key> can be LOCATION_COMPONENT_PATTERN, BROWSER_URL_TEMPLATE or |
|---|
| 101 | BROWSER_REV_TEMPLATE.</p> |
|---|
| 102 | |
|---|
| 103 | <p>Example:</p> |
|---|
| 104 | <pre> |
|---|
| 105 | set::url_browser_mapping_default::location_component_pattern ^//([^/]+)/(.*)$ |
|---|
| 106 | set::url_browser_mapping_default::browser_url_template http://{1}/intertrac/source:{2}{3} |
|---|
| 107 | set::url_browser_mapping_default::browser_rev_template @{1} |
|---|
| 108 | </pre> |
|---|
| 109 | </dd> |
|---|
| 110 | |
|---|
| 111 | <dt>SET::URL_BROWSER_MAPPING::<pck>::<key></dt> |
|---|
| 112 | |
|---|
| 113 | <dd> |
|---|
| 114 | <p>Similar to SET::URL_BROWSER_MAPPING_DEFAULT::<key>, but settings |
|---|
| 115 | only apply to the specified <pck>.</p> |
|---|
| 116 | |
|---|
| 117 | <p>Example:</p> |
|---|
| 118 | <pre> |
|---|
| 119 | set::url_browser_mapping::var::location_component_pattern ^//([^/]+)/(.*)$ |
|---|
| 120 | set::url_browser_mapping::var::browser_url_template http://{1}/intertrac/source:{2}{3} |
|---|
| 121 | set::url_browser_mapping::var::browser_rev_template @{1} |
|---|
| 122 | </pre> |
|---|
| 123 | </dd> |
|---|
| 124 | |
|---|
| 125 | <dt>SET::MISC::WEB_BROWSER</dt> |
|---|
| 126 | |
|---|
| 127 | <dd> |
|---|
| 128 | <p>This declares a default web browser that can be used by some FCM |
|---|
| 129 | commands to browse files and documents online. The default is |
|---|
| 130 | <samp>firefox</samp>.</p> |
|---|
| 131 | |
|---|
| 132 | <p>Example:</p> |
|---|
| 133 | <pre> |
|---|
| 134 | # Use Netscape instead of Firefox |
|---|
| 135 | set::misc::web_browser netscape |
|---|
| 136 | </pre> |
|---|
| 137 | </dd> |
|---|
| 138 | |
|---|
| 139 | <dt>INC</dt> |
|---|
| 140 | |
|---|
| 141 | <dd> |
|---|
| 142 | <p>This declares the name of a file containing user configuration. The |
|---|
| 143 | lines in the declared file will be included inline.</p> |
|---|
| 144 | |
|---|
| 145 | <p>Example:</p> |
|---|
| 146 | <pre> |
|---|
| 147 | inc ~fred/etc/fcm.cfg |
|---|
| 148 | # ... and then your changes ... |
|---|
| 149 | </pre> |
|---|
| 150 | </dd> |
|---|
| 151 | </dl> |
|---|
| 152 | </body> |
|---|
| 153 | </html> |
|---|
