git://source.jalview.org / jalview.git / blobdiff
? search:
summary | shortlog | log | commit | commitdiff | tree
raw | inline | side by side
JAL-629 Move clarguments documentation to default. Completed clarguments summary...
[jalview.git] / help / help / html / features / clarguments-intro.html
diff --git a/help/help/html/features/clarguments-intro.html b/help/help/html/features/clarguments-intro.html
new file mode 100644 (file)
index 0000000..cee0a04
--- /dev/null
+++ b/help/help/html/features/clarguments-intro.html
@@ -0,0 +1,85 @@
+<html>
+<!--
+ * Jalview - A Sequence Alignment Editor and Viewer ($$Version-Rel$$)
+ * Copyright (C) $$Year-Rel$$ The Jalview Authors
+ * 
+ * This file is part of Jalview.
+ * 
+ * Jalview is free software: you can redistribute it and/or
+ * modify it under the terms of the GNU General Public License 
+ * as published by the Free Software Foundation, either version 3
+ * of the License, or (at your option) any later version.
+ *  
+ * Jalview is distributed in the hope that it will be useful, but 
+ * WITHOUT ANY WARRANTY; without even the implied warranty 
+ * of MERCHANTABILITY or FITNESS FOR A PARTICULAR 
+ * PURPOSE.  See the GNU General Public License for more details.
+ * 
+ * You should have received a copy of the GNU General Public License
+ * along with Jalview.  If not, see <http://www.gnu.org/licenses/>.
+ * The Jalview Authors are detailed in the 'AUTHORS' file.
+ -->
+<title>Jalview Command Line Arguments: introduction</title>
+<body>
+
+  <h1>Jalview Command Line Arguments: introduction</h1>
+
+  <p>
+  <a href="clarguments.html">Jalview Command Line Arguments: summary</a>
+  <br/>
+  Jalview Command Line Arguments: introduction
+  <br/>
+  <a href="clarguments-basic.html">Jalview Command Line Arguments: basic usage</a>
+  <br/>
+  <a href="clarguments-advanced.html">Jalview Command Line Arguments: advanced usage</a>
+  <br/>
+  <a href="clarguments-argfiles.html">Jalview Command Line Arguments: argfiles</a>
+  </p>
+
+  <hr/>
+
+  <p>
+  From version 2.11.3.0 Jalview processes a new set of command line arguments
+  which allow more powerful and flexible combinations of arguments, though can
+  also be used for very simple use cases too.
+  </p>
+
+  <p>
+  These new arguments are all accessed with a <code>--doubledash</code> form of
+  command line argument (with the one exception where simply opening one or more
+  files can be performed without any arguments other than the filenames).
+  </p>
+
+  <p>
+  The old command line arguments can still be used (see
+  <a href="clarguments-old.html">the old page on command line arguments</a>) so
+  existing scripts utilising them should not break.
+  <br/>
+  <strong>These are now deprecated and will be removed</strong> in a future version of Jalview.
+  </p>
+
+  <p>
+  However, you cannot mix old and new style arguments, so if you use any
+  <code>-singledash</code> arguments (with the exception of <code>-help</code> or <code>-h</code>), they will all be interpreted as
+  old style arguments with the new <code>--doubledash</code>
+  arguments being ignored.  If you have a script
+  that uses the old arguments without any dashes, and uses the bare-word
+  <code>open</code> then these will also be interpreted as old style arguments.
+  </p>
+  <p>
+  <strong>Warning!</strong> If you use command line arguments without any dashes and
+  <em>don't</em> use the bare-word argument <code>open</code> then all
+  your arguments will be interpreted as alignment files to be opened by the
+  new command line argument process!
+  </p>
+
+  <p>
+  To launch Jalview from the command line, see
+  <a href="commandline.html">running Jalview from the command line</a>.
+  </p>
+
+  Continue to <a href="clarguments-basic.html">Jalview Command Line Arguments: basic usage</a>.
+
+
+</body>
+</html>