source: LMDZ5/trunk/tools/fcm/doc/user_guide/index.html @ 3871

Last change on this file since 3871 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: 13.7 KB
RevLine 
[1578]1<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2
3<html>
4<head>
5  <title>FCM System User Guide</title>
6  <meta name="author" content="FCM development team">
7  <meta name="descriptions" content="FCM User Guide">
8  <meta name="keywords" content="FCM, user guide">
9  <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
10  <link rel="stylesheet" type="text/css" href="style.css">
11</head>
12
13<body>
14  <p align="right"><img src="logo.png" alt="Met Office logo" width="85" height=
15  "85"></p>
16
17  <h1>FCM System<br>
18  User Guide</h1>
19
20  <p align="center">Release: 1.2</p>
21
22  <p align="center">Last updated: 22 March 2007</p>
23
24  <p align="center">Met Office<br>
25  FitzRoy Road, Exeter<br>
26  Devon, EX1 3PB<br>
27  United Kingdom</p>
28
29  <p align="center">&copy; Crown copyright 2005-7. All rights reserved.</p>
30
31  <p align="center">Questions regarding this document or permissions to quote
32  from it should be directed to the <a href=
33  "mailto:iprmanager@metoffice.gov.uk">IPR Manager</a>.</p>
34 
35  <script type="text/javascript">
36  <!--
37  var out = 'For printing, please use the '
38  out    += '<a href="fcm-user-guide.pdf">PDF<\/a> version of the document.'
39  document.write ('<p align="center">')
40  document.write (out)
41  document.write ('<\/p>')
42  //-->
43  </script>
44
45  <h2 align="center">Contents</h2>
46
47  <ol>
48    <li><a href="introduction.html">Introduction</a></li>
49
50    <li><a href="overview.html">System Overview</a></li>
51
52    <li>
53      <a href="getting_started.html">Getting Started</a>
54
55      <ul>
56        <li><a href="getting_started.html#setup">How to set yourself up to run
57        FCM</a></li>
58
59        <li><a href="getting_started.html#tutorial">Tutorial</a></li>
60      </ul>
61    </li>
62
63    <li>
64      <a href="code_management.html">Code Management System</a>
65
66      <ul>
67        <li>
68          <a href="code_management.html#svn">Using Subversion</a>
69
70          <ul>
71            <li><a href="code_management.html#svn_concepts">Basic
72            Concepts</a></li>
73
74            <li>
75              <a href="code_management.html#svn_basic">Basic Command Line
76              Usage</a>
77
78              <ul>
79                <li><a href=
80                "code_management.html#svn_basic_keywords">URL &amp;
81                Revision Keywords</a></li>
82
83                <li><a href="code_management.html#svn_basic_diff">Examining
84                Changes</a></li>
85
86                <li><a href=
87                "code_management.html#svn_basic_conflicts">Resolving
88                Conflicts</a></li>
89
90                <li><a href="code_management.html#svn_basic_check">Adding and
91                Removing Files</a></li>
92
93                <li><a href="code_management.html#svn_basic_commit">Committing
94                Changes</a></li>
95              </ul>
96            </li>
97
98            <li>
99              <a href="code_management.html#svn_branching">Branching &amp;
100              Merging</a>
101
102              <ul>
103                <li><a href=
104                "code_management.html#svn_branching_create">Creating
105                Branches</a></li>
106
107                <li><a href="code_management.html#svn_branching_list">Listing
108                Branches Created by You or Other Users</a></li>
109
110                <li><a href="code_management.html#svn_branching_info">Getting
111                Information About Branches</a></li>
112
113                <li><a href=
114                "code_management.html#svn_branching_switch">Switching your
115                working copy to point to another branch</a></li>
116
117                <li><a href=
118                "code_management.html#svn_branching_delete">Deleting
119                Branches</a></li>
120
121                <li><a href=
122                "code_management.html#svn_branching_merge">Merging</a></li>
123              </ul>
124            </li>
125
126            <li>
127              <a href="code_management.html#svn_gui">Using the GUI</a>
128
129              <ul>
130                <li><a href="code_management.html#svn_gui_start">Starting the
131                GUI</a></li>
132
133                <li><a href="code_management.html#svn_gui_commands">GUI
134                Commands</a></li>
135
136                <li><a href="code_management.html#svn_gui_konqueror">Accessing
137                the GUI from Konqueror</a></li>
138              </ul>
139            </li>
140
141            <li><a href="code_management.html#svn_problems">Known Problems with
142            Subversion</a></li>
143          </ul>
144        </li>
145
146        <li>
147          <a href="code_management.html#trac">Using Trac</a>
148
149          <ul>
150            <li><a href="code_management.html#trac_login">Logging In</a></li>
151
152            <li><a href="code_management.html#trac_wiki">Using the Wiki
153            Pages</a></li>
154
155            <li><a href="code_management.html#trac_browser">Using the
156            Repository Browser</a></li>
157
158            <li><a href="code_management.html#trac_tickets">Using the Issue
159            Tracker</a></li>
160
161            <li><a href="code_management.html#trac_roadmap">Using the
162            Roadmap</a></li>
163
164            <li><a href="code_management.html#trac_timeline">Using the
165            Timeline</a></li>
166          </ul>
167        </li>
168      </ul>
169    </li>
170
171    <li>
172      <a href="working_practices.html">Code Management Working Practices</a>
173
174      <ul>
175        <li><a href="working_practices.html#changes">Making Changes</a></li>
176
177        <li><a href="working_practices.html#wc">Working Copies</a></li>
178
179        <li>
180          <a href="working_practices.html#branching">Branching &amp;
181          Merging</a>
182
183          <ul>
184            <li><a href="working_practices.html#branching_when">When to
185            Branch</a></li>
186
187            <li><a href="working_practices.html#branching_where">Where to
188            Branch From</a></li>
189
190            <li><a href="working_practices.html#branching_update">Merging From
191            the Trunk</a></li>
192
193            <li><a href="working_practices.html#branching_commit">Merging Back
194            to the Trunk</a></li>
195
196            <li><a href="working_practices.html#branching_delete">When to
197            Delete Branches</a></li>
198          </ul>
199        </li>
200
201        <li><a href="working_practices.html#binary">Working with Binary Files</a>
202
203          <ul>
204            <li><a href="working_practices.html#binary_conflicts">Resolving
205            Conflicts in Binary Files</a></li>
206
207            <li><a href="working_practices.html#binary_locking">Using
208            Locking</a></li>
209          </ul>
210        </li>
211
212        <li><a href="working_practices.html#messages">Commit Log
213        Messages</a></li>
214
215        <li>
216          <a href="working_practices.html#tickets">Trac Tickets</a>
217
218          <ul>
219            <li><a href="working_practices.html#tickets_create">Creating
220            Tickets</a></li>
221
222            <li><a href="working_practices.html#tickets_use">Using
223            Tickets</a></li>
224          </ul>
225        </li>
226
227        <li><a href="working_practices.html#packages">Creating
228        Packages</a></li>
229
230        <li><a href="working_practices.html#releases">Preparing System
231        Releases</a></li>
232
233        <li><a href="working_practices.html#rapid">Rapid vs Staged Development
234        Practises</a></li>
235      </ul>
236    </li>
237
238    <li>
239      <a href="extract.html">The Extract System</a>
240
241      <ul>
242        <li><a href="extract.html#command">The Extract Command</a></li>
243
244        <li>
245          <a href="extract.html#simple">Simple Usage</a>
246
247          <ul>
248            <li><a href="extract.html#simple_local">Extract from a local
249            path</a></li>
250
251            <li><a href="extract.html#simple_url">Extract from a Subversion
252            URL</a></li>
253
254            <li><a href="extract.html#simple_mirror">Mirror code to a remote
255            machine</a></li>
256          </ul>
257        </li>
258
259        <li>
260          <a href="extract.html#advanced">Advanced Usage</a>
261
262          <ul>
263            <li><a href="extract.html#advanced_multi">Extract from multiple
264            repositories</a></li>
265
266            <li><a href="extract.html#advanced_branches">Extract from multiple
267            branches</a></li>
268
269            <li><a href="extract.html#advanced_incremental">Incremental extract
270            based on a previous extraction</a></li>
271
272            <li><a href="extract.html#advanced_build">Extract - Build
273            Configuration</a></li>
274          </ul>
275        </li>
276
277        <li><a href="extract.html#verbose">Diagnostic verbose level</a></li>
278
279        <li><a href="extract.html#nosvn">When Subversion Is Not
280        Available</a></li>
281      </ul>
282    </li>
283
284    <li>
285      <a href="build.html">The Build System</a>
286
287      <ul>
288        <li><a href="build.html#command">The Build Command</a></li>
289
290        <li>
291          <a href="build.html#basic">Basic Features</a>
292
293          <ul>
294            <li><a href="build.html#basic_build">Basic build
295            configuration</a></li>
296
297            <li><a href="build.html#basic_extract">Build configuration via the
298            extract system</a></li>
299
300            <li><a href="build.html#basic_exename">Naming of executables</a></li>
301
302            <li><a href="build.html#basic_flags">Setting the compiler
303            flags</a></li>
304
305            <li><a href="build.html#basic_interface">Automatic Fortran 9X
306            interface block</a></li>
307
308            <li><a href="build.html#basic_dependency">Automatic
309            dependency</a></li>
310          </ul>
311        </li>
312
313        <li>
314          <a href="build.html#advanced">Advanced Features</a>
315
316          <ul>
317            <li><a href="build.html#advanced_dependency">Further dependency
318            features</a></li>
319
320            <li><a href="build.html#advanced_blockdata">Linking a Fortran
321            executable with a BLOCKDATA program unit</a></li>
322
323            <li><a href="build.html#advanced_library">Creating library
324            archives</a></li>
325
326            <li><a href="build.html#advanced_pp">Pre-processing</a></li>
327
328            <li><a href="build.html#advanced_file-type">File type</a></li>
329
330            <li><a href="build.html#advanced_incremental">Incremental build
331            based on a pre-compiled build</a></li>
332
333            <li><a href="build.html#advanced_pckcfg">Using a package
334            configuration file</a></li>
335
336            <li><a href="build.html#advanced_data">Building data files</a></li>
337          </ul>
338        </li>
339
340        <li><a href="build.html#verbose">Diagnostic verbose level</a></li>
341
342        <li><a href="build.html#overview">Overview of the build
343        process</a></li>
344      </ul>
345    </li>
346
347    <li>
348      <a href="system_admin.html">System Administration</a>
349
350      <ul>
351        <li>
352          <a href="system_admin.html#svn">Subversion</a>
353
354          <ul>
355            <li><a href="system_admin.html#svn_design">Repository
356            design</a></li>
357
358            <li><a href="system_admin.html#svn_create">Creating a
359            repository</a></li>
360
361            <li><a href="system_admin.html#svn_access">Access control</a></li>
362
363            <li><a href="system_admin.html#svn_hosting">Repository
364            hosting</a></li>
365
366            <li><a href="system_admin.html#svn_watch">Watching changes in log
367            messages</a></li>
368          </ul>
369        </li>
370
371        <li>
372          <a href="system_admin.html#trac">Trac</a>
373
374          <ul>
375            <li><a href="system_admin.html#trac_config">Trac
376            configuration</a></li>
377
378            <li><a href="system_admin.html#trac_hosting">Trac hosting</a></li>
379          </ul>
380        </li>
381
382        <li><a href="system_admin.html#fcm-keywords">FCM keywords</a></li>
383
384        <li><a href="system_admin.html#ext-bld-cfg">Extract and build
385        configuration</a></li>
386
387        <li><a href="system_admin.html#alternate_versions">Maintaining
388        alternate versions of namelists and data files</a></li>
389
390        <li><a href="system_admin.html#work-practise">Defining working
391        practises and policies</a></li>
392
393      </ul>
394    </li>
395
396    <li>
397      <a href="command_ref.html">FCM Command Reference</a>
398
399      <ul>
400        <li><a href="command_ref.html#fcm_config">fcm Configuration
401        File</a></li>
402
403        <li><a href="command_ref.html#fcm_bld">fcm build</a></li>
404
405        <li><a href="command_ref.html#fcm_ext">fcm extract</a></li>
406
407        <li><a href="command_ref.html#fcm_cmp-ext-cfg">fcm cmp-ext-cfg</a></li>
408
409        <li><a href="command_ref.html#fcm_gui">fcm gui</a></li>
410
411        <li>
412          <a href="command_ref.html#fcm_svn">fcm Subversion Subcommands</a>
413
414          <ul>
415            <li><a href="command_ref.html#fcm_svn_add">fcm add</a></li>
416
417            <li><a href="command_ref.html#fcm_svn_br">fcm branch</a></li>
418
419            <li><a href="command_ref.html#fcm_svn_ci">fcm commit</a></li>
420
421            <li><a href="command_ref.html#fcm_svn_cf">fcm conflicts</a></li>
422
423            <li><a href="command_ref.html#fcm_svn_rm">fcm delete</a></li>
424
425            <li><a href="command_ref.html#fcm_svn_diff">fcm diff</a></li>
426
427            <li><a href="command_ref.html#fcm_svn_merge">fcm merge</a></li>
428
429            <li><a href="command_ref.html#fcm_svn_mkpatch">fcm mkpatch</a></li>
430
431            <li><a href="command_ref.html#fcm_svn_switch">fcm switch</a></li>
432
433            <li><a href="command_ref.html#fcm_svn_trac">fcm trac</a></li>
434
435            <li><a href="command_ref.html#fcm_svn_other">Other Subversion
436            Commands</a></li>
437          </ul>
438        </li>
439      </ul>
440    </li>
441
442    <li><a href="further_info.html">Further Information</a></li>
443  </ol>
444
445  <p>Annex:</p>
446
447  <ul>
448    <li><a href="annex_quick_ref.html">Quick reference</a></li>
449
450    <li><a href="annex_fcm_cfg.html">Declarations in FCM central/user
451    configuration file</a></li>
452
453    <li><a href="annex_ext_cfg.html">Declarations in FCM extract configuration
454    file</a></li>
455
456    <li><a href="annex_bld_cfg.html">Declarations in FCM build configuration
457    file</a></li>
458
459    <li><a href="annex_pck_cfg.html">Declarations in FCM build package
460    configuration file</a></li>
461  </ul>
462 
463  <script type="text/javascript" src="maintain.js"></script>
464</body>
465</html>
Note: See TracBrowser for help on using the repository browser.