website/man_client.jsp

   1 <%--<?xml version="1.0" encoding="ISO-8859-1" ?>--%>
   2 <%--<%@ page language="java" contentType="text/html; charset=ISO-8859-1" pageEncoding="ISO-8859-1"%>--%>
   3
   4 <%@ taglib prefix="c" uri="http://java.sun.com/jsp/jstl/core" %>
   5 <%@ taglib uri="http://java.sun.com/jsp/jstl/functions" prefix="fn" %>
   6 <%@ taglib uri="http://java.sun.com/jsp/jstl/fmt" prefix="fmt" %>
   7 <%@ taglib uri="http://displaytag.sf.net" prefix="dt" %>
   8
   9
  10 <c:import url="template_header.jsp" >
  11     <c:param name="title">Documentation</c:param>
  12 </c:import>
  13
  14 <ol class="breadcrumb">
  15     <li><a href="${pageContext.request.contextPath}/index.jsp">Home</a></li>
  16     <li><a href="man_docs.jsp">Documentation</a></li>
  17     <li class="active"><a href="man_server_dev.jsp">Develop JABAWS</a></li>
  18 </ol>
  19 <div class="row" id="usingcclient">
  20     <div class="col-md-12">
  21         <div class="panel panel-default">
  22             <div class="panel panel-heading">
  23                 <h1 class="panel-title">JABAWS Command Line Client Usage</h1>
  24             </div>
  25             <div class="panel-body">
  26                 <p class="justify">
  27                     The command line client comes as a part of
  28                     <a href="http://gjb-www-1.cluster.lifesci.dundee.ac.uk:8086/download"> client package</a>
  29                     which you are welcome to download.
  30                     The command line client can be used to align sequences using any of JABAWS supported web
  31                     services. The client is OS independent and supports most of
  32                     the functions which can be accessed programmatically via
  33                     <a href="dm_javadoc/index.html">JABAWS API</a>. Using this client you could align sequences
  34                     using presets or custom parameters, please see examples of this below. Here is the
  35                     list of options supported by the command line client.
  36                 </p>
  37                 <pre><strong>Usage:</strong>
  38 java -jar &lt;path_to_jar_file&gt; -h=host_and_context -s=serviceName ACTION [OPTIONS]
  39 -h=&lt;host_and_context&gt; - a full URL to the JABAWS web server including context path e.g. http://10.31.10.159:8080/ws
  40 -s=&lt;ServiceName&gt; - one of [MafftWS, MuscleWS, ClustalWS, ClustalOWS, TcoffeeWS, ProbconsWS, AAConWS, JronnWS, DisemblWS, GlobPlotWS, IUPredWS]
  41 <br/>
  42 <strong>ACTIONS:</strong>
  43 -i=&lt;inputFile&gt; - full path to fasta formatted sequence file, from which to align sequences
  44 -parameters - lists parameters supported by web service
  45 -presets - lists presets supported by web service
  46 -limits - lists web services limits
  47 Please note that if input file is specified other actions are ignored
  48 <br/>
  49 <strong> OPTIONS:</strong> (only for use with -i action):
  50 -r=&lt;presetName&gt; - name of the preset to use
  51 -o=&lt;outputFile&gt; - full path to the file where to write an alignment
  52 -f=&lt;parameterInputFile&gt; - the name of the file with the list of parameters to use.<br />
  53 Please note that -r and -f options cannot be used together. Alignment is done with either preset or aparameters from the file, but not both!</pre>
  54
  55                 <p class="justify">
  56                     Align sequences from input.fasta file using Mafft web
  57                     service with default settings, print alignment in Clustal format to console.
  58                 </p>
  59                 <pre><code class="bash">java -jar jabaws-min-client.jar -h=http://myhost.compbio.ac.uk:8080/jabaws -s=MafftWS -i=d:\input.fasta</code></pre>
  60                 <p class="justify">
  61                     Content of input.fasta file is show below (please note sequences has been
  62                     trimmed for clarity)
  63                 </p>
  64                 <pre>&gt;Foobar
  65 MTADGPRELLQLRAAVRHRPQDFVAWL
  66 &gt;Bar
  67 MGDTTAGEMAVQRGLALHQ
  68 &gt;Foofriend
  69 MTADGPRELLQLRAAV</pre>
  70                 <p class="justify">
  71                     Align as in above example, but write output alignment in a
  72                     file out.clustal, using parameters defined in prm.in file
  73                 </p>
  74                 <pre><code class="bash">java -jar jabaws-min-client.jar -h=http://myhost.compbio.ac.uk:8080/jabaws  -s=MafftWS -i=d:\input.fasta -o=d:\out.clustal -f=prm.in</code></pre>
  75                 <p class="justify">
  76                     The content of the prm.in file is shown below
  77                 <pre><code class="bash">--nofft
  78 --noscore
  79 --fastaparttree
  80 --retree=10
  81 --op=2.2</code></pre>
  82                 <p class="justify">
  83                     The format of the file is the same for all JABAWS web services.
  84                     Parameters are specified in exactly the same way as for native
  85                     executables - alignment programs like Mafft etc. So parameters
  86                     which you can use with command line version of an alignment program
  87                     can be used with JABAWS. Most of the settings controlling alignment
  88                     process are supported, but because any output has to be handled by
  89                     JABAWS, settings controlling output are not allowed to be changed.
  90                     For a list of parameters supported by a web service see the next example.
  91                     In <em2>prm.in</em2> parameters are separated by the new line, and
  92                     name of the parameter is separated from its value with an equals
  93                     sign. This format is constant no matter which JABAWS web service is used.
  94                 </p>
  95                 <pre><code class="bash">java -jar jabaws-min-client.jar -h=http://myhost.compbio.ac.uk:8080/jabaws -s=MafftWS -parameters</code></pre>
  96
  97                 <p class="justify">
  98                     The same client can be used to access JABAWS on different hosts.
  99                     Just point the client to the host you want to use by changing the
 100                     value of -h key.
 101                 </p>
 102                 <p class="justify">
 103                     For example you used
 104                     <em2>-h=http://myhost.compbio.ac.uk:8080/jabaws</em2> server,
 105                     now you want to use another server to
 106                     <em2>-h=http://mylabserver.myuni.edu.</em2> This comes handy if
 107                     your favorite server is off and you need to do the job yesterday.
 108                 </p>
 109
 110             </div>
 111         </div>
 112     </div>
 113 </div>
 114
 115 <jsp:include page="template_footer.jsp" />