                         bouml via line commands
                         -----------------------

Bouml supports command line manipulations within a Terminal window 
(like 
"bouml <project_file>" to open a project file
"bouml <project_file> -exec <plugout_name> -exit" to run a plugout on a 
project file and exit immediately ...)
See bouml documentation for more details.


With this MacOSX port, these facilities need a specific installation 
described below.

NOTE: This installation procedure supports tcsh and bash as default shells
(if you default shell is another one, functionnality is not guaranteed).



          ==========================================
          User-level installation
          ==========================================


INSTALLATION (at the level of the user) :
-----------------------------------------

1) In a terminal window ($> symbolizes the prompt), type the following 
commands (first, go to the directory when this file is located, second, 
run install). 

$> cd name_of_folder_where_bouml_is/bouml/CommandLineSupport
$> tcsh cl_Install.csh

  CAUTION: Installation will not work properly of you do not
  run it from the CommandLineSupport folder. 


2) If you DO NOT use tcsh NOR bash, the bouml_init.csh script will 
be generated for tcsh :

-- first, ensure that its syntax is correct for your shell (or modify 
   it accordingly) ;
-- then, insert the following line into you login file (.login or 
  whichever according to the shell you use),

test -r $HOME/bouml_init.csh && source $HOME/bouml_init.csh

  NB. if  you do use tcsh or bash, this was automatically done during step 1)


3) Close all the opened Terminal windows.


The next time you open a Terminal window, you have access to all 
the bouml commands.


IMPORTANT NOTES : 
i)   If the location of the bouml application is changed (for any reason),
     you HAVE TO re-run this installation from step 1)
ii)  this installation creates two files into you HOME 
     folder : bouml_init.csh, .boumlb
     -- DO NOT edit nor destroy theses files.
     -- To delete theses file, see UNINSTALLATION below.



UNINSTALLATION (at the level of the user) :
-------------------------------------------
If you do not want to use line commands any longer, open a Terminal window and 
type the following command :

$> tcsh name_of_folder_where_bouml_is/bouml/CommandLineSupport/cl_UnInstall.csh

That's all.




          ==========================================
          System-wide installation
          ==========================================



INSTALLATION (system-wide -- needs sudo privilege) :
---------------------------------------------------

In a terminal window (first, go to the directory when this file 
is located, second, sudo run install). 

$> cd name_of_folder_where_bouml_is/bouml/CommandLineSupport
$> sudo tcsh cl_Install.csh


IMPORTANT NOTE :
system wide installation creates files /.boumlb and /etc/bouml/bouml_init.csh,
and modifies the file /etc/csh.login (if you use tcsh tcsh) or /etc/bashrc (if
you use bash).
Run un-installation (see below) to cancel theses modifications of your system



UNINSTALLATION (system wide -- needs sudo privilege) :
------------------------------------------------------
If you do not want to use line commands any longer, open a Terminal window and 
type the following command :

$> sudo tcsh name_of_folder_where_bouml_is/bouml/CommandLineSupport/cl_UnInstall.csh

That's all.
