X-Git-Url: http://source.jalview.org/gitweb/?a=blobdiff_plain;ds=sidebyside;f=help%2Fhelp%2Fhtml%2Ffeatures%2Fcommandline.html;h=b16274057a69b0e3cc030bdb34f9eec371fc2dc8;hb=958a0e91dec242191ec7543ab3f23b7e508e1112;hp=0ef78f9c0646d75672f2430d41e5936f427ff456;hpb=a9f2db2f1688164dd54da7521509c135d7fdf042;p=jalview.git diff --git a/help/help/html/features/commandline.html b/help/help/html/features/commandline.html index 0ef78f9..b162740 100644 --- a/help/help/html/features/commandline.html +++ b/help/help/html/features/commandline.html @@ -28,25 +28,133 @@
Jalview can be run from the command line, and provides a range of arguments. These arguments - can also be passed via .JVL files, which are opened - automatically by the Jalview application when double-clicked in a - file browser on Windows and OSX. + href="clarguments.html">range of arguments.
- The way that you launch Jalview from the command line depends on the - platform you are on, and how it has been installed. +There are a few different ways to do this:
++ Jalview's command line launch +
Since version 2.11.2, the Jalview native application includes a launching shell script. This is the easiest way to + launch an installed Jalview application from the command line.
To run the launch script, simply open a Terminal (or Command prompt on Windows), and type:
+ jalview+ + +
There are some important differences between the using the launching script and launching Jalview from its icon: +
+
+ If typing 'jalview' in the terminal prompt (or windows command line)
+ doesn't work then you will need to add the location of the jalview
+ launch script to your
+ PATH
.
+ How you do this depends on your operating system. +
+ +In Linux or Unix (jalview.sh
)
Running the Linux installer will give you the option of adding a symbolic link to
+ that script in your $PATH
, if it finds a suitable place that your user can add such a
+ link (e.g. ~/bin
, ~/.local/bin
, ~/local/bin
, ~/opt/bin
). If you chose that option then
+ you should be able to launch Jalview on the command line with the simple command
+
jalview+ If you didn't choose that option during installation (or used an earlier version installer), or wish to make another symbolic link, you can link to the + launching shell script with the command +
ln -s /PATH_TO_JALVIEW/bin/jalview.sh jalview+ or you could add
/PATH_TO_JALVIEW/bin
to your own $PATH
as it already contains a symbolic link jalview
.
+ In Windows (jalview.bat
, jalview.ps1
)
The Windows installer will give you the option of adding Jalview's script folder to your %PATH%
allowing you to launch Jalview
+ in a Command Prompt simply with the command
+
jalview+ If you didn't choose that option during installation (or used an earlier version installer), you can either + +
\PATH_TO_JALVIEW\bin
folder to your %PATH%
, or
+ \PATH_TO_JALVIEW\bin\jalview.bat+ (you can leave off the
.bat
extension if you want).
+ jalview.bat
file is a generic wrapper around the
+ PowerShell script jalview.ps1
in the same folder. This PowerShell script should work with both
+ PowerShell 5.x (which is installed by default on all modern Windows machines), and also PowerShell 6.0+
+ which might have been installed afterwards.
+ In macOS (jalview
)
We don't currently provide a macOS installer program, so you + will need to add the command to you path manually. The script you + should use to launch Jalview is linked to as +
/Applications/Jalview.app/Contents/MacOS/jalviewso you + can run that command with its full path, or make your own symbolic + link to there, or add that folder to your
$PATH
. echo /Applications/Jalview.app/Contents/Resources/app/bin | sudo tee -a /etc/paths.d/Jalview+ This adds the directory + "/Applications/Jalview.app/Contents/Resources/app/bin/" + to a "Jalview" file in the /etc/paths.d/ directory. The + lines from all the files in this directory are added the $PATH + variable for all shells and users. + +
+ If you cannot see the
+ jalview
+ command in the MacOS directory, then you probably have an older
+ Jalview installation. In that case, you should make a symbolic link
+ directly to the launch script with the command
+
ln -s /Applications/Jalview.app/Content/Resources/app/bin/jalview.sh jalview+ If this doens't work, check your installation is running + Jalview 2.11.2.0 or later. + +
+ If you are using a version of Jalview prior to 2.11.2, you can still launch from the command line, but you will have to + use a more platform specific way to launch and use command line arguments.
- /PATH_TO_JALVIEW/Jalview -open https://www.jalview.org/examples/jpred_msa.fasta -annotations https://www.jalview.org/examples/jpred_msa.seq.concise -colour Clustal+
/PATH_TO_JALVIEW/Jalview -open https://www.jalview.org/examples/jpred_msa.fasta -annotations https://www.jalview.org/examples/jpred_msa.seq.concise -colour Clustal
- \PATH_TO_JALVIEW\Jalview.exe -open %HOMEPATH%\myalignment.fa+
\PATH_TO_JALVIEW\Jalview.exe -open %HOMEPATH%\myalignment.fa
-open /Applications/Jalview.app --args -open ~/myalignment.fa(put - all the Jalview arguments after the --args parameter) -
open /Applications/Jalview.app --args -open /FULL/PATH/TO/myalignment.fa+ (put all the Jalview arguments after the --args parameter, and note that all files must be specified with their full paths) +
<Path to Java home>/bin/java -jar <Path to Jalview Jar>/jalview-all-1.8.jar -open myalignment.fa
- Use '-help' to get more information on the command line arguments that Jalview accepts.
@@ -85,10 +193,13 @@ open /Applications/Jalview.app --args -open ~/myalignment.fa(put