*****************************
mapWOC-Kommandozeilenwerkzeug
*****************************

Dieses Kapitel beschreibt, wie Sie mapWOC mit den vorhandenen Kommandozeilenbefehlen
(automatisiert) steuern können.

**Installation**: Um die mapWOC-Kommandozeilenwerkzeuge nutzen zu können, müssen Sie 
zunächst das Paket *mapwoc-cli* installieren: ::

   apt-get install mapwoc-cli


Um mapWOC **automatisiert ablaufen** zu lassen (z.B. täglich eine neue URL-Liste hochladen,
Scan anlegen und Scan starten), empfiehlt es sich, die einzelnen mapWOC-Kommandozeilenbefehle
in einem kombinierten Shell-Skript (per cronjob) zu verwenden. Ein solches Beispiel-Skript finden Sie
unter http://hg.intevation.org/mapwoc/file/tip/cli/example.sh.


mapwoc-upload-urllist
======================

*mapwoc-upload-urllist* lädt eine vorhandene Textdatei mit URLs (pro Zeile eine URL)
zu mapWOC hoch und legt diese URL-Liste in mapWOC an. Als Rückgabewert wird die ID der
neuen URL-Liste (auf stdout) zurückgegeben.

``mapwoc-upload-urllist -h`` gibt Ihnen einen Überblick aller verfügbaren **Optionen**: ::

   usage: /usr/bin/mapwoc-upload-urllist options
   
   Upload an urllist and print the ID of the uploaded list to stdout.
   
   All parameters (except -h) are mandatory.
   The GUI is expected to deliver english messages and to be in version 1.2 .
   
   OPTIONS:
      -s      Server address (and port, if necessary, e.g. https://localhost:999)
      -u      User name
      -p      Password
      -h      Show this message
   
      -f      URL list file
   
   Example:
       /usr/bin/mapwoc-upload-urllist -s http://bob:5000 -u cli_user -p example
         -f ~/myurllist.txt


mapwoc-create-scan
==================

*mapwoc-create-scan* legt einen Scan in mapWOC mit den angegebenen Parameter an.
Als Rückgabewert wird die ID des neuen Scans (auf stdout) zurückgegeben.

``mapwoc-create-scan -h`` gibt Ihnen einen Überblick aller verfügbaren **Optionen**: ::

   usage: /usr/bin/mapwoc-create-scan options
   
   Creates a scan with the given parameters and returns its ID to stdout.
   
   All parameters (except -h) are mandatory.
   The GUI is expected to deliver english messages and to be in version 1.2 .
   
   OPTIONS:
      -s      Server address (and port, if necessary, e.g. https://localhost:999)
      -u      User name
      -p      Password
      -h      Show this message
  
      -n      Name for the created scan
      -c      hcsid,node of HoneyClient to chose
      -l      ID of url-list to use
      -q      Number of HoneyClients to use (of given name, parameter -c)
  
   
   Example:
   
       /usr/bin/mapwoc-create-scan -s http://bob:5000 -u cli_user -p example 
        -n "Command Line Scan" -c slitaz_shiretoko_base,example_node -q 1 -l 10


mapwoc-start-scan
=================

*mapwoc-start-scan* startet einen vorhandenen Scan in mapWOC.

``mapwoc-start-scan -h`` gibt Ihnen einen Überblick aller verfügbaren **Optionen**: ::

   usage: /usr/bin/mapwoc-start-scan options
   
   Start a MapWOC scan identified by its ID.
   
   All parameters (except -h) are mandatory.
   The GUI is expected to deliver english messages and to be in version 1.2 .
   
   OPTIONS:
      -s      Server address (and port, if necessary, e.g. https://localhost:999)
      -u      User name
      -p      Password
      -h      Show this message
   
      -i      ID of scan
   
   Example:
   
       /usr/bin/mapwoc-start-scan -s http://bob:5000 -u cli_user -p example -i 16
    

mapwoc-stop-scan
================

*mapwoc-stop-scan* startet einen vorhandenen Scan in mapWOC.

``mapwoc-stop-scan -h`` gibt Ihnen einen Überblick aller verfügbaren **Optionen**: ::


   usage: /usr/bin/mapwoc-stop-scan options
   
   Stop a running MapWOC scan.
   
   All parameters (except -h) are mandatory.
   The GUI is expected to deliver english messages and to be in version 1.2 .
   
   OPTIONS:
      -s      Server address (and port, if necessary, e.g. https://localhost:999)
      -u      User name
      -p      Password
      -h      Show this message
   
   Example:
   
       /usr/bin/mapwoc-stop-scan -s http://bob:5000 -u cli_user -p example