source: LMDZ5/trunk/tools/fcm/doc/user_guide/annex_fcm_cfg.html @ 5433

Last change on this file since 5433 was 1578, checked in by jghattas, 13 years ago
  • Add fcm in LMDZ5/tools directory

It is no longer needed to have fcm in your environement PATH variable.
Now makelmdz_fcm takes by default this fcm. It is still possible to use
another fcm, using -fcm_path argument in makelmdz_fcm.
File size: 4.8 KB
Line 
1<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2
3<html>
4<head>
5  <title>FCM System User Guide Annex: Declarations in FCM central/user
6  configuration file</title>
7  <meta name="author" content="FCM development team">
8  <meta name="descriptions" content="User Guide Annex">
9  <meta name="keywords" content="FCM, user guide, annex">
10  <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
11  <link rel="stylesheet" type="text/css" href="style.css">
12</head>
13
14<body>
15  <address>
16    <a href="index.html">FCM System User Guide</a> &gt; Annex: Declarations in
17    FCM central/user configuration file
18  </address>
19
20  <h1>Annex:<br>
21  Declarations in FCM central/user configuration file</h1>
22
23  <p>Please note that setting labels in both the central and the user
24  configuration files are case insensitive.</p>
25
26  <table class="pad" summary="Declarations in FCM configuration file"
27  width="100%" border="1">
28    <tr>
29      <th>Label</th>
30
31      <th colspan="2">Content</th>
32    </tr>
33
34    <tr>
35      <th rowspan="2">SET::URL::&lt;pck&gt;<br>
36      <span class="gray">SET::REPOS::&lt;pck&gt;</span>
37      </th>
38
39      <th>Description</th>
40
41      <td>This declares a URL keyword for the package &lt;pck&gt;. The value of
42      the declaration must be a valid Subversion &lt;URL&gt;. Once declared, the
43      URL keyword &lt;pck&gt; will be associated with the specified URL. In
44      subsequent invocations of the "fcm" command, the following expansion may
45      take place:
46
47        <ul>
48          <li>"fcm:&lt;pck&gt;": replaced by "&lt;URL&gt;".</li>
49
50          <li>"fcm:&lt;pck&gt;_tr" or "fcm:&lt;pck&gt;-tr": replaced by
51          "&lt;URL&gt;/trunk"
52
53          <li>"fcm:&lt;pck&gt;_br" or "fcm:&lt;pck&gt;-br": replaced by
54          "&lt;URL&gt;/branches"
55
56          <li>"fcm:&lt;pck&gt;_tg" or "fcm:&lt;pck&gt;-tg": replaced by
57          "&lt;URL&gt;/tags"
58        </ul>
59      </td>
60    </tr>
61
62    <tr>
63      <th>Example</th>
64
65      <td>
66        <pre>
67# Associate "var" with "svn://server/VAR_svn/var"
68set::url::var  svn://server/VAR_svn/var
69
70# "fcm:var" is now the same as "svn://server/VAR_svn/var"
71</pre>
72      </td>
73    </tr>
74
75    <tr>
76      <th rowspan="2">SET::REVISION::&lt;pck&gt;::&lt;keyword&gt;</th>
77
78      <th>Description</th>
79
80      <td>This declares &lt;keyword&gt; to be the revision number for the
81      package &lt;pck&gt;. The &lt;keyword&gt; string can contain any
82      characters except spaces. It must not contain only digits (as digits are
83      treated as revision numbers). It must not be the Subversion revision
84      keywords "HEAD", "BASE", "COMMITTED" and "PREV". It cannot begin and end
85      with a pair of curly brackets (as this will be parsed as a revision
86      date). The package &lt;pck&gt; must be associated with a URL using the
87      SET::URL::&lt;pck&gt; declaration described above before this
88      declaration can make sense. Once defined, &lt;keyword&gt; can be used
89      anywhere in place the defined revision number.</td>
90    </tr>
91
92    <tr>
93      <th>Example</th>
94
95      <td>
96        <pre>
97set::revision::var::v22.0  8410
98
99# E.g. "fcm list -r v22.0 fcm:var" is now the same as
100#      "fcm list -r 8410 fcm:var".
101</pre>
102      </td>
103    </tr>
104
105    <tr>
106      <th rowspan="2">SET::TRAC::&lt;pck&gt;</th>
107
108      <th>Description</th>
109
110      <td>This declares a Trac browser URL that corresponds to the Subversion
111      URL declared using SET::URL::&lt;pck&gt;.</td>
112    </tr>
113
114    <tr>
115      <th>Example</th>
116
117      <td>
118        <pre>
119set::trac::var  http://server/Trac/VAR/browser/VAR
120
121# E.g. "fcm trac fcm:var" will launch the web browser to view above.
122</pre>
123      </td>
124    </tr>
125
126    <tr>
127      <th>Label</th>
128
129      <th colspan="2">Content</th>
130    </tr>
131
132    <tr>
133      <th rowspan="2">SET::MISC::WEB_BROWSER</th>
134
135      <th>Description</th>
136
137      <td>This declares a default web browser that can be used by some FCM
138      commands to browse files and documents online. The default is
139      "firefox".</td>
140    </tr>
141
142    <tr>
143      <th>Example</th>
144
145      <td>
146        <pre>
147# Use Netscape instead of Firefox
148set::misc::web_browser  netscape
149</pre>
150      </td>
151    </tr>
152
153    <tr>
154      <th rowspan="2">INC</th>
155
156      <th>Description</th>
157
158      <td>This declares the name of a file containing user configuration. The
159      lines in the declared file will be included inline.</td>
160    </tr>
161
162    <tr>
163      <th>Example</th>
164
165      <td>
166        <pre>
167inc  ~fred/etc/fcm.cfg
168# ... and then your changes ...
169</pre>
170      </td>
171    </tr>
172
173    <tr>
174      <th>Label</th>
175
176      <th colspan="2">Content</th>
177    </tr>
178  </table>
179
180  <p>N.B. almost all settings in the Fcm::Config module can be modified using
181  the central/user configuration file. However, most users should only ever
182  need to use the above.</p>
183
184  <script type="text/javascript" src="maintain.js">
185  </script>
186</body>
187</html>
Note: See TracBrowser for help on using the repository browser.