source: codes/icosagcm/branches/SATURN_DYNAMICO/ICOSAGCM/tools/FCM/doc/user_guide/annex_fcm_cfg.html @ 225

Last change on this file since 225 was 225, checked in by ymipsl, 10 years ago
File size: 4.3 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::REPOS::&lt;pck&gt;</th>
36
37      <th>Description</th>
38
39      <td>This declares a URL keyword for the package &lt;pck&gt;. The value
40      of the declaration must be a valid Subversion URL. Once declared, the
41      URL keyword &lt;pck&gt; will be associated with the specified URL. In
42      subsequent invocations of the "fcm" command, the string
43      "fcm:&lt;pck&gt;" will be replaced by the URL.</td>
44    </tr>
45
46    <tr>
47      <th>Example</th>
48
49      <td>
50        <pre>
51# Associate "var" with "svn://server/VAR_svn/var"
52set::repos::var  svn://server/VAR_svn/var
53
54# "fcm:var" is now the same as "svn://server/VAR_svn/var"
55</pre>
56      </td>
57    </tr>
58
59    <tr>
60      <th rowspan="2">SET::REVISION::&lt;pck&gt;::&lt;keyword&gt;</th>
61
62      <th>Description</th>
63
64      <td>This declares &lt;keyword&gt; to be the revision number for the
65      package &lt;pck&gt;. The &lt;keyword&gt; string can contain any
66      characters except spaces. It must not contain only digits (as digits are
67      treated as revision numbers). It must not be the Subversion revision
68      keywords "HEAD", "BASE", "COMMITTED" and "PREV". It cannot begin and end
69      with a pair of curly brackets (as this will be parsed as a revision
70      date). The package &lt;pck&gt; must be associated with a URL using the
71      SET::REPOS::&lt;pck&gt; declaration described above before this
72      declaration can make sense. Once defined, &lt;keyword&gt; can be used
73      anywhere in place the defined revision number.</td>
74    </tr>
75
76    <tr>
77      <th>Example</th>
78
79      <td>
80        <pre>
81set::revision::var::v22.0  8410
82
83# E.g. "fcm list -r v22.0 fcm:var" is now the same as
84#      "fcm list -r 8410 fcm:var".
85</pre>
86      </td>
87    </tr>
88
89    <tr>
90      <th rowspan="2">SET::TRAC::&lt;pck&gt;</th>
91
92      <th>Description</th>
93
94      <td>This declares a Trac browser URL that corresponds to the Subversion
95      URL declared using SET::REPOS::&lt;pck&gt;.</td>
96    </tr>
97
98    <tr>
99      <th>Example</th>
100
101      <td>
102        <pre>
103set::trac::var  http://server/Trac/VAR/browser/VAR
104
105# E.g. "fcm trac fcm:var" will launch the web browser to view above.
106</pre>
107      </td>
108    </tr>
109
110    <tr>
111      <th>Label</th>
112
113      <th colspan="2">Content</th>
114    </tr>
115
116    <tr>
117      <th rowspan="2">SET::MISC::WEB_BROWSER</th>
118
119      <th>Description</th>
120
121      <td>This declares a default web browser that can be used by some FCM
122      commands to browse files and documents online. The default is
123      "firefox".</td>
124    </tr>
125
126    <tr>
127      <th>Example</th>
128
129      <td>
130        <pre>
131# Use Netscape instead of Firefox
132set::misc::web_browser  netscape
133</pre>
134      </td>
135    </tr>
136
137    <tr>
138      <th rowspan="2">INC</th>
139
140      <th>Description</th>
141
142      <td>This declares the name of a file containing user configuration. The
143      lines in the declared file will be included inline.</td>
144    </tr>
145
146    <tr>
147      <th>Example</th>
148
149      <td>
150        <pre>
151inc  ~fred/etc/fcm.cfg
152# ... and then your changes ...
153</pre>
154      </td>
155    </tr>
156
157    <tr>
158      <th>Label</th>
159
160      <th colspan="2">Content</th>
161    </tr>
162  </table>
163
164  <p>N.B. almost all settings in the Fcm::Config module can be modified using
165  the central/user configuration file. However, most users should only ever
166  need to use the above.</p>
167
168  <script type="text/javascript" src="maintain.js">
169  </script>
170</body>
171</html>
Note: See TracBrowser for help on using the repository browser.