JAL-629 Make arguments appear correctly using all non-breaking hyphens
[jalview.git] / help / help / html / features / clarguments-reference.html
index 484d62a..62ef374 100644 (file)
     <td><code>&#8209;&#8209;headless</code></td>
     <td>Run Jalview in headless mode.  In headless mode, no GUI interface will be created and Jalview will quit after all arguments have been processed.
     <br/>
-    If you use a command line argument to specify an output file of some kind (<code>--output</code>, <code>--image</code> or <code>--structureimage</code>) then <strong>headless mode will be assumed</strong>.  If you don't want this behaviour use <code>--gui</code>.
+    If you use a command line argument to specify an output file of some kind (<code>&#8209;&#8209;output</code>, <code>&#8209;&#8209;image</code> or <code>&#8209;&#8209;structureimage</code>) then <strong>headless mode will be assumed</strong>.  If you don't want this behaviour use <code>&#8209;&#8209;gui</code>.
     </td>
     </tr>
 
     <tr valign="top">
     <td><code>&#8209;&#8209;gui</code></td>
-    <td>Force Jalview to run in graphical mode.  This can be used to counter the assumption of headless mode when an argument that creates an output file is used.  <code>--gui</code> takes precedence over <code>--headless</code>.</td>
+    <td>Force Jalview to run in graphical mode.  This can be used to counter the assumption of headless mode when an argument that creates an output file is used.  <code>&#8209;&#8209;gui</code> takes precedence over <code>&#8209;&#8209;headless</code>.</td>
     </tr>
 
     <tr valign="top">
 
     <tr valign="top">
     <td><code>&#8209;&#8209;mkdirs</code></td>
-    <td>Enable automatic creation of new directories and parent directories for filenames given, or created through substitutions, in <code>--output</code>, <code>--image</code> or <code>--structureimage</code> arguments.
+    <td>Enable automatic creation of new directories and parent directories for filenames given, or created through substitutions, in <code>&#8209;&#8209;output</code>, <code>&#8209;&#8209;image</code> or <code>&#8209;&#8209;structureimage</code> arguments.
     <td></td>
     <td align="center">&#x2713;</td>
     </tr>
@@ -690,7 +690,7 @@ Automatically create directories when outputting a file to a new directory
 
     <tr valign="top">
     <td><code>&#8209;&#8209;scale&nbsp;<em>number</em></code></td>
-    <td>Sets a scaling for bitmap image format (PNG).  Should be given as a floating point number.  Applies to the preceding <code>&#8209;&#8209;image</code> or <code>&#8209;&#8209;structureimage</code>.  This can also be set as a sub-value modifier to the <code>--image</code> or <code>&#8209;&#8209;structureimage</code> value.  If used in conjunction with <code>--width</code> and <code>--height</code> then the smallest size will be used (<code>scale</code>, <code>width</code> and <code>height</code> provide bounds for the image).
+    <td>Sets a scaling for bitmap image format (PNG).  Should be given as a floating point number.  Applies to the preceding <code>&#8209;&#8209;image</code> or <code>&#8209;&#8209;structureimage</code>.  This can also be set as a sub-value modifier to the <code>&#8209;&#8209;image</code> or <code>&#8209;&#8209;structureimage</code> value.  If used in conjunction with <code>&#8209;&#8209;width</code> and <code>&#8209;&#8209;height</code> then the smallest size will be used (<code>scale</code>, <code>width</code> and <code>height</code> provide bounds for the image).
     </td>
     <td></td>
     <td align="center">&#x2713;</td>
@@ -698,7 +698,7 @@ Automatically create directories when outputting a file to a new directory
 
     <tr valign="top">
     <td><code>&#8209;&#8209;width&nbsp;<em>number</em></code></td>
-    <td>Sets a width for bitmap image format (PNG) with the height maintaining the aspect ratio.  Applies to the preceding <code>&#8209;&#8209;image</code> or <code>&#8209;&#8209;structureimage</code>.  Should be given as a positive integer.  This can also be set as a sub-value modifier to the <code>--image</code> or <code>&#8209;&#8209;structureimage</code> value.  If used in conjunction with <code>--scale</code> and <code>--height</code> then the smallest size will be used (<code>scale</code>, <code>width</code> and <code>height</code> provide bounds for the image).
+    <td>Sets a width for bitmap image format (PNG) with the height maintaining the aspect ratio.  Applies to the preceding <code>&#8209;&#8209;image</code> or <code>&#8209;&#8209;structureimage</code>.  Should be given as a positive integer.  This can also be set as a sub-value modifier to the <code>&#8209;&#8209;image</code> or <code>&#8209;&#8209;structureimage</code> value.  If used in conjunction with <code>&#8209;&#8209;scale</code> and <code>&#8209;&#8209;height</code> then the smallest size will be used (<code>scale</code>, <code>width</code> and <code>height</code> provide bounds for the image).
     </td>
     <td></td>
     <td align="center">&#x2713;</td>
@@ -706,14 +706,14 @@ Automatically create directories when outputting a file to a new directory
 
     <tr valign="top">
     <td><code>&#8209;&#8209;height&nbsp;<em>number</em></code></td>
-    <td>Sets a height for bitmap image format (PNG) with the width maintaining the aspect ratio.  Applies to the preceding <code>&#8209;&#8209;image</code> or <code>&#8209;&#8209;structureimage</code>.  Should be given as a positive integer.  This can also be set as a sub-value modifier to the <code>--image</code> or <code>&#8209;&#8209;structureimage</code> value.  If used in conjunction with <code>--scale</code> and <code>--width</code> then the smallest size will be used (<code>scale</code>, <code>width</code> and <code>height</code> provide bounds for the image).</td>
+    <td>Sets a height for bitmap image format (PNG) with the width maintaining the aspect ratio.  Applies to the preceding <code>&#8209;&#8209;image</code> or <code>&#8209;&#8209;structureimage</code>.  Should be given as a positive integer.  This can also be set as a sub-value modifier to the <code>&#8209;&#8209;image</code> or <code>&#8209;&#8209;structureimage</code> value.  If used in conjunction with <code>&#8209;&#8209;scale</code> and <code>&#8209;&#8209;width</code> then the smallest size will be used (<code>scale</code>, <code>width</code> and <code>height</code> provide bounds for the image).</td>
     <td></td>
     <td align="center">&#x2713;</td>
     </tr>
 
     <tr valign="top">
     <td><code>&#8209;&#8209;bgcolour&nbsp;<em>name</em></code></td>
-    <td>Only applies to structure images (opened with <code>jmol</code> structure viewer).  Sets the background colour of the preceding <code>&#8209;&#8209;structureimage</code>.  <em>name</em> should be either a named colour (e.g. <code>white</code>, <code>cyan</code>) known to Jmol, or can be given as a six digit RGB hex string preceded by a hash (#) character (e.g. <code>#ffffff</code>, <code>00ffff</code>).  Note that you made need to quote a hashed RGB hex string.  This can also be set as a sub-value modifier to the <code>--structureimage</code> value.</td>
+    <td>Only applies to structure images (opened with <code>jmol</code> structure viewer).  Sets the background colour of the preceding <code>&#8209;&#8209;structureimage</code>.  <em>name</em> should be either a named colour (e.g. <code>white</code>, <code>cyan</code>) known to Jmol, or can be given as a six digit RGB hex string preceded by a hash (#) character (e.g. <code>#ffffff</code>, <code>00ffff</code>).  Note that you made need to quote a hashed RGB hex string.  This can also be set as a sub-value modifier to the <code>&#8209;&#8209;structureimage</code> value.</td>
     <td></td>
     <td align="center">&#x2713;</td>
     </tr>
@@ -741,7 +741,7 @@ Automatically create directories when outputting a file to a new directory
     <td>
     Move on to a new alignment window.  This will ensure <code>&#8209;&#8209;append</code> will start a new alignment window and other linked arguments will apply to the new alignment window.
     <br/>
-    <em>Note</em> that <code>--open</code> already starts a new alignment window for each file it opens.
+    <em>Note</em> that <code>&#8209;&#8209;open</code> already starts a new alignment window for each file it opens.
     </td>
     </tr>
 
@@ -800,7 +800,7 @@ Automatically create directories when outputting a file to a new directory
     <tr valign="top">
     <td><code>&#8209;&#8209;allstructures / &#8209;&#8209;noallstructures</code></td>
     <td>
-        Apply (or stop applying) the following 3D structure formatting arguments to all structures <em>within the current open alignment</em>.  Whilst <code>--allstructures</code> will continue to operate for a <code>--new</code> alignment, the structure formatting arguments must be set again for each new alignment.
+        Apply (or stop applying) the following 3D structure formatting arguments to all structures <em>within the current open alignment</em>.  Whilst <code>&#8209;&#8209;allstructures</code> will continue to operate for a <code>&#8209;&#8209;new</code> alignment, the structure formatting arguments must be set again for each new alignment.
     </td>
     </tr>