Changeset 2520 for branches/nemo_v3_3_beta/NEMOGCM/TOOLS/COMPILE/Fadd_keys.sh

Timestamp:

2010-12-27T15:43:36+01:00 (13 years ago)

Author:

rblod

Message:

Add in core documentation for compilation scripts

File:

• branches/nemo_v3_3_beta/NEMOGCM/TOOLS/COMPILE/Fadd_keys.sh (modified) (3 diffs)

branches/nemo_v3_3_beta/NEMOGCM/TOOLS/COMPILE/Fadd_keys.sh

@@ -13 +13 @@
 #+
 #
-# ================
+# ============
 # Fadd_keys.sh
-# ================
+# ============
 #
-# --------------------------
+# --------------------
 # Add compilation keys
-# --------------------------
+# --------------------
 #
 # SYNOPSIS
@@ -33 +33 @@
 #
 #
-# Add keys
+# Script to add a set off key when compiling a configuration.
+# The list off key to be added has to be enclosed with " ". 
+# A 'sed' is performed to modify the CONFIG_NAME/cpp.fcm file to    
+# add the new key(s). 
 #
 #
@@ -41 +44 @@
 # ::
 #
-#  $ ./Fadd_keys.sh CONFIG_NAME add_key "LIST_KEYS"
+#  $ ./Fadd_keys.sh ORCA2_LIM add_key "key_mpp_mpi key_nproci=1 key_nprocj=10"
 #
 #