<i class="fa fa-rocket"></i> Quick start

Version: 0.2.x

OcLaunch is very easy to use.
But first, let's install it. You have several options:

Quick and dirty

If you don’t want to test OcLaunch with 0install or opam as describeb below, you can compile from sources or use the binary inside 0install archives in this directory

Installation

TL;DR

Goto this page and follow instructions.

0install

Introduction

With this method, you will get a binary so that you do not have to compile the program, which can be a quite complicated and long step.

Get 0install

If you do not have 0install installed: see installation instructions, especially here.

Install OcLaunch

You can find instructions on this page.

You should create an alias, as explained on this page.

$ 0alias oclaunch http://download.tuxfamily.org/oclaunch/oclaunch.xml

Errors

If you get an error such as

export PATH=/home/you/bin/:$PATH

It means that 0install can not define the new application in your $PATH. So it define it elsewhere and want you to add this folder to your path. You should add the export... line to your bashrc, so you can use 0install easier.

Test that all work

In the rest of the document, we assume that the oclaunch command is found if you enter it in your terminal.
To test, just open a new one and enter

oclaunch -help

It should return something like this :

OcLaunch program is published under CeCILL licence. See
    https://gitlab.com/WzukW/oclaunch for details.

  oclaunch.byte [COMMAND NUMBER]

See https://gitlab.com/WzukW/oclaunch for help.

=== flags ===

  [--reset-tmp]  Reinitialises launches by deleting temporal file.
                 (aliases: -reset-tmp, -r)
  [-build-info]  print info about this build and exit
  [-version]     print the version of this build and exit
  [-help]        print this help text and exit
                 (alias: -?)

Update

To update the software, you may use

0install update [the name you choose for oclaunch]

0launch -r http://download.tuxfamily.org/oclaunch/oclaunch.xml -version

This will allow you to refresh OcLaunch and display the new version number.

Opam

You can install it with Opam.

opam install oclaunch

If possible, try to use the latest version, which is not using the dependency core_extended quite long to build.

Want to build from an archive, git repository

Pick up the url of the code in this list of places. You will then do

opam pin add oclaunch-dev url

remplace oclaunch-dev by the name of the package and url by the url picked up earlier.

You may find further instructions for the git repository in this blog post.

Some old archives are not compatible with opam. Use the following method.

From the sources

Why build from sources

Even if precompilled binaries are available, you may build the program from source. You may not trust binaries and want to use code you verified yourself.
Or you want to get the latest version, a beta one or to build from the git repository.

Building

Get the sources in this list (both git and tarballs).

You will find in the repository or in most archives an Install.md file. Dependancies are listed. The main ones are Core and YoJson.

Briefly, you may run

 ocaml setup.ml -configure
 ocaml setup.ml -build
 ocaml setup.ml -install

Contact me if you have any problem.

Use

Add command to launch

Add command throw cat | oclaunch -a, enter your commands (one per line) and finish by

They are put in ```~/.oclaunch_rc.json```.   
You can find an example on <doc href="rc-example" type="page">this wiki</doc>.

#### Last step
Just add the following line to ```~/.bashrc```

oclaunch


This will allow you to launch each command added on terminal call.

A complete help is displayed with

oclanch --help ```

A detailed example is available here.

Enjoy ;-)

Help

There are several solutions to get help.

OcLaunch Launch automagically