Overview

BRAHMS is implemented as a native executable, and thus, in the end, it is invoked from the operating system command line (shell). This page details this interface. The BRAHMS executable is actually called brahms-supervisor, but you should not call this directly - call the shell script wrapper brahms, which does the same thing, but makes minor adjustments to your environment to make things go smoothly. Now forget I ever mentioned brahms-supervisor - I'm now removing it from your mind, the sun is shining, the donkeys are playing in the meadow, it's fading, it's fading, it's gone.

Interface

The BRAHMS executable is called brahms. Type brahms at a shell prompt to see the documentation for the command line interface. At time of writing, the output below was already out of date - try it with your own installation to see what options are currently available.

OS Shell Prompt
BRAHMS Version 0.7.2.1729 Copyright (C) 2007 Ben Mitchinson BRAHMS comes with ABSOLUTELY NO WARRANTY. This is free software, and you are welcome to redistribute it under certain conditions. For details, type "brahms --license", and/or visit us at http://brahms.sourceforge.net Usage: brahms <exefile> <option> <option> brahms <operation> <exefile> normal usage is to pass a single argument, the name of a BRAHMS Execution File. see the documentation (via sourceforge site) for details of how to construct one. operations: --license show release license --credits show credits --version show detailed version information --walk walk the namespace for cached components... --Walk ...and load each one for more info... --WALK ...including non-native components. --show-pars report applicable Execution Parameters options: --voice-i set this to be the ith voice (sockets only) --voice-mpi get voice index from MPI layer (mpi only) --pause pause before exiting worker threads --detail-X set detail level X (c,w,i,v,1-5), default i --par-x-y set Execution Parameter 'x' to value 'y' shortcuts: --nothreads --par-MultiThread-0 True, false, or stupid? The life span of a taste bud is ten days but the cells are constantly being renewed, roughly one every ten hours.

Arguments

Arguments are not documented here yet - you should be able to work it out from the above usage information, though.