source: trunk/etc/yhelp @ 1

clear
cat << EOF
 ==================    YAO HELP     ===================
 YAO :
     génération (V7)              : YaoG  prjname
     compilation sans génération  : YaoG -g prjname
     directives list (help)       : YaoG -h

     lancement de l'executable (prjname) :
     - en BATCH : prjname [fileinst]
       si le fichier d'instructions fileinst n'est pas
       indiqué, le fichier prjname.i est recherché et
       utilisé par defaut.
     - en INTERACTIF : prjname -i
       nb1: il est possible en interactif de demander
       l'exécution d'un fichier d'instructions par la
       commande LOAD_INST fileinst
       nb2: la commande HELP affiche la liste des
       instructions disponibles


 YAO UTILITIES : --------------------------------------

 yrms  f1 f2 zspace [f3] : compute the rms between
       file f1 & f2 by block of zspace and put the
       result out to file f3 or on screen if any

 yf2m  f1 mf ncol : make the sequential file f1 out to
       a ncol column matrice (matlab) file mf

 yvizug file edgr grviz fmtgr name : graphic visuali-
       zation of a graphic text file.dot with a graphic
       editor (edgr) as xv, ... using a graphviz graphic
       constructor programme (grviz) as dot, circo, ...
       to a graphic format (fmtgr) as png, gif, ...
       selecting a modul name (ie a node name); if 'all'
       is given, the complete graph will be drawn.
       a file file.fmtgr is provided.
       default is similar to :
          yvizug *.dot xv circo png all
       which provide the file yvisug.png 

 YAO MATLAB PROCS : -----------------------------------

 y2dsurfm file ncol nlig dskip opt : graphic matlab
          function for surfacing a ascii matrice file
          - file must be a ncol matrice file (see yf2m)
          - ncol and nlig are the matrix dimensions
          - dskip (>0) definition (lower->better)
          - opt : display option : see inside the proc

 y2dsurf file ncol nlig oaxis dskip opt : nearly same
         as y2dsurf except that the file in is only a
         sequentiel one (it is not a matrix file) so
         one must indicate with oaxis the axes ordering

 y2dquiv ufile vfile ncol nlig oaxis dskip opt :
         similare to y2dsurf but for vorticity vector
         ploting so ufile and vfile should contain the
         component for axes X and Y respectively

 y2dquivm ufile vfile ncol nlig dskip opt : idem as
         y2dquiv but for matrix ascii files

 ================  THAT'S ALL FOLKS  ==================

EOF