From 365ebb83fff61fbe40788c7e7866ec0d9266b644 Mon Sep 17 00:00:00 2001 From: Kevin Day Date: Sun, 15 May 2022 16:41:11 -0500 Subject: [PATCH] Update: New parameters for iki_read. --- documentation/iki_read.html | 29 +++++++++++++++++++++++++++-- 1 file changed, 27 insertions(+), 2 deletions(-) diff --git a/documentation/iki_read.html b/documentation/iki_read.html index df08787..79af669 100644 --- a/documentation/iki_read.html +++ b/documentation/iki_read.html @@ -237,15 +237,31 @@ Print the total number of variables. + -r + --replace + Simple substitution, replacing the variable for the given name with the given string. + + -s --substitute - Substitute the entire variable for the given name and content value with the given string. + Substitute the variable for the given name and matching content value with the given string.

- This -s/--substitute option, requires 3 additional parameters: <vocabulary> <replace> <with>. + The -r/--replace option requires 2 additional parameters: <vocabulary> <with>. +

+
+
+
vocabulary
The name of the vocabulary whose content is to be substituted.
+
+
+
with
The new string to use as the substitute.
+
+
+

+ The -s/--substitute option requires 3 additional parameters: <vocabulary> <replace> <with>.

@@ -261,6 +277,15 @@

The vocabulary and replacement are case-sensitive and must exactly match.

+

+ The difference between -r/--replace and -s/--substitute is that the -r/--replace option substitutes all matching vocabulary names and the -s/--substitute option substitutes all matching vocabulary names that must also have the given matching content. +

+

+ The -s/--substitute option takes priority over the -r/--replace option when matching the same variable. +

+

+ The default behavior is to only display content portion of the IKI variable. +

-- 1.8.3.1