/usr/share/doc/fcm/user_guide/annex_fcm_cfg.html is in fcm 2017.10.0-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 | <!DOCTYPE html>
<html>
<head>
<title>FCM: User Guide: Annex: Declarations in FCM 1 central/user configuration
file</title>
<meta name="author" content="FCM team" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<link rel="icon" href="../etc/fcm-icon.png" type="image/png" />
<link rel="shortcut icon" href="../etc/fcm-icon.png" type="image/png" />
<link href="../etc/bootstrap/css/bootstrap.min.css" rel="stylesheet" media="screen" />
<link href="../etc/fcm.css" rel="stylesheet" media="screen" />
</head>
<body>
<div class="navbar navbar-inverse">
<div class="container-fluid">
<div class="navbar-header">
<a class="navbar-brand" href=".."><span class="fcm-version">FCM</span></a>
</div>
<div class="collapse navbar-collapse">
<ul class="nav navbar-nav">
<li><a href="../installation/">Installation</a></li>
<li><a class="active" href="#">User Guide</a></li>
</ul>
</div>
</div>
</div>
<div class="page-header">
<div class="fcm-page-content pull-right well well-sm"></div>
<h1>FCM: User Guide: Annex: Declarations in FCM 1 central/user configuration
file</h1>
</div>
<div class="container">
<div class="row">
<div class="col-md-12">
<p>The deprecated FCM 1 commands, i.e. <code><a href=
"command_ref.html#fcm-build">fcm build</a></code>, <code><a href=
"command_ref.html#fcm-cmp-ext-cfg">fcm cmp-ext-cfg</a></code> and
<code><a href="command_ref.html#fcm-extract">fcm extract</a></code>, can
modify their settings using the central and user configuration files at:</p>
<ul>
<li><samp>$FCM/etc/fcm.cfg</samp> where <var>$FCM/bin/</var> is the path at
which <code>fcm</code> is installed.</li>
<li><samp>$HOME/.fcm</samp>.</li>
</ul>
<p>Note:</p>
<ul>
<li>The detail of the above settings will remain undocumented. For further
information, please refer to the Perl module <code>FCM1::Config</code>,
which should be located at <samp>lib/FCM1/Config.pm</samp> in your FCM
distribution.</li>
<li>Setting labels in both files are case insensitive.</li>
</ul>
<p>The following deprecated settings related to FCM keywords will no longer
work in <samp>$FCM/etc/fcm.cfg</samp> but will continue to work in
<samp>$HOME/.fcm</samp>. However, it would be desirable to migrate these
settings to their equivalents in <samp>$HOME/.metomi/fcm/keyword.cfg</samp>
as documented in <a href="annex_cfg.html#keyword">Annex: FCM Configuration
File > FCM Keyword Configuration</a>.</p>
<dl>
<dt>SET::URL::<pck><br />
SET::REPOS::<pck></dt>
<dd>
<p><samp>$HOME/.metomi/fcm/keyword.cfg</samp> equivalent: <code><a href=
"annex_cfg.html#keyword.location">location</a></code> or <code><a href=
"annex_cfg.html#keyword.location">location{primary}</a></code>.</p>
<p>This declares a URL keyword for the package <pck>. The value of
the declaration must be a valid Subversion <URL>. Once declared,
the URL keyword <pck> will be associated with the specified URL. In
subsequent invocations of the <code>fcm</code> command, the following
expansion may take place:</p>
<ul>
<li><samp>fcm:<pck></samp>: replaced by
<samp><URL></samp>.</li>
<li><samp>fcm:<pck>_tr</samp> or <samp>fcm:<pck>-tr</samp>:
replaced by <samp><URL>/trunk</samp></li>
<li><samp>fcm:<pck>_br</samp> or <samp>fcm:<pck>-br</samp>:
replaced by <samp><URL>/branches</samp></li>
<li><samp>fcm:<pck>_tg</samp> or <samp>fcm:<pck>-tg</samp>:
replaced by <samp><URL>/tags</samp></li>
</ul>
<p>Example:</p>
<pre>
# Associate "var" with "svn://server/VAR_svn/var"
set::url::var svn://server/VAR_svn/var
# "fcm:var" is now the same as "svn://server/VAR_svn/var"
</pre>
</dd>
<dt>SET::REVISION::<pck>::<keyword></dt>
<dd>
<p><samp>$HOME/.metomi/fcm/keyword.cfg</samp> equivalent: <code><a href=
"annex_cfg.html#keyword.revision">revision</a></code>.</p>
<p>This declares <keyword> to be the revision number for the
package <pck>. The <keyword> string can contain any
characters except spaces. It must not contain only digits (as digits are
treated as revision numbers). It must not be the Subversion revision
keywords HEAD, BASE, COMMITTED and PREV. It cannot begin and end with a
pair of curly brackets (as this will be parsed as a revision date). The
package <pck> must be associated with a URL using the
SET::URL::<pck> declaration described above before this declaration
can make sense. Once defined, <keyword> can be used anywhere in
place the defined revision number.</p>
<p>Example:</p>
<pre>
set::revision::var::v22.0 8410
# E.g. "fcm list -r v22.0 fcm:var" is now the same as
# "fcm list -r 8410 fcm:var".
</pre>
</dd>
<dt>SET::URL_BROWSER_MAPPING_DEFAULT::<key></dt>
<dd>
<p><samp>$HOME/.metomi/fcm/keyword.cfg</samp> equivalent: <code><a href=
"annex_cfg.html#keyword.browser.comp-pat">browser.comp-pat</a></code>,
<code><a href=
"annex_cfg.html#keyword.browser.loc-tmpl">browser.loc-tmpl</a></code>,
and <code><a href=
"annex_cfg.html#keyword.browser.rev-tmpl">browser.rev-tmpl</a></code>.</p>
<p>These declarations are used to change the global default for mapping a
version control system URL to its corresponding web browser URL.
<key> can be LOCATION_COMPONENT_PATTERN, BROWSER_URL_TEMPLATE or
BROWSER_REV_TEMPLATE.</p>
<p>Example:</p>
<pre>
set::url_browser_mapping_default::location_component_pattern ^//([^/]+)/(.*)$
set::url_browser_mapping_default::browser_url_template http://{1}/intertrac/source:{2}{3}
set::url_browser_mapping_default::browser_rev_template @{1}
</pre>
</dd>
<dt>SET::URL_BROWSER_MAPPING::<pck>::<key></dt>
<dd>
<p><samp>$HOME/.metomi/fcm/keyword.cfg</samp> equivalent: <code><a href=
"annex_cfg.html#keyword.browser.comp-pat">browser.comp-pat</a></code>,
<code><a href=
"annex_cfg.html#keyword.browser.loc-tmpl">browser.loc-tmpl</a></code>,
and <code><a href=
"annex_cfg.html#keyword.browser.rev-tmpl">browser.rev-tmpl</a></code>.</p>
<p>Similar to SET::URL_BROWSER_MAPPING_DEFAULT::<key>, but settings
only apply to the specified <pck>.</p>
<p>Example:</p>
<pre>
set::url_browser_mapping::var::location_component_pattern ^//([^/]+)/(.*)$
set::url_browser_mapping::var::browser_url_template http://{1}/intertrac/source:{2}{3}
set::url_browser_mapping::var::browser_rev_template @{1}
</pre>
</dd>
</dl>
</div>
</div>
</div>
<hr/>
<div class="container-fluid text-center">
<div class="row"><div class="col-md-12">
<address><small>
© British Crown Copyright 2006-16
<a href="http://www.metoffice.gov.uk">Met Office</a>.
See <a href="../etc/fcm-terms-of-use.html">Terms of Use</a>.<br />
This document is released under the British <a href=
"http://www.nationalarchives.gov.uk/doc/open-government-licence/" rel=
"license">Open Government Licence</a>.<br />
</small></address>
</div></div>
</div>
<script type="text/javascript" src="../etc/jquery.min.js"></script>
<script type="text/javascript" src="../etc/bootstrap/js/bootstrap.min.js"></script>
<script type="text/javascript" src="../etc/fcm.js"></script>
<script type="text/javascript" src="../etc/fcm-version.js"></script>
</body>
</html>
|