/usr/share/doc/fcm/user_guide/annex_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 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 | <!DOCTYPE html>
<html>
<head>
<title>FCM: User Guide: Annex: FCM 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: FCM Configuration File</h1>
</div>
<div class="container">
<div class="row">
<div class="col-md-12">
<h2 id="syntax">Syntax</h2>
<h3 id="syntax.comment">Syntax: comment</h3>
<p>An empty line, a line with only space characters and a line beginning with
a <kbd>#</kbd> character is a comment line. For example:</p>
<pre>
# This is a comment.
# This is also a comment.
</pre>
<p>Also, if a line contains a space character followed by a <kbd>#</kbd>
character then this, and any following characters, are treated as an end of
line comment and are ignored.</p>
<h3 id="syntax.declaration">Syntax: declaration</h3>
<p>The general syntax of a declaration consists of a label, a set of
modifiers, a list of name-spaces, and a value:</p>
<pre>
label{mod:mod-value}[ns] = value
label{mod:mod-value} = value
label[ns] = value
label = value
label = value\
value # "value value"
label = value\
\value # "valuevalue"
</pre>
<p>The label is compulsory. It defines the declaration, and may have one or
more characters in the alpha-numeric, the underscore, the minus sign and the
full stop. The label cannot be substituted with a variable.</p>
<p>The modifier is an optional part of the syntax, but may be a compulsory
part of some declarations. The modifiers are embedded between a pair of curly
braces and must come after the label, but before the name-spaces and the
equal sign. It should be a comma-separated list of colon-separated key-value
pairs, (i.e. <kbd>{key1: value1, key2: value2, ...}</kbd>). The value in each
modifier is optional - if a key is set without a value, its value is assumed
to be 1. The contents of the modifiers can be substituted using a
variable.</p>
<p>The name-space is an optional part of the syntax, but may be a compulsory
part of some declarations. The name-spaces are embedded between a pair of
square braces and must come after the label and/or modifiers but before the
equal sign. It should be a space-separated list of names. If a name contains
space, the space character can be escaped using a backslash character or the
name can be quoted. The contents of the name-spaces can be substituted using
a variable.</p>
<p>The first non-space character after the equal sign begins the value of the
declaration. If there is nothing after the equal sign, the value is an empty
string. The contents of the value can be substituted using a variable.
Trailing space characters are ignored. The end of line can be escaped using a
backslash, and the value of the declaration will continue from the next
non-comment line. If the first non-space character on that line is a
backslash then the line contents up to and including that backslash are
ignored.</p>
<h3 id="syntax.variable">Syntax: variable</h3>
<p>A variable is used to substitute commonly used values in a declaration. It
can refer to an environment variable or can be defined locally using the
syntax:</p>
<pre>
$var = value # Sets "var" variable to "value"
$var{?} = value # Sets "var" variable to "value" only if "var" is not defined
# E.g.:
$projects = foo bar baz
$long_path = src/path/is/very/very/very/long
$UMDIR{?} = /projects/um1
# time passes...
extract.ns = $projects
extract.path-excl[$projects egg ham] = doc man ${long_path}_longer
build.prop{cc.defs} = foo=\$foo # escape substitution
</pre>
<p>The name of a variable must begin with an alphabet or an underscore and
followed by 0 or more alpha-numeric or underscore characters, (i.e. it must
match this regular expression: <var>^[A-Za-z_][A-Za-z0-9_]*$</var>).</p>
<p>Locally defined variables only apply in the context of the configuration
file and are not passed down, for instance, to the compiler. If there is an
environment variable with the same identifier, its value is normally
overridden (within the context of the configuration file) by any local
setting. However, if a <kbd>?</kbd> modifier is given, it assigns the value
to the variable only if the variable is not already defined (either as an
environment variable or locally). Substitution can be escaped using a
backslash character in front of the dollar sign. Any attempt to reference an
undefined variable will trigger an exception.</p>
<p>Note: <var>$HERE</var> is a reserved variable to indicate the parent
directory of the current configuration file. (The system ignores the $HERE
environment variable, if there is one.) Any attempt to assign a value to
<var>$HERE</var> will trigger an exception.</p>
<h3 id="syntax.include">Syntax: include</h3>
<p>An <code>include</code> declaration specifies the logical locations of a
list of configuration files, where contents are to be included inline:</p>
<pre>
include{type:type} = location ...
# E.g.:
include = fcm:foo/path/to/config/file
include = svn://server/path/to/config/file@1234
include{type:svn} = http://server/path/to/config/file
include = /path/to/config/file $HERE/another-config-file
include = $HERE/another-config-file
include = ~/path/to/config/file ~fred/path/to/config/file
</pre>
<p>If the value of an <code>include</code> declaration is a relative path,
the system will search the directory containing the current configuration
file for the include file. More include search paths can be specified using
the <code>include-path</code> declaration. E.g.:</p>
<pre>
# Define or replace include search paths
include-path=/path/to/some/cfg /path/to/more/cfg
# Append to include search paths
include-path{+}=host2:/path/to/cfg
include-path{type:svn,+}=https://host1/path/to/cfg
# ... Include files can now be relative paths
include=foo.cfg bar.cfg
</pre>
<p>Some commands, e.g. <code>fcm make</code>, accept one or more
<code>--config-file-path=PATH</code> command line option, which can be used
to pre-define the include search paths when they read their configuration
files.</p>
<p>Currently, the location can be a path in the file system, a Subversion URL,
a FCM keyword pointing to a Subversion URL, or a location in the file system
of a remote host accessible via passphrase-less SSH. The system will attempt
to make an intelligent guess of the location type. To allow for future
expansion, both the <code>include</code> and the <code>include-path</code>
declarations accept a <var>type:TYPE</var> modifier (where TYPE can currently
be <samp>fs</samp> for a file system path or <samp>svn</samp> for a Subversion
location) to allow the location type to be defined where it is ambiguous.</p>
<h2 id="keyword">FCM Keyword Configuration</h2>
<p>The keyword configuration files are mainly used to define FCM location
keywords and related settings. The <code>fcm</code> command searches for
keyword configuration files from the following locations:</p>
<ol>
<li><dfn>(Deprecated)</dfn> <samp>$HOME/.fcm</samp> - expects FCM 1
configuration file format. See <a href="annex_fcm_cfg.html">Annex:
Declarations in FCM 1 central/user configuration file</a> for detail.</li>
<li><samp>$FCM/etc/fcm/keyword.cfg</samp> where <var>$FCM/bin/</var> is the
path at which <code>fcm</code> is installed.</li>
<li><samp>$HOME/.metomi/fcm/keyword.cfg</samp>.</li>
</ol>
<p>The following are declarations recognised by the keyword configuration
files:</p>
<dl>
<dt id="keyword.location">location</dt>
<dd>
<p><dfn>description</dfn>: Associates a namespace with a location, and
allows the use of <samp>fcm:namespace</samp> as a substitute of the
location.</p>
<p><dfn>modifier</dfn>: <var>primary</var>: Optional. If specified, the
location is a primary location, i.e. the system will create the
<samp>_tr</samp>, <samp>_br</samp>, <samp>_tg</samp>, <samp>-tr</samp>,
<samp>-br</samp> and <samp>-tg</samp> keywords for this location.</p>
<p><dfn>modifier</dfn>: <var>type</var>: Optional. Specifies the type of
the location. The system currently supports <samp>svn</samp> for a
Subversion location and <samp>fs</samp> for a file system location. If
not specified, the system will make an intelligent guess based on the
given value.</p>
<p><dfn>namespace</dfn>: The namespace to be associated with the
location.</p>
<p><dfn>value</dfn>: A valid location of a type supported by the
system.</p>
<p><dfn>example</dfn>:</p>
<pre>
location{primary}[var] = svn://fcm5/VAR_svn/VAR
location{primary, type:svn}[egg] = http://chicken/egg
</pre>
</dd>
<dt id="keyword.revision">revision</dt>
<dd>
<p><dfn>description</dfn>: Associates a keyword with a revision of a
location in a version control system.</p>
<p><dfn>namespace</dfn>: The namespace of a location (already defined
using the <code>location</code> declaration), followed by a colon and the
namespace of the revision.</p>
<p><dfn>value</dfn>: A valid revision of the location.</p>
<p><dfn>example</dfn>:</p>
<pre>
revision[um:vn7.5] = 18479
revision[egg:free-range] = 1
</pre>
</dd>
<dt id="keyword.browser.comp-pat">browser.comp-pat</dt>
<dd>
<p><dfn>description</dfn>: Specifies a regular expression to capture
components in the scheme-specific part of a version control system
location (already defined using the <code>location{primary}</code>
declaration). These components can then be used in the
<code>browser.loc-tmpl</code> template string.</p>
<p><dfn>namespace</dfn>: Optional. The namespace of a location. If not
specified, the declaration applies globally.</p>
<p><dfn>value</dfn>: A valid regular expression.</p>
<p><dfn>example</dfn>:</p>
<pre>
browser.comp-pat = (?msx-i:\A // ([^/]+) /+ ([^/]+)_svn /*(.*) \z) # default
browser.comp-pat[egg] = (?msx-i:\A//([^/]+)/(.*)\z)
</pre>
</dd>
<dt id="keyword.browser.loc-tmpl">browser.loc-tmpl</dt>
<dd>
<p><dfn>description</dfn>: Specifies a template string, in which the
components captured by the <code>browser.comp.pat</code> regular
expression are used to fill in the numbered fields. The template should
have one more field than the number of components captured by
<code>browser.comp-pat</code>. The final field is used to place the
revision, which is generated via the <code>browser.rev-tmpl</code>.</p>
<p><dfn>namespace</dfn>: Optional. The namespace of a location. If not
specified, the declaration applies globally.</p>
<p><dfn>value</dfn>: A valid template.</p>
<p><dfn>example</dfn>:</p>
<pre>
browser.loc-tmpl = http://{1}/projects/{2}/intertrac/source:/{3}{4} # default
browser.loc-tmpl[egg] = http://{1}/intertrac/source:/{3}{4}
</pre>
</dd>
<dt id="keyword.browser.rev-tmpl">browser.rev-tmpl</dt>
<dd>
<p><dfn>description</dfn>: Specifies a template string, which should have
a single numbered field for filling in the revision number.</p>
<p><dfn>namespace</dfn>: Optional. The namespace of a location. If not
specified, the declaration applies globally.</p>
<p><dfn>value</dfn>: A valid template.</p>
<p><dfn>example</dfn>:</p>
<pre>
browser.rev-tmpl = @{1} # default
</pre>
</dd>
</dl>
<h2 id="external">FCM External Configuration</h2>
<p>The external configuration files are used to define the name of external
commands used by the FCM system. The <code>fcm</code> command searches for
external configuration files from the following locations:</p>
<ol>
<li><samp>$FCM/etc/fcm/external.cfg</samp> where <var>$FCM/bin/</var> is
the path at which <code>fcm</code> is installed.</li>
<li><samp>$HOME/.metomi/fcm/external.cfg</samp>.</li>
</ol>
<p>The following are declarations recognised by the external configuration
files:</p>
<dl>
<dt id="external.browser">browser</dt>
<dd>
<p><dfn>description</dfn>: Specifies the command to invoke the web
browser. (default=<samp>firefox</samp>)</p>
<p><dfn>example</dfn>:</p>
<pre>
browser = konqueror
</pre>
</dd>
<dt id="external.diff3">diff3</dt>
<dd>
<p><dfn>description</dfn>: The shell command used by the extract system of
FCM Make to perform a 3-way merge. (default=<samp>diff3</samp>)</p>
<p><dfn>example</dfn>:</p>
<pre>
diff3 = diff3
</pre>
</dd>
<dt id="external.diff3.flags">diff3.flags</dt>
<dd>
<p><dfn>description</dfn>: The options used by the 3-way merge shell
command. (default=<samp>-E -m</samp>)</p>
<p><dfn>example</dfn>:</p>
<pre>
diff3.flags = -E -m
</pre>
</dd>
<dt id="external.graphic-diff">graphic-diff</dt>
<dd>
<p><dfn>description</dfn>: Specifies the command to invoke the graphic
diff tool. (default=<samp>xxdiff</samp>)</p>
<p><dfn>example</dfn>:</p>
<pre>
graphic-diff = tkdiff
</pre>
</dd>
<dt id="external.graphic-merge">graphic-merge</dt>
<dd>
<p><dfn>description</dfn>: Specifies the command to invoke the graphic
merge tool. (default=<samp>xxdiff</samp>)</p>
<p><dfn>example</dfn>:</p>
<pre>
graphic-merge = xxdiff
</pre>
</dd>
<dt id="external.ssh">ssh</dt>
<dd>
<p><dfn>description</dfn>: The secure remote shell command to execute
commands on a remote host. (default=<samp>ssh</samp>)</p>
<p><dfn>example</dfn>:</p>
<pre>
ssh = ssh
</pre>
</dd>
<dt id="external.ssh.flags">ssh.flags</dt>
<dd>
<p><dfn>description</dfn>: The options used by the secure shell command to
execute commands on a remote host. (default=<samp>-n
-oBatchMode=yes</samp>)</p>
<p><dfn>example</dfn>:</p>
<pre>
ssh.flags = -n -oBatchMode=yes
</pre>
</dd>
<dt id="external.rsync">rsync</dt>
<dd>
<p><dfn>description</dfn>: The <code>rsync</code> command.
(default=<samp>rsync</samp>)</p>
<p><dfn>example</dfn>:</p>
<pre>
rsync = rsync
</pre>
</dd>
<dt id="external.rsync.flags">rsync.flags</dt>
<dd>
<p><dfn>description</dfn>: The options used by the <code>rsync</code>
command. (default=<samp>-a --exclude=.* --delete-excluded --timeout=900
--rsh=ssh\ -oBatchMode=yes</samp>)</p>
<p><dfn>example</dfn>:</p>
<pre>
rsync.flags = -a --exclude=.* --delete-excluded --timeout=900 --rsh=ssh\ -oBatchMode=yes
</pre>
</dd>
</dl>
<h2 id="make">FCM Make Configuration</h2>
<p>A typical FCM make configuration consists of some top level declarations
to define the make, and specific declarations for each step. The top level
declarations are described below, and the specific declarations for each type
of step will be described in the sub-sections to follow.</p>
<p>Note:</p>
<ul>
<li>Unless stated otherwise, FCM make configuration declarations are
non-cumulative, i.e. if more than one declarations apply to the
<dfn>same</dfn> configuration, the value of the last declaration overrides
those of the earlier ones. E.g.:
<pre>
# Sets the Fortran compiler flags for the root name-space
build.prop{fc.flags} = -O3
# build.prop{fc.flags}[/] = -O3
# Sets the C/Fortran compiler flags for the "foo/bar" name-space
build.prop{cc.flags, fc.flags}[foo/bar] = -g -C
# build.prop{cc.flags}[foo/bar] = -g -C
# build.prop{fc.flags}[/] = -O3
# build.prop{fc.flags}[foo/bar] = -g -C
# Sets the Fortran compiler flags for the root and "foo/bar" name-spaces
build.prop{fc.flags}[/ foo/bar] = -O2
# build.prop{cc.flags}[foo/bar] = -g -C
# build.prop{fc.flags}[/] = -O2
# build.prop{fc.flags}[foo/bar] = -O2
# Sets the Fortran compiler flags for the "foo/bar" name-spaces
build.prop{fc.flags}[foo/bar] = -O1
# build.prop{cc.flags}[foo/bar] = -g -C
# build.prop{fc.flags}[/] = -O2
# build.prop{fc.flags}[foo/bar] = -O1
</pre>
</li>
<li>Unless stated otherwise, declarations are inherited.</li>
<li>The default values of the property settings of each step class (e.g.
<code>build.prop{fc}</code>) can be modified in:
<ol>
<li>The site configuration file <samp>$FCM/etc/fcm/make.cfg</samp>
where <var>$FCM/bin/</var> is the path at which <code>fcm</code> is
installed.</li>
<li>The user configuration file
<samp>$HOME/.metomi/fcm/make.cfg</samp>.</li>
<li><samp>*.prop{class,*}</samp> declarations in the FCM make
configuration file of the current session.</li>
</ol>
<p>The syntax is identical to a normal FCM make configuration file
declaration except that:</p>
<ul>
<li>Only <samp>*.prop{*}</samp> declarations are accepted.</li>
<li>The settings apply to a step class, not an individual step.</li>
<li>Name-space is not allowed.</li>
</ul>
</li>
</ul>
<p>For further details, please refer to the chapter on <a href=
"make.html">FCM Make</a>.</p>
<dl>
<dt id="make.description">description</dt>
<dd>
<p><dfn>description</dfn>: Specifies a description string for the current
make.</p>
<p><dfn>value</dfn>: A string.</p>
<p><dfn>example</dfn>:</p>
<pre>
description = Release 2.71.82
</pre>
</dd>
<dt id="make.dest">dest</dt>
<dd>
<p><dfn>description</dfn>: Specifies the output destination of the make
system. If not specified, the system assumes the output destination to be
the current working directory. This setting is not inherited.</p>
<p><dfn>value</dfn>: A writable directory path.</p>
<p><dfn>example</dfn>:</p>
<pre>
dest = path
# E.g.:
dest = $HERE
</pre>
</dd>
<dt id="make.name">name</dt>
<dd>
<p><dfn>description</dfn>: Specifies the NAME of the make, so that the
command will search for <q>fcm-make<var>NAME</var>.cfg</q> instead of
<q>fcm-make.cfg</q>, and will write context files in
<q>.fcm-make<var>NAME</var>/</q> and log files as
<q>fcm-make<var>NAME</var>.log</q>, etc.</p>
<p><dfn>value</dfn>: A file name friendly string.</p>
<p><dfn>example</dfn>:</p>
<pre>
name = -friend
</pre>
</dd>
<dt id="make.require-version">require-version</dt>
<dd>
<p><dfn>description</dfn>: Specifies the minimum FCM version and
optionally the maximum FCM version that can be used on the current
configuration. If specified, FCM make fails immediately if its version
does not meet the criteria.</p>
<p><dfn>value</dfn>: The minimum version required, and optionally the
maximum version required.</p>
<p><dfn>example</dfn>:</p>
<pre>
# Requires minimum FCM release at 2016.02.0
require-version = 2016.02.0
# Requires minimum FCM release at 2016.02.0, and maximum at 2038.01.0
require-version = 2016.02.0 2038.01.0
</pre>
</dd>
<dt id="make.steps">steps</dt>
<dd>
<p><dfn>description</dfn>: Specifies a list of steps for the make system
to invoke. Each specified step can either be the ID of a known
sub-system, i.e. <samp>extract</samp>, <samp>mirror</samp>,
<samp>preprocess</samp> and <samp>build</samp>, or an ID defined using
the <code>step.class</code> declaration. (See below.)</p>
<p><dfn>value</dfn>: A list of steps for the make system to invoke.</p>
<p><dfn>example</dfn>:</p>
<pre>
steps = id-1 id-2 ...
# E.g.:
steps = extract mirror
</pre>
</dd>
<dt id="make.step.class">step.class</dt>
<dd>
<p><dfn>description</dfn>: Defines custom step IDs. This allows built-in
steps to be renamed, or re-used in multiple steps.</p>
<p><dfn>namespace</dfn>: Specifies the step IDs.</p>
<p><dfn>value</dfn>: An ID of a known sub-system, i.e.
<samp>extract</samp>, <samp>mirror</samp>, <samp>preprocess</samp> and
<samp>build</samp>.</p>
<p><dfn>example</dfn>:</p>
<pre>
step.class[id ...] = id-of-class
# E.g.:
step.class[build-qxrecon build-ieee] = build
</pre>
</dd>
<dt id="make.use">use</dt>
<dd>
<p><dfn>description</dfn>: Specifies inheritance locations. It is worth
noting that this declaration is cumulative, i.e. a <code>use</code>
declaration adds more inheritance locations rather than overrides the
inheritance locations of any previous <code>use</code> declarations.</p>
<p><dfn>value</dfn>: A list of paths where this make can inherit items
and properties from.</p>
<p><dfn>example</dfn>:</p>
<pre>
use = path1 path2 ...
E.g.:
use = /path/to/inherit
</pre>
</dd>
</dl>
<h3 id="make.extract">FCM Make Configuration: Extract</h3>
<p>All declarations are prefixed with <samp>extract.*</samp>. Where
appropriate, replace the leading <samp>extract</samp> with the appropriate
step ID. With the exception of the <code>extract.location{diff}</code>
declaration, any attempt to specify any extract declarations in an inherited
extract will result in an exception.</p>
<dl>
<dt id="make.extract.ns">extract.ns</dt>
<dd>
<p><dfn>description</dfn>: Specifies a list of names of the projects to
extract.</p>
<p><dfn>value</dfn>: A space-delimited list of names of the projects to
extract.</p>
<p><dfn>example</dfn>:</p>
<pre>
extract.ns = gen ops um var ver
</pre>
</dd>
<dt id="make.extract.location">extract.location</dt>
<dd>
<p><dfn>description</dfn>: Specifies the location of the base source tree
a project. If the base source tree is not specified for a Subversion
project, the system will try to use <samp>trunk@HEAD</samp>.</p>
<p><dfn>modifier</dfn>: <var>type</var>: Specifies the type of the
locations. The system currently supports <samp>svn</samp> for a Subversion
location, <samp>ssh</samp> for a file system on a remote host accessible
via SSH and RSYNC, and <samp>fs</samp> for a file system location.
(default=<samp>svn</samp> if the location is recognised as a Subversion
URL, <samp>ssh</samp> if the location has the form
<var>[USER@]HOST:PATH</var> and <var>HOST</var> is a valid remote host,
<samp>fs</samp> otherwise)</p>
<p><dfn>namespace</dfn>: A space-delimited list of project IDs.</p>
<p><dfn>value</dfn>: A location, which can be a full path in the file
system, or a relative location of the project root.</p>
<p><dfn>example</dfn>:</p>
<pre>
extract.location[um] = trunk@vn7.5
extract.location[gen ops var] = trunk@HEAD
</pre>
</dd>
<dt id="make.extract.location.diff">extract.location{diff}</dt>
<dd>
<p><dfn>description</dfn>: Specifies the location(s) of one or more diff
source trees of a project. It is OK to add more diff source trees in an
inheriting extract.</p>
<p><dfn>modifier</dfn>: <var>type</var>: -as above-</p>
<p><dfn>namespace</dfn>: A project ID.</p>
<p><dfn>value</dfn>: A space-delimited list of locations. A location can
be a full path in the file system, or a relative location of the project
root.</p>
<p><dfn>example</dfn>:</p>
<pre>
extract.location{diff}[gen] = \
branches/dev/fred/r12345_678 \
branches/dev/free/r12345_678@123
</pre>
</dd>
<dt id="make.extract.location.primary">extract.location{primary}</dt>
<dd>
<p><dfn>description</dfn>: Specifies the project locations for an
extract, if they are not already defined in the keyword
configuration.</p>
<p><dfn>modifier</dfn>: <var>type</var>: -as above-</p>
<p><dfn>namespace</dfn>: A project ID.</p>
<p><dfn>value</dfn>: A project location. The location can be a path in
the file system, a Subversion URL or a FCM keyword pointing to a
Subversion URL.</p>
<p><dfn>example</dfn>:</p>
<pre>
extract.location{primary}[egg] = svn://server2/egg
extract.location{primary,type:svn}[foo] = http://server1/foo
</pre>
</dd>
<dt id="make.extract.path-excl">extract.path-excl / <span id=
"make.extract.path-incl">extract.path-incl</span></dt>
<dd>
<p><dfn>description</dfn>: Specifies the paths in a project tree to
exclude/include. (A path-incl takes precedence over a path-excl
declaration.)</p>
<p><dfn>namespace</dfn>: A space-delimited list of project IDs.</p>
<p><dfn>value</dfn>: A space-delimited list of paths in a project
tree.</p>
<p><dfn>example</dfn>:</p>
<pre>
extract.path-excl[foo] = / # everything
extract.path-incl[foo] = bin lib src/code
</pre>
</dd>
<dt id="make.extract.path-root">extract.path-root</dt>
<dd>
<p><dfn>description</dfn>: Specifies the root paths in the source trees
of the projects to be extracted. By default, the root path is the
root of a source tree. If this setting is specified, the system will only
extract source files under the specified root path. The system will also
adjust the name-space of each source file to be relative to the specified
root path. The <code>extract.path-excl</code> and
<code>extract.path-incl</code> declarations will apply from the level of
the specified root path.</p>
<p><dfn>namespace</dfn>: A space-delimited list of project IDs.</p>
<p><dfn>value</dfn>: A relative path in the project source trees.</p>
<p><dfn>example</dfn>:</p>
<pre>
extract.path-root[gen] = src/code
</pre>
</dd>
<dt id="make.extract.prop">extract.prop</dt>
<dd>
<p><dfn>description</dfn>: Sets or modifies a property.</p>
<p><dfn>modifier</dfn>: <var>diff3</var>: The shell command to perform a
3-way merge. If not specified, use the <a href="#external.diff3">diff3</a>
setting of the FCM external configuration.</p>
<p><dfn>modifier</dfn>: <var>diff3.flags</var>: The options used by the
3-way merge shell command. If not specified, use the <a href=
"#external.diff3.flags">diff3.flags</a> setting of the FCM external
configuration.</p>
<p><dfn>value</dfn>: The value of the property.</p>
<p><dfn>example</dfn>:</p>
<pre>
extract.prop{diff3} = diff3
extract.prop{diff3.flags} = -E -m
</pre>
</dd>
</dl>
<h3 id="make.mirror">FCM Make Configuration: Mirror</h3>
<p>All declarations are prefixed with <samp>mirror.*</samp>. Where
appropriate, replace the leading <samp>mirror</samp> with the appropriate
ID.</p>
<dl>
<dt id="make.mirror.target">mirror.target</dt>
<dd>
<p><dfn>description</dfn>: Specifies the mirror target. This setting is
not inherited.</p>
<p><dfn>value</dfn>: The mirror target.</p>
<p><dfn>example</dfn>:</p>
<pre>
mirror.target = fred@server:/path/of/dest
# Or if the current user ID is "fred"
# Or if the user ID for "server" is configured under "~/.ssh/config"
mirror.target = server:/path/of/dest
# Or if mirroring to a path accessible only by user ID "bob"
mirror.target = bob@localhost:/path/of/dest
# Or if the current user ID is "fred" and local host is "server"
mirror.target = /path/of/dest
</pre>
</dd>
<dt id="make.mirror.prop">mirror.prop</dt>
<dd>
<p><dfn>description</dfn>: Sets or modifies a property.</p>
<p><dfn>modifier</dfn>: See below.</p>
<p><dfn>value</dfn>: The value of the property.</p>
<p><dfn>example</dfn>:</p>
<pre>
mirror.prop{rsync} = cnysr
</pre>
</dd>
</dl>
<p>The following is a list of properties accepted by the
<code>mirror.prop</code> declaration:</p>
<dl>
<dt id="make.mirror.prop.config-file.name">config-file.name</dt>
<dd>The context name to be included in the generated configuration file in
the mirror destination.</dd>
<dt id="make.mirror.prop.config-file.steps">config-file.steps</dt>
<dd>The steps to be included in the generated configuration file in the
mirror destination.</dd>
<dt id="make.mirror.prop.no-config-file">no-config-file</dt>
<dd>If specified, do not generate a <samp>fcm-make.cfg</samp> in the mirror
target.</dd>
<dt id="make.mirror.prop.ssh">ssh</dt>
<dd>The secure remote shell command to execute commands on a remote machine.
If not specified, use the <a href= "#external.ssh">ssh</a> setting of the
FCM external configuration.</dd>
<dt id="make.mirror.prop.ssh.flags">ssh.flags</dt>
<dd>The flags used by the remote shell command to execute commands on a
remote machine. If not specified, use the <a href=
"#external.ssh.flags">ssh.flags</a> setting of the FCM external
configuration.</dd>
<dt id="make.mirror.prop.rsync">rsync</dt>
<dd>The <code>rsync</code> command. If not specified, use the <a href=
"#external.rsync">rsync</a> setting of the FCM external configuration.</dd>
<dt id="make.mirror.prop.rsync.flags">rsync.flags</dt>
<dd>The options used by the <code>rsync</code> command. If not specified,
use the <a href= "#external.rsync.flags">rsync.flags</a> setting of the FCM
external configuration.</dd>
</dl>
<h3 id="make.build">FCM Make Configuration: Build</h3>
<p>All declarations are prefixed with <samp>build.*</samp>. Where
appropriate, replace the leading <samp>build</samp> with the appropriate
ID.</p>
<dl>
<dt id="make.build.source">build.source</dt>
<dd>
<p><dfn>description</dfn>: Specifies one or more source files and/or
directories.</p>
<p><dfn>namespace</dfn>: Optional. Specifies the namespace of the
specified paths.</p>
<p><dfn>value</dfn>: A list of space-delimited file system paths.</p>
<p><dfn>example</dfn>:</p>
<pre>
build.source[foo] = $HOME/foo $DATADIR/foo
</pre>
</dd>
<dt id="make.build.ns-excl">build.ns-excl / <span id=
"make.build.ns-incl">build.ns-incl</span></dt>
<dd>
<p><dfn>description</dfn>: Specifies the name-spaces in the source tree
to exclude/include. (A <code>build.ns-incl</code> takes precedence over a
<code>build.ns-excl</code> declaration.)</p>
<p><dfn>value</dfn>: A list of space-delimited items. Each item is a
name-space to exclude/include.</p>
<p><dfn>example</dfn>:</p>
<pre>
build.ns-excl = / # exclude everything
build.ns-incl = foo bar/baz # include items in these name-spaces
</pre>
</dd>
<dt id="make.build.target">build.target</dt>
<dd>
<p><dfn>description</dfn>: Selects targets to build according to their
keys, categories and tasks.</p>
<p><dfn>modifier</dfn>: <samp>key</samp> (default if no modifier
specified), <samp>category</samp> or <samp>task</samp></p>
<p><dfn>namespace</dfn>: Not allowed if modifier is <samp>key</samp>.
Optional if modifier is <samp>category</samp> or <samp>task</samp>. If
specified, setting only applies to given name-spaces. Otherwise, setting
applies to all name-spaces.</p>
<p><dfn>value</dfn>: A list of space-delimited items (according to the
modifier).</p>
<p><dfn>example</dfn>:</p>
<pre>
build.target{category}[etc/namelists etc/configs] = etc
build.target{category}[src/hello src/greet src/world] = bin lib
build.target{task}[src/public] = archive install
build.target = egg.sh mince.py
</pre>
</dd>
<dt id="make.build.target-rename">build.target-rename</dt>
<dd>
<p><dfn>description</dfn>: Rename targets.</p>
<p><dfn>value</dfn>: A list of space-delimited items. Each item should be
the (automatic) key of a target, followed by a colon and its preferred
key.</p>
<p><dfn>example</dfn>:</p>
<pre>
build.target-rename = hello.exe:hello
</pre>
</dd>
<dt id="make.build.prop">build.prop</dt>
<dd>
<p><dfn>description</dfn>: Sets or modifies a property.</p>
<p><dfn>modifier</dfn>: The name of one (or more) property. See
below.</p>
<p><dfn>namespace</dfn>: Optional. A list of space-delimited namespaces to
which this setting applies. The namespaces can be target names, when used
with target properties (dependency properties are regarded as source
properties), or the hierarchical namespaces of source files. If not
specified, the setting applies to the global/root namespace. N.B. Not all
build properties accept a namespace. See below for detail.</p>
<p><dfn>value</dfn>: The value of the property.</p>
<p><dfn>example</dfn>:</p>
<pre>
build.prop{fc} = gfortran
build.prop{cc.flags,fc.flags} = -C -g
build.prop{fc.flags}[foo/bar] = -C -g -W
build.prop{fc.flags}[egg ham bacon] = -C -W
build.prop{fc.flag-define} = -D%s
build.prop{cc.defs,fc.defs}[gen] = LOWERCASE UNDERSCORE
build.prop{fc.libs}[myprog.exe] = netcdf grib
</pre>
</dd>
</dl>
<p>The following is a list of properties accepted by the
<code>build.prop</code> declaration. The default value is an empty string
unless given otherwise. Properties that do not accept a namespace are marked
with an asterisk (*).</p>
<dl>
<dt id="make.build.prop.ar">ar</dt>
<dd>The archive command. (default=<samp>ar</samp>)</dd>
<dt id="make.build.prop.ar.flags">ar.flags</dt>
<dd>If a list of values is specified, the system will not inherit sources
with the name-spaces matching the specified values. If the value is a
<samp>*</samp>, the system will not inherit any sources.</dd>
<dd>The options used by the archive command. (default=<samp>rs</samp>)</dd>
<dt id=
"make.build.prop.archive-ok-target-category">archive-ok-target-category
*</dt>
<dd>If <code>fcm make</code> is invoked with the <code>--archive</code>
option, sub-directories in categories containing intermediate build files
will be put into TAR-GZIP files. E.g. with the default setting,
<samp>include/</samp> and <samp>o/</samp> will become
<samp>include.tar.gz</samp> and <samp>o.tar.gz</samp> respectively.
(default=<samp>include o</samp>)</dd>
<dt id="make.build.prop.cc">cc</dt>
<dd>The C compiler and linker. (default=<samp>gcc</samp>)</dd>
<dt id="make.build.prop.cc.defs">cc.defs</dt>
<dd>The C compiler will pre-define each word in this setting as a
macro.</dd>
<dt id="make.build.prop.cc.flags">cc.flags</dt>
<dd>The options used by the C compiler at compile time.</dd>
<dt id="make.build.prop.cc.flags-ld">cc.flags-ld</dt>
<dd>The options used by the C compiler at link time.</dd>
<dt id="make.build.prop.cc.flag-compile">cc.flag-compile</dt>
<dd>The option used by the C compiler to suppress the linking stage.
(default=<samp>-c</samp>)</dd>
<dt id="make.build.prop.cc.flag-define">cc.flag-define</dt>
<dd>The option used by the C compiler to define a macro.
(default=<samp>-D%s</samp>)</dd>
<dt id="make.build.prop.cc.flag-include">cc.flag-include</dt>
<dd>The option used by the C compiler to specify an include search
path. (default=<samp>-I%s</samp>)</dd>
<dt id="make.build.prop.cc.flag-lib">cc.flag-lib</dt>
<dd>The option used by the C compiler at link time to specify a
library. (default=<samp>-l%s</samp>)</dd>
<dt id="make.build.prop.cc.flag-lib-path">cc.flag-lib-path</dt>
<dd>The option used by the C compiler at link time to specify a library
search path. (default=<samp>-L%s</samp>)</dd>
<dt id="make.build.prop.cc.flag-omp">cc.flag-omp</dt>
<dd>The option used by the C compiler to switch on OpenMP.</dd>
<dt id="make.build.prop.cc.flag-output">cc.flag-output</dt>
<dd>The option used by the C compiler to specify the output file name.
(default=<samp>-o%s</samp>)</dd>
<dt id="make.build.prop.cc.include-paths">cc.include-paths</dt>
<dd>The C compiler will add each directory in this setting as an include
search path.</dd>
<dt id="make.build.prop.cc.libs">cc.libs</dt>
<dd>The C linker will add each item in this setting as a link
library.</dd>
<dt id="make.build.prop.cc.lib-paths">cc.lib-paths</dt>
<dd>The C linker will add each directory in this setting as a library
search path.</dd>
<dt id="make.build.prop.checksum-method">checksum-method</dt>
<dd>The checksum method to use to determine if the content of a file is
changed or not. Either MD5 or one of the SHA algorithms supported by the
Perl module <a href="http://perldoc.perl.org/Digest/SHA.html">Digest::SHA</a>
can be used. (default=<samp>md5</samp>)</dd>
<dt id="make.build.prop.cxx">cxx</dt>
<dd>The C++ compiler and linker. (default=<samp>g++</samp>)</dd>
<dt id="make.build.prop.cxx.defs">cxx.defs</dt>
<dd>The C++ compiler will pre-define each word in this setting as a
macro.</dd>
<dt id="make.build.prop.cxx.flags">cxx.flags</dt>
<dd>The options used by the C++ compiler at compile time.</dd>
<dt id="make.build.prop.cxx.flags-ld">cxx.flags-ld</dt>
<dd>The options used by the C++ compiler at link time.</dd>
<dt id="make.build.prop.cxx.flag-compile">cxx.flag-compile</dt>
<dd>The option used by the C++ compiler to suppress the linking stage.
(default=<samp>-c</samp>)</dd>
<dt id="make.build.prop.cxx.flag-define">cxx.flag-define</dt>
<dd>The option used by the C++ compiler to define a macro.
(default=<samp>-D%s</samp>)</dd>
<dt id="make.build.prop.cxx.flag-include">cxx.flag-include</dt>
<dd>The option used by the C++ compiler to specify an include search
path. (default=<samp>-I%s</samp>)</dd>
<dt id="make.build.prop.cxx.flag-lib">cxx.flag-lib</dt>
<dd>The option used by the C++ compiler at link time to specify a
library. (default=<samp>-l%s</samp>)</dd>
<dt id="make.build.prop.cxx.flag-lib-path">cxx.flag-lib-path</dt>
<dd>The option used by the C++ compiler at link time to specify a library
search path. (default=<samp>-L%s</samp>)</dd>
<dt id="make.build.prop.cxx.flag-omp">cxx.flag-omp</dt>
<dd>The option used by the C++ compiler to switch on OpenMP.</dd>
<dt id="make.build.prop.cxx.flag-output">cxx.flag-output</dt>
<dd>The option used by the C++ compiler to specify the output file name.
(default=<samp>-o%s</samp>)</dd>
<dt id="make.build.prop.cxx.include-paths">cxx.include-paths</dt>
<dd>The C++ compiler will add each directory in this setting as an include
search path.</dd>
<dt id="make.build.prop.cxx.libs">cxx.libs</dt>
<dd>The C++ linker will add each item in this setting as a link
library.</dd>
<dt id="make.build.prop.cxx.lib-paths">cxx.lib-paths</dt>
<dd>The C++ linker will add each directory in this setting as a library
search path.</dd>
<dt id="make.build.prop.dep.bin">dep.bin</dt>
<dd>Specifies a list of manual dependencies on external executable
commands.</dd>
<dt id="make.build.prop.dep.f.module">dep.f.module</dt>
<dd>Specifies a list of manual Fortran module dependencies. Note: This
modifier does not work if the name-space is specified using a target
name.</dd>
<dt id="make.build.prop.dep.include">dep.include</dt>
<dd>Specifies a list of manual include dependencies.</dd>
<dt id="make.build.prop.dep.o">dep.o</dt>
<dd>Specifies a list of manual object dependencies.</dd>
<dt id="make.build.prop.dep.o.special">dep.o.special</dt>
<dd>Specifies a list of manual object dependencies, which must appear on
the command line of the linker, (e.g. an object containing a Fortran
blockdata program unit).</dd>
<dt id="make.build.prop.fc">fc</dt>
<dd>The Fortran compiler and linker. (default=<samp>gfortran</samp>)</dd>
<dt id="make.build.prop.fc.defs">fc.defs</dt>
<dd>The Fortran compiler will pre-define each word in this setting as a
macro.</dd>
<dt id="make.build.prop.fc.flags">fc.flags</dt>
<dd>The options used by the Fortran compiler at compile time.</dd>
<dt id="make.build.prop.fc.flags-ld">fc.flags-ld</dt>
<dd>The options used by the Fortran compiler at link time.</dd>
<dt id="make.build.prop.fc.flag-compile">fc.flag-compile</dt>
<dd>The option used by the Fortran compiler to suppress the linking stage.
(default=<samp>-c</samp>)</dd>
<dt id="make.build.prop.fc.flag-define">fc.flag-define</dt>
<dd>The option used by the Fortran compiler to define a macro.
(default=<samp>-D%s</samp>)</dd>
<dt id="make.build.prop.fc.flag-include">fc.flag-include</dt>
<dd>The option used by the Fortran compiler to specify an include search
path. (default=<samp>-I%s</samp>)</dd>
<dt id="make.build.prop.fc.flag-lib">fc.flag-lib</dt>
<dd>The option used by the Fortran compiler at link time to specify a
library. (default=<samp>-l%s</samp>)</dd>
<dt id="make.build.prop.fc.flag-lib-path">fc.flag-lib-path</dt>
<dd>The option used by the Fortran compiler at link time to specify a
library search path. (default=<samp>-L%s</samp>)</dd>
<dt id="make.build.prop.fc.flag-module">fc.flag-module</dt>
<dd>The option used by the Fortran compiler to specify a module search
path.</dd>
<dt id="make.build.prop.fc.flag-omp">fc.flag-omp</dt>
<dd>The option used by the Fortran compiler to switch on OpenMP. If
specified, the build system will treat <code>USE</code> and
<code>INCLUDE</code> statements that are protected by <code>!$ </code>
sentinels as normal dependency statements.</dd>
<dt id="make.build.prop.fc.flag-output">fc.flag-output</dt>
<dd>The option used by the Fortran compiler to specify the output file
name. (default=<samp>-o%s</samp>)</dd>
<dt id="make.build.prop.fc.include-paths">fc.include-paths</dt>
<dd>The Fortran compiler will add each directory in this setting as an
include search path.</dd>
<dt id="make.build.prop.fc.libs">fc.libs</dt>
<dd>The Fortran linker will add each item in this setting as a link
library.</dd>
<dt id="make.build.prop.fc.lib-paths">fc.lib-paths</dt>
<dd>The Fortran linker will add each directory in this setting as a library
search path.</dd>
<dt id="make.build.prop.file-ext.a">file-ext.a *</dt>
<dd>Specifies the extension of an object archive file.
(default=<samp>.a</samp>)</dd>
<dt id="make.build.prop.file-ext.bin">file-ext.bin *</dt>
<dd>Specifies the extension of a binary executable file.
(default=<samp>.exe</samp>)</dd>
<dt id="make.build.prop.file-ext.c">file-ext.c *</dt>
<dd>Specifies the extensions of a C source file.
(default=<samp>.c .i .m .mi</samp>)</dd>
<dt id="make.build.prop.file-ext.cxx">file-ext.cxx *</dt>
<dd>Specifies the extensions of a C++ source file.
(default=<samp>.cc .cp .cxx .cpp .CPP .c++ .C .mm .M .mii</samp>)</dd>
<dt id="make.build.prop.file-ext.fortran">file-ext.fortran *</dt>
<dd>Specifies the extensions of a Fortran source file. (default=<samp>.F
.FOR .FTN .F90 .F95 .f .for .ftn .f90 .f95 .inc</samp>)</dd>
<dt id="make.build.prop.file-ext.f90-interface">file-ext.f90-interface
*</dt>
<dd>Specifies the extension of a Fortran interface file.
(default=<samp>.interface</samp>)</dd>
<dt id="make.build.prop.file-ext.f90-mod">file-ext.f90-mod *</dt>
<dd>Specifies the extension of a compiled Fortran module file.
(default=<samp>.mod</samp>)</dd>
<dt id="make.build.prop.file-ext.h">file-ext.h *</dt>
<dd>Specifies the extensions of a C/C++ header file.
(default=<samp>.h</samp>)</dd>
<dt id="make.build.prop.file-ext.o">file-ext.o *</dt>
<dd>Specifies the extension of a compiled object file.
(default=<samp>.o</samp>)</dd>
<dt id="make.build.prop.file-ext.script">file-ext.script *</dt>
<dd>Specifies the extensions of script files.</dd>
<dt id="make.build.prop.file-name-option.f90-mod">file-name-option.f90-mod
*</dt>
<dd>Specifies other options for naming a compiled Fortran module file.
Accepts <samp>case=upper</samp> or <samp>case=lower</samp> (default).</dd>
<dt id="make.build.prop.file-pat.script">file-pat.script *</dt>
<dd>Specifies a regular expression for matching the name of script
files.</dd>
<dt id="make.build.prop.ignore-missing-dep-ns">ignore-missing-dep-ns *</dt>
<dd>Specifies a list of source name-spaces, in which targets can ignore
missing dependencies.</dd>
<dt id="make.build.prop.keep-lib-o">keep-lib-o</dt>
<dd>Relevant when linking a binary executable and <a href=
"#make.build.prop.link-without-ar">link-without-ar</a> is not set to
<kbd>true</kbd>. If <kbd>true</kbd>, create and keep the dependent object
library as <samp>lib/libNAME.a</samp>, where <var>NAME</var> is the root
name of the executable. In the absence of this setting, the behaviour is to
create the dependent object library in a temporary directory, which is
removed after the linker command is completed.</dd>
<dt id="make.build.prop.ld">ld</dt>
<dd>The linker command. If not specified, use the compiler of the source
file.</dd>
<dt id="make.build.prop.link-without-ar">link-without-ar</dt>
<dd>Relevant when linking a binary executable. If <kbd>true</kbd>, do not
create the dependent object library when linking. Instead, locations of the
dependent objects will be specified on the command line of the linker. In
the absence of this setting, the behaviour is to create the dependent object
library in a temporary directory, with the location of the object library
specified using the relevant options of the linker.</dd>
<dt id="make.build.prop.no-dep.bin">no-dep.bin</dt>
<dd>Switches off a list of automatic dependencies on external executable.
If the value is a <samp>*</samp>, switches off all automatic external
executable dependencies.</dd>
<dt id="make.build.prop.no-dep.f.module">no-dep.f.module</dt>
<dd>Switches off a list of automatic Fortran module dependencies. If the
value is a <samp>*</samp>, switches off all automatic Fortran module
dependencies. Note: This modifier does not work if the name-space is
specified using a target name.</dd>
<dt id="make.build.prop.no-dep.include">no-dep.include</dt>
<dd>Switches off a list of automatic include dependencies. If the value is
a <samp>*</samp>, switches off all automatic include dependencies.</dd>
<dt id="make.build.prop.no-dep.o">no-dep.o</dt>
<dd>Switches off a list of automatic object dependencies. If the value is a
<samp>*</samp>, switches off all automatic object dependencies.</dd>
<dt id="make.build.prop.no-inherit-source">no-inherit-source *</dt>
<dd>If a list of values is specified, the system will not inherit sources
with the name-spaces matching the specified values. If the value is a
<samp>*</samp>, the system will not inherit any sources.</dd>
<dt id="make.build.prop.no-inherit-target-category">
no-inherit-target-category *</dt>
<dd>If a list of values is specified, the system will not inherit a target
in a category matching a specified value. (default=<samp>bin etc
lib</samp>)</dd>
<dt id="make.build.prop.no-step-source">no-step-source *</dt>
<dd>If a list of make steps is specified, the system will not search for
source files from the specified make steps.</dd>
<dt id="make.build.prop.ns-dep.o">ns-dep.o</dt>
<dd>Specifies a list of link-time object dependencies on all objects in the
list of name-spaces in the value.</dd>
</dl>
<h3 id="make.preprocess">FCM Make Configuration: Preprocess</h3>
<p>The preprocess system uses the same declarations as the build system (see
<a href="#make.build">FCM Make Configuration: Build</a>), although their
prefixes should be replaced with <samp>preprocess.*</samp> or the appropriate
step ID. The following is a list of modifiers accepted by the
<code>preprocess.prop</code> declaration. The default value of a property is
an empty string unless given otherwise. Properties that do not accept a
namespace are marked with an asterisk (*).</p>
<dl>
<dt id="make.preprocess.prop.cpp">cpp</dt>
<dd>The command of the C/C++ pre-processor. (default=<samp>cpp</samp>)</dd>
<dt id="make.preprocess.prop.cpp.defs">cpp.defs</dt>
<dd>The C/C++ pre-processor will pre-define each word in this setting as a
macro.</dd>
<dt id="make.preprocess.prop.cpp.flags">cpp.flags</dt>
<dd>The options used by the C/C++ pre-processor.</dd>
<dt id="make.preprocess.prop.cpp.flag-define">cpp.flag-define</dt>
<dd>The option used by the C/C++ pre-processor to define a macro.
(default=<samp>-D%s</samp>)</dd>
<dt id="make.preprocess.prop.cpp.flag-include">cpp.flag-include</dt>
<dd>The option used by the C/C++ pre-processor to specify the include
search path. (default=<samp>-I%s</samp>)</dd>
<dt id="make.preprocess.prop.cpp.include-paths">cpp.include-paths</dt>
<dd>The C/C++ preprocessor will add each directory in this setting as an
include search path.</dd>
<dt id="make.preprocess.prop.dep.include">dep.include</dt>
<dd>Specifies a list of manual include dependencies.</dd>
<dt id="make.preprocess.prop.file-ext.cpp">file-ext.cpp *</dt>
<dd>Specifies the extensions of C/C++ source file.
(default=<samp>.c .m .cc .cp .cxx .cpp .CPP .c++ .C .mm .M</samp>)</dd>
<dt id="make.preprocess.prop.file-ext.fpp">file-ext.fpp *</dt>
<dd>Specifies the extensions of Fortran source file requiring
preprocessing. (default=<samp>.F .FOR .FTN .F90 .F95</samp>)</dd>
<dt id="make.preprocess.prop.file-ext.h">file-ext.h *</dt>
<dd>Specifies the extensions of a C/C++ header file.
(default=<samp>.h</samp>)</dd>
<dt id="make.preprocess.prop.fpp">fpp</dt>
<dd>The command of the Fortran pre-processor.
(default=<samp>cpp</samp>)</dd>
<dt id="make.preprocess.prop.fpp.defs">fpp.defs</dt>
<dd>The Fortran pre-processor will pre-define each word in this setting as
a macro.</dd>
<dt id="make.preprocess.prop.fpp.flags">fpp.flags</dt>
<dd>The options used by the Fortran pre-processor. (default=<samp>-P
-traditional</samp>)</dd>
<dt id="make.preprocess.prop.fpp.flag-define">fpp.flag-define</dt>
<dd>The option used by the Fortran pre-processor to define a macro.
(default=<samp>-D%s</samp>)</dd>
<dt id="make.preprocess.prop.fpp.flag-include">fpp.flag-include</dt>
<dd>The option used by the Fortran pre-processor to specify the include
search path. (default=<samp>-I%s</samp>)</dd>
<dt id="make.preprocess.prop.fpp.include-paths">fpp.include-paths</dt>
<dd>The Fortran preprocessor will add each directory in this setting as an
include search path.</dd>
<dt id="make.preprocess.prop.no-dep.include">no-dep.include</dt>
<dd>Switches off a list of automatic include dependencies. If the value is
a <samp>*</samp>, it switches off all automatic include dependencies.</dd>
<dt id="make.preprocess.prop.no-inherit-source">no-inherit-source *</dt>
<dd>Same as the build property of the same name.</dd>
<dt id="make.preprocess.prop.no-inherit-target-category">
no-inherit-target-category *</dt>
<dd>Same as the build property of the same name.</dd>
<dt id="make.preprocess.prop.no-step-source">no-step-source *</dt>
<dd>Same as the build property of the same name.</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>
|