add info on new env-vars.txt file to user guide

Author: kevinhendricks

src/OEBPS/Text/advanced_topics.xhtml

@@ -13,7 +13,19 @@
   <h2 id="atenv">Using Sigil's Environment Variables</h2>
 
 
-  <p>Some rarely needed settings in Sigil are controlled by "Environment Variables". An environment variable is a user-definable value that can affect the way running processes will behave on a computer.  See <a href="https://en.wikipedia.org/wiki/Environment_variable">https://en.wikipedia.org/wiki/Environment_variable&gt;</a> for more information on setting and using environment variables on your computer.</p>
+  <p>Some rarely needed settings in Sigil are controlled by "Environment Variables". An environment variable is a user-definable value that can affect the way running processes will behave on a computer.  See <a href="https://en.wikipedia.org/wiki/Environment_variable">https://en.wikipedia.org/wiki/Environment_variable</a> for more information on setting and using environment variables on your computer. Starting with Sigil 2.6.2, we have tried to make the process of setting and changing Sigil's environment variables much easier. With that release or later you can now simply use any text editor you want (Notepad, BBedit, emacs, vi, kate, etc) and create a file called "env-vars.txt" inside your Sigil Preferences folder. Add each environment variable and its value, one per line, in the following format:</p>
+
+  <p>ENVIRONMENT_VARIABLE_NAME=VALUE</p>
+
+  <p> where you replace ENVIRONMENT_VARIABLE_NAME with one of the environment variable names listed below and replace the VALUE with the what you want to set whether it is numeric or string or the value 1 for true.  No quotes are used.  For example:</p>
+
+  <p>SIGIL_DISABLE_VERSION_META=1</p>
+
+  <div class="tip">
+    <p class="tiptext">Remember, if you open Sigil's Preferences via the menu you can use a button on the bottom left to have it show you where your Sigil Preferences folder is located.</p>
+  </div>
+
+  <p>Then save this file.  Please note Sigil will only read this file when it is first launched, so remember to close and exit out of Sigil before making any changes to your env-vars.txt file and restart Sigil after the change.</p>
 
   <p>Sigil Uses the following Environment Variables:</p>
 
@@ -273,4 +285,4 @@ QFrame QToolButton#count {
 <li><a href="https://doc.qt.io/qt-6/stylesheet-reference.html">https://doc.qt.io/qt-6/stylesheet-reference.html</a></li>
 </ul>
 </body>
-</html>
+</html>

src/OEBPS/Text/preferences.xhtml

@@ -374,6 +374,7 @@
           <li><span class="listheading">custom_preview_style_alt.css</span>: Optional alternative CSS for Preview.</li>
 
 			<li><span class="listheading">hunspell_dictionaries:</span> Where any standard dictionaries you add are stored.</li>
+			<li><span class="listheading">env-vars.txt:</span> a user created text file for setting Sigil environment variables. Starting with Sigil 2.6.2</li>
 
 			<li><span class="listheading">local-devtools:</span> Where data for Preview’s Inspector is stored.</li>
 
@@ -438,4 +439,4 @@ QComboBox { font-size: 16pt }
 
 		  <p>Note: Applying such CSS can possibly adversely affect the visibility of some styled elements within an EPUB, depending on what CSS has already been applied via the EPUB and how.</p>
 </body>
-</html>
+</html>