next up previous contents index
Next: List of modules Up: System's macros Previous: System's macros   Contents   Index


Macros summary

The next pages describe each system's macro; the list is in alphabetical order.

$ \bigcirc$Macro


cmw2 - The MegaWave2 Compiler




$ \bigcirc$Usage


cmw2 [-gnu] [-g] [-X] [-O] [-c cc_option] [-Dname[=def]] [-Uname] [-Ipathname]
[-v] [-w] [-Ldirectory] [-llibrary] [-dep] [-pubsyslib] [-N] module


$ \bigcirc$Description


This command compiles a MegaWave2 module given by module. Since version 1.41 of this system's macro, module may also be a User's macro. In that case, cmw2macro is called. Please refer to Section 1.9 page [*] to learn more about this compilation. The module must be located into a subdirectory of $MY_MEGAWAVE2 (plain user) or of $MEGAWAVE2 (administrator only).




$ \bigcirc$Options


-gnu : Use the Gnu C compiler gcc instead of the standard C compiler cc.

-g : Debug flag. Cause the compiler to generate additional information needed by the symbolic debugger. This option is normally incompatible with optimization.

-X : XMegaWave flag. Cause the compiler to generate an interface to include the module in the XMegaWave2 software.

-O : Invoke the C optimizer. This option is normally incompatible with debugging.

-c : pass the following argument cc_option to the compiler.

-Dname : Define name to the preprocessor, as if by '#define'. If your compiler uses the ANSI mode, you should define the name __STDC__.

-Uname : Remove any initial definition of name in the preprocessor.

-v : Verbose mode. Print messages about what command is running, together with the name of temporary files. In this mode, temporary files are not deleted so you can edit them or run the commands manually.

-w : Suppress warning messages.

-Ipathname : Change the algorithm used by the preprocessor for finding include files to also search in directory pathname.

-Ldirectory : Change the algorithm used by the linker to search for the libraries. The -L option causes the compiler to search in directory before searching in the default locations.

-llibrary : Include additional library given by library for linking.

-dep : Dependencies list. Cause the compiler to generate a primary dependencies list of the module. See the macro mwdep for more information.

-pubsyslib : Link module with the PUBLIC system library (adm only).

-N : Do not propose to run lint (a C program checker/verifier) in case of compilation error.

$ \bigcirc$Macro


cmw2_all - Compile all MegaWave2 Modules




$ \bigcirc$Usage


cmw2_all [-gnu] [-clear] [-g] [-X] [-O] [-c cc_option] [-Dname[=def]] [-Uname]
[-Ipathname] [-w] [-Ldirectory] [-llibrary] [-2p] [-sp] [-dep]
[-pubsyslib] [-force] [-v tracefile] [-N processid] src_directory




$ \bigcirc$Description


This command compiles all MegaWave2 modules being in the given directory src_directory, and recursively in all subdirectories of src_directory. It basically calls cmw2 as many time as necessary. The location pointed by src_directory has to be a subdirectory of $MY_MEGAWAVE2 (plain user) or of $MEGAWAVE2 (administrator only).


$ \bigcirc$Options


-gnu : Use the Gnu C compiler gcc instead of the standard C compiler cc.

-clear : Clear the following target directories before processing the compilations: bin, lib, obj, mwi and doc/obj (confirmation is requested). This option allows to clean the target directories; otherwise old modules stay in those directories even if the sources have been deleted (but if the system's macro mwrm was used).

-sp : Second pass. Do not compile a module if it has been already successfully compiled. This option works only with linkers which do not set a binary containing unresolved symbols to be executable.

-2p : Two pass. During the first pass, all the modules are compiled. The second pass calls cmw2_all with -sp. This option allows modules which depend on other modules to be successfully compiled after the second pass. This option works only with linkers which do not set a binary containing unresolved symbols to be executable.

-g : Debug flag. Cause the compiler to generate additional information needed by the symbolic debugger. This option is normally incompatible with optimization.

-X : XMegaWave flag. Cause the compiler to generate an interface to include the modules in the XMegaWave2 software.

-O : Invoke the C optimizer. This option is normally incompatible with debugging.

-c : pass the following argument cc_option to the compiler.

-Dname : Define name to the preprocessor, as if by '#define'. If your compiler uses the ANSI mode, you should define the name __STDC__.

-Uname : Remove any initial definition of name in the preprocessor.

-Ipathname : Change the algorithm used by the preprocessor for finding include files to also search in directory pathname.

-Ldirectory : Change the algorithm used by the linker to search for the libraries. The -L option causes the compiler to search in directory before searching in the default locations.

-llibrary : Include additional library given by library for linking.

-w : Suppress warning messages.

-dep : Dependencies list. Cause the compiler to generate the primary dependencies list of each module. See the macro mwdep for more information.

-force : Do not ask confirmation before removing target directories.

-v tracefile : Verbose. Output trace of compilations in the file tracefile that can be viewed after the command ends.

-pubsyslib : Link modules with the PUBLIC system library (adm only).

-N processid : Internal use only.

$ \bigcirc$Macro


cmw2macro - Compile a user's macro : make it available and generate the document skeleton




$ \bigcirc$Usage


cmw2macro [-adm] [-ret] [-path path] [-absolute] macro




$ \bigcirc$Description


This command writes the document skeleton (the .doc file) corresponding to the macro macro, and it creates a symbolic link in $MY_MEGAWAVE2/shell (or in $MEGAWAVE2/shell if the option -adm is selected), so that you can call these macro from any location. You should not have to use directly this command, since it is called by cmw2, mwmakedoc or mwdoclatex when needed.


$ \bigcirc$Options


-adm : search macro in $MEGAWAVE2 (instead of $MY_MEGAWAVE2.

-ret : return filename (with pathname) of the document skeleton.

-path path : search macro in path (instead of $MY_MEGAWAVE2.

-absolute : create link using absolute pathname (since cmw2macro version 2.08, default is to create link with relative pathname).

$ \bigcirc$Macro


cxmw2 - The XMegaWave2 Compiler




$ \bigcirc$Usage


cxmw2 [-gnu] [-g] [-O] [-Dname[=def]] [-Uname] [-Ipathname] [-w] [-Ldirectory]
[-llibrary] modules_file




$ \bigcirc$Description


This command allows to compile your own version of the XMegaWave2 software. The version is defined by the modules you want to include in the software. Each module name will appear into a window panel, inside a window hierarchy defined by the group of the module. The input of cxmw2 is an ascii file which gives the list of the modules to include together with the groups hierarchy. Please see Section 5.2 to learn more about the format of this file. In order to be included in XMegaWave2, each module must have been compiled with cmw2 using option -X.

The name of the XMegaWave2 run-time program is myxmw2.


$ \bigcirc$Options


-gnu : Use the Gnu C compiler gcc instead of the standard C compiler cc.

-g : Debug flag. Cause the compiler to generate additional information needed by the symbolic debugger. This option is incompatible with optimization.

-O : Invoke the C optimizer. This option is incompatible with debugging.

-Dname : Define name to the preprocessor, as if by '#define'.

-Uname : Remove any initial definition of name in the preprocessor.

-Ipathname : Change the algorithm used by the preprocessor for finding include files to also search in directory pathname.

-Ldirectory : Change the algorithm used by the linker to search for the libraries. The -L option causes the compiler to search in directory before searching in the default locations.

-llibrary : Include additional library given by library for linking.

-w : Suppress warning messages.

$ \bigcirc$Macro


mwmakedoc - Make a new documentation for the modules (Volume 3)




$ \bigcirc$Usage


mwmakedoc [-c] [-h] [-N] [-g group_directory] [-nobin] [+/-index] [+/-html]
mw2dir


$ \bigcirc$Description


This command creates the TEX files corresponding to the Volume Three of the MegaWave2 guides (``MegaWave2 User's Modules Library''). The documentation is written in order to keep consistency with the current MegaWave2 modules and macros put in the directory mw2dir (e.g. $MEGAWAVE2, $MY_MEGAWAVE2 or a selected copy of such directories). The TEX files are written in the directory mw2dir/doc, so you need write permission in this directory. The modules, located into mw2dir/src, must have been compiled in order to fill the target directories mw2dir/bin and mw2dir/doc (not applicable for macros). Each module and macro must be documented that is, a M.tex file must be written in mw2dir/doc for all M modules and macros (see Section 7 for more information).

In order to compile the documentation, run LATEX several times (as well as other commands, such as mwmodbibtex and makeindex) as mentioned at the end of the execution of this command, or set option -compile.




$ \bigcirc$Options


-c : Compile the documentation (Volume 3) after TEX files have been created.

-h : Make a html (HyperText Markup Language) version of the documentation (Volume 3) using latex2html. Need -c. The generation of all html files may take a while.

-N : Identify the command to be not the primary process (internal use).

-g group_directory : Limit the scanning of modules to the given group directory (and sub-directories).

-nobin : Do not check consistency with the binaries (i.e. a module for which the compilation failed may be documented).

+index : Force the creation of an index for the modules. You normally do not need to set this option, since it is the default if the makeidx LATEX package is installed. If the option is set, you will need this package in order to run LATEX on the generated TEX files.

-index : Do not create an index for the modules, even if the makeidx LATEX package is installed.

+html : Force the addition of html code in the TEX files, to make the result of latex2html nicer (this command may be used to translate LATEX files to HyperText Markup Language). You normally do not need to set this option, since it is the default if the html and hthtml LATEX packages are installed. If the option is set, you will need these packages in order to run LATEX on the generated TEX files.

-html : Do not add html code in the TEX files, even if the html and hthtml LATEX packages are installed.

$ \bigcirc$Macro


mwarch - Machine architecture




$ \bigcirc$Usage


mwarch [ -s || -k ]




$ \bigcirc$Description


This command displays the architecture of the current host. MegaWave2 assumes that two machines with the same name returned by mwarch can run the same executables and can link the same objects. Therefore, you may have to call mwarch with the option -s if MegaWave2 supports several implementations (corresponding to incompatible operating systems) for the same machine.

If mwarch returns ``unknown'', you cannot run your version of MegaWave2 on this architecture.




$ \bigcirc$Options


-s : Add to the architecture name a suffix to identify the release of the operating system.

-k : Give long architecture name.

$ \bigcirc$Macro


mwcleandistrib - Clean from objects and old files the MegaWave2 Distribution (adm only)




$ \bigcirc$Usage


mwcleandistrib mw2_distrib_dir




$ \bigcirc$Description


This macro can be used to remove all unnecessary files from the MegaWave2 distribution directory named mw2_distrib_dir (recursively inside each subdirectory), in order to clean it. Files removed are old files generated by emacs (i.e. ending by ~) and objects.




$ \bigcirc$Macro


mwcmwcheck - Check the MegaWave2 compiler (adm only)




$ \bigcirc$Usage


mwcmwcheck




$ \bigcirc$Description


This macro checks the MegaWave2 compiler cmw2 by blind-compiling some standard modules. It is intended to check if the kernel has been correctly installed on a new architecture, before calling cmw2_all. It should be used by the MegaWave2 administrator only, during the installation stage.

In case of errors, the output of cmw2 is displayed and the macro exists with non-null error code. If everything goes well, you should not experiment lot of problems by compiling the whole modules of the standard distribution.




$ \bigcirc$Macro


mwdep - Make all the secondary dependencies lists




$ \bigcirc$Usage


mwdep [ -adm ] [-v]




$ \bigcirc$Description


This command has to be called after all modules have been compiled using the option -dep of cmw2 or cmw2_all, since it needs the primary dependencies lists of each module (files
$MY_MEGAWAVE2/doc/obj/DEPENDENCIES/*.mis). From those files, mwdep generates in
$MY_MEGAWAVE2/doc/obj/DEPENDENCIES the following files, one per module <M>:

The file <M>.dep is included by the documentation file to constitute the ``See Also'' field. Therefore, run mwdep before mwmakedoc, mwdoclatex or mwdocxdvi if you want to get the right ``See Also'' fields in your documentation.

The file <M>.calling is used by cmw2 to issue a warning message when the module <M> is compiled: you should re-compile also all the modules listed in <M>.calling.

Warning : because this command uses the output generated by the link editor, it is linker-dependent. Only a subset of linkers is supported.


$ \bigcirc$Options


-adm : Administrator flag. The developer's directory is $MEGAWAVE2 instead of $MY_MEGAWAVE2. The user must have write permission into this directory.

-v : Verbose. Write more information on the standard output.

$ \bigcirc$Macro


mwdoc - Easy access to the documentation




$ \bigcirc$Usage


mwdoc [<name> || M || S || F || 1 || 2 || 3]




$ \bigcirc$Description


This command offers an easy access to the documentation. Since objects doc files are in the DeVice Independent (DVI) file format, your system must support the DVI previewer xdvi. If you call mwdoc without argument, it will ask you to tell him what kind of doc you are seeking. You may also put directly in argument the doc you want.




$ \bigcirc$Options


<name> : The word <name> is supposed to be the name of a module or of a user's macro. This causes to view the doc of the correponding module or user's macro.

M or m : List all modules and user's macro with a short description.

S or s : List all system's macros with a short description.

F or f : List all available external (file) types with a short description. To reduce the list to the file types you are looking for, after the prompt specify a keyword.

1 : View the Volume 1, MegaWave2 User's Guide.

2 : View the Volume 2, MegaWave2 System Library.

3 : View the Volume 3, MegaWave2 User's Modules and Macros Library.

$ \bigcirc$Macro


mwecho - Portable echo with -n and -E options




$ \bigcirc$Usage


mwecho [-n] [-E] ...




$ \bigcirc$Description


This command emulates a portable echo command with -n and -E options. The command mwecho -n replaces mwechon which is no more furnished.


$ \bigcirc$Options


-n : Do not output the trailing newline.

-E : Disable interpretation of backslash-escaped characters.

$ \bigcirc$Macro


mwinstall - Install MegaWave2 (administrator only)




$ \bigcirc$Usage


mwinstall [-static] [-public || -public=private] [-clear]
[-debug] [-level l] mw2distribution




$ \bigcirc$Description


This command is for the MegaWave2 Administrator only. Remember that the Administrator is the one which is supposed to install, maintain and update MegaWave2 for all users. This command may be called directly, but you may also use the shell Install in the root directory of mw2distribution where mw2distribution is an original MegaWave2 Distribution Package ($PRIVATE_MEGAWAVE2). The main steps of the installation are as follows :

  1. The environment variables needed to run most macros are built, using the macro mwsetenv.
  2. The kernel is compiled for your machine architecture, using installation shells and makefiles located in mw2distribution/kernel. The kernel is composed by the Wdevice library (interface with the Window System), by the System library, and by the preprocessor.
  3. The modules and user's macros are compiled for your machine architecture, using the macro cmw2_all.
  4. The volume 3 of the documentation (User's Modules and Macros Library) is generated, using macros mwdep and mwmakedoc.
  5. If the option -public has been selected, a list of successfully compiled modules and user's macros is written using the macro mwmodlist, and modules and user's macros of this list are installed into the public MegaWave2 using the macro mwmodinstall.

The macro mwinstall is intended to allow an easy installation process on the very most common machines and configurations only. It means that something goes wrong is not an unlikely event. In that case, you will have to correct the wrong things by yourself and to rerun the macro, eventually using the option -level l to avoid levels already completed. Or you will have to make the installation ``manually'' that is, by calling lower-levels macros. Such manual installation is not a bad idea, even if everything goes well with mwinstall. A manual installation allows to customize MegaWave2 more deeply than the standard one. For example, you may want to install in the public MegaWave2 a subset of the private modules only. This can be easily done by editing the list of modules written by mwmodlist, before calling mwmodinstall.

Be aware that, since the installation is machine-dependent, you should install MegaWave2 on each machine architecture for which you want to be able to use it. Of course, if for each installation you specify the same public MegaWave2 directory, source files will not be duplicated.


$ \bigcirc$Options


-static : Make static kernel libraries (by default, kernel libraries are shared). Selecting this option may be hazardous since modules linked with static libraries are of big size. You should use it after having installed the shared libraries only (do not select -clear or you will remove them), so that by default modules would be still dynamically linked. To statically link a module, call cmw2 -c cc_opt with cc_opt the corresponding cc option (e.g. -c -static with gcc). The advantage of a module statically linked lies in the fact that it can be executed without the libraries. In addition, some debuggers have strange behavior when used with dynamically linked modules.

-public : Install two MegaWave2, the private one for the administrator only and the second one for plain users. In this way, the administrator will be able to change and check modules, user's or system's macros and functions of the kernel libraries without touching the public version. This option is obviously usefull only if several persons intensively use MegaWave2, and if you plan to update MegaWave2.

-public=private : Allow other persons than the administrator to use the private MegaWave2. By default, the administrator is the only one supposed to use the private MegaWave2.

-clear : Clear objects in the previous installation.

-debug : Pass the debug option to the C compiler. By default, the C compiler is called with the optimization flag.

-level l : Do not start the installation from the beginning (level 1) but from level l. This supposes that previous levels have been successfully completed. In particular, the environment variables must be correctly set in the shell from which you call mwinstall.

$ \bigcirc$Macro


mwmodbibtex - Run BibTeX on the MegaWave2 documentation (guide #3) and add reference to modules




$ \bigcirc$Usage


mwmodbibtex mw2dir




$ \bigcirc$Description


This command replaces the bibtex command included in standard TEX packages, when compiling the ``MegaWave2 User's Modules Library'' documentation (guide #3) into the subdirectory mw2dir/doc. In addition of calling bibtex to create a bibliography file guid3.bbl, mwmodbibtex adds to the bibliography file a list of references to modules : at the end of each bibliographical reference, the list of modules making citation to this reference is added. As a result of, the guide #3 obtained by normally post-processing the file with LATEX (as written when the command mwmakedoc ends) will contain, in the bibliography section, a list of modules associated to bibliographical references.

As well as bibtex, use of mwmodbibtex assumes at least one bibliographic database (.bib file) exists. The needed one is $MEGAWAVE2/doc/public.bib which contains references for public modules. It is normally included in standard MegaWave2 distribution. Put references for private modules in $MY_MEGAWAVE2/doc/private.bib.

In addition to standard fields one uses into public.bib and private.bib files, one may specify a WWW url by using the special command \hturl, as in the following :

  note   =  "See \hturl{http://www.cmla.ens-cachan.fr/Cmla/Megawave}"
By doing this, the corresponding url will become an active hyperlink when the LATEX documentation file will be processed through the latex2html command (and no error will be encountered if the latex2html package is not available).

Beware : when documenting module M in M.tex, do not collapse citations.
Use e.g. \cite{key1}\cite{key2} instead of \cite{key1,key2}.

$ \bigcirc$Macro


mwmodinstall - Install a new MegaWave2 public modules environment (administrator only)




$ \bigcirc$Usage


mwmodinstall [-clear] [-tdir target_directory]
[-X file_of_xmw2_modules] file_of_modules




$ \bigcirc$Description


This command allows to copy selected modules and user's macros from the source directory $PRIVATE_MEGAWAVE2 to the target directory $PUBLIC_MEGAWAVE2. It can be used by the administrator only to make some private modules available for all. The command copies not only the module sources, but also everything associated such as objects, binaries, documentation and data. The content of $PRIVATE_MEGAWAVE2/data/PUBLIC is always entirely copied.

The file file_of_modules lists the modules to be copied. See Section 5.2 for more informations about such modules file. In the case where your configuration is such that
$PRIVATE_MEGAWAVE2 = $PUBLIC_MEGAWAVE2, this macro is obviously useless.

Before running this command (which may take a while), run mwmodcheck to check the consistency of the modules file regarding the content of the source directory. This macro will tell you any modules listed in the file but not in the source directory, incomplete modules (e.g. without documentation attached) and, for information, modules which will remain private (i.e. in the source directory but not listed in the file).


$ \bigcirc$Options


-clear : Clear previous modules in $PUBLIC_MEGAWAVE2. This option should be used each time the administrator wants to make a complete new version of the public modules.

-tdir target_directory : Change default target directory $PUBLIC_MEGAWAVE2 to be
target_directory.

-X file_of_xmw2_modules : Generate a public XMegaWave2 software containing the modules listed in the file file_of_xmw2_modules.

$ \bigcirc$Macro


mwmodlist - List the modules and macros found in a MegaWave2 source directory




$ \bigcirc$Usage


mwmodlist [-mfile] [-bad] [-group gdir] mw2dir




$ \bigcirc$Description


This command prints all the modules and macros found in the directory mw2dir, which has to be a MegaWave2 directory such as $MEGAWAVE2 or $MY_MEGAWAVE2. In case of a module not successfully compiled, a warning is issued.


$ \bigcirc$Options


-mfile : print the list in the modules file format (which is compatible with input of macros like mwmodinstall). See Section 5.2 for more informations about this format.

-bad : print modules which are not successfully compiled only.

-group gdir : restrict the list to the group and subgroups of gdir.

$ \bigcirc$Macro


mwmodsearch - Search for modules matching words




$ \bigcirc$Usage


mwmodsearch [-l] [-public] [-private] word_1 [word_2 ... word_n]




$ \bigcirc$Description


This command searches for modules and user's macros matching the given list of words. It is useful when you are seeking a specific algorithm without any idea about the module's name or even about the group's name, and when the short function description (as returned by mwmodlist) is not enough to perform a search on.

With mwmodsearch, the search is performed both on the source file and on the documentation (tex file). Only one matching file is enough to satisfy the search. But when several words are given, all words must be found in the same file.

By default, each matching lines are printed together with the name of the file. This may result to a pretty huge number of lines if the words are common. In such a case, use -l and try to reduce the number of matching modules by adding new keywords.




$ \bigcirc$Options


-l : list only. Do not output matching lines, but only the list of matching modules.

-public : restricts search to public modules and user's macros.

-private : restricts search to private modules and user's macros.

$ \bigcirc$Macro


mwnewuser - Create the directory hierarchy for a new user




$ \bigcirc$Usage


mwnewuser




$ \bigcirc$Description


If you are a new user, you may run this command once: it creates the directory $MY_MEGAWAVE2 and all subdirectories needed by the MegaWave2 system's macros.

$ \bigcirc$Macro


mwrm - Remove module(s) or user's macro(s)




$ \bigcirc$Usage


mwrm [-macro] M




$ \bigcirc$Description


This command searches all modules (or user's macros) named M and removes them from the system (confirmation is requested before to operate). By using this command instead of directly removing the source files, you make sure to remove all objects and references attached to the modules.

Only the MegaWave2 administrator should be able to remove public modules and macros. Therefore make sure the $PUBLIC_MEGAWAVE2 directory is not writable for plain users.




$ \bigcirc$Options


-macro : Say that M is a user's macro and not a module. You normally don't need to set this option, since the command recognizes if M is a macro by its name, which should begin with a capital letter.

$ \bigcirc$Macro


mwrnwordmod - Rename words inside modules




$ \bigcirc$Usage


mwrnwordmod [-adm] [-all] [-check] [-d dir] [-f file_of_names]




$ \bigcirc$Description


Sometimes the name of a system's function, of a structure or of a structure field may change. In such a case, you may use this macro in order to automatically perform the change of name inside each modules.

At the location of the macro mwrnwordmod, you can also find the file mwrnwordmod.data : this is an Ascii file which gives the list of words to change, in the obvious format old_name new_name (one change per line).

This list is updated to reflect the last change of names we have performed in the kernel. By default (if you do not use the -f option), this is this file which is read to perform the changes. The mwrnwordmod.data is usefull if you have written lot of modules and if you install a new MegaWave2 kernel, for which some function names or structures have changed.

Warning :




$ \bigcirc$Options


-adm : administrator flag. Scan $MEGAWAVE2/src directory instead of the default $MY_MEGAWAVE2/src

-all : scan all files (not only modules, that is .c files)

-check : check only. See files that would be changed, but change nothing.

-d dir : scan directory dir instead of $MY_MEGAWAVE2/src or $MEGAWAVE2/src.

-f file_of_names : use this file instead of the list given by mwrnwordmod.data.

$ \bigcirc$Macro


mwsetenv - Set up the environment variables needed by MegaWave2 (adm only)




$ \bigcirc$Usage


mwsetenv [-public=private || privateonly] mw2distribution




$ \bigcirc$Description


This command helps the administrator to set the environment variables needed by most user's macros. See Section 2.1.4 to learn more about the environment variables. The directory mw2distribution must corresponds to an original MegaWave2 Distribution Package, its name will be the value set to the variable $PRIVATE_MEGAWAVE2.

As a result of, this macro write two files to be used by the administrator and two files for plain users (one for Bourne-compatible shells and one for C-compatible shells). Those files, which may have to be customized, are to be included in the .profile or the .cshrc file. The location of these files are given at the end of the macro execution.




$ \bigcirc$Options


-privateonly : Select this option if there is no public MegaWave2. By default, this macro considers that both a public MegaWave2 and a private one has to be installed.

-public=private : Select this option if there is no public MegaWave2 and if the installation allows other persons than the administrator to use the private MegaWave2.

$ \bigcirc$Macro


mwsysmaclist - List all system's macros




$ \bigcirc$Usage


mwsysmaclist




$ \bigcirc$Description


This command prints all the system's macros found in the directory $MEGAWAVE2/sys/shell.

$ \bigcirc$Macro


mwvers - MegaWave2 Version




$ \bigcirc$Usage


mwvers [-major || -minor || -variant]




$ \bigcirc$Description


This command returns the current version number of the public MegaWave2 software you are using. Please refer to this version number when you report bugs. On MegaWave2 Version 1.x, this command was available on MegaWave2 system issued from the distribution package only. This is no more the case.


$ \bigcirc$Options


-major : Return the major version number only (e.g. 2 if the full version is 2.00a.12)

-minor : Return the minor version number only (e.g. 00a if the full version is 2.00a.12)

-variant : Return the variant version number only (e.g. 12 if the full version is 2.00a.12)

$ \bigcirc$Macro


mwwhere - Give the location of the source of a module or user's macro




$ \bigcirc$Usage


mwwhere [-macro] [-bin] M




$ \bigcirc$Description


This command returns the path where the source of the given module or user's macro M is found, searching first for private modules and then for public ones.




$ \bigcirc$Options


-macro : Say that M is a user's macro and not a module. You normally don't need to set this option, since the command recognizes if M is a macro by its name, which should begin with a capital letter.

-bin : Return the path if the corresponding binary (executable) exists only. When two paths are returned with this option set, it means that one module is hidden (with default settings, the private module hides the public one). In such a case, the macro exits with value 2.

$ \bigcirc$Macro


mwdoclatex - Make the documentation of a module or of a user's macro




$ \bigcirc$Usage


mwdoclatex [-adm] M




$ \bigcirc$Description


This command compiles a single module documentation file using LATEX. Use it instead of the macro mwmakedoc when you want to print the documentation of only one module or user's macro (for example the one you just finished to write). If you rather want to see the documentation on the screen, use the macro mwdocxdvi.

Run mwdoclatex after cmw2 has been called so that the document skeleton M.doc exists. Make sure to have written the corresponding TEXfile (M.tex), see Section 7.

This command calls LATEX and, as the result, you get a M.dvi file into the $MY_MEGAWAVE2/doc/obj directory which can be used to print the documentation.




$ \bigcirc$Options


-adm : Say that M is a public module or a public macro from $MEGAWAVE2 and not from $MY_MEGAWAVE2. In that case, if you are not the administrator but a plain user, and if the administrator didn't make this doc already, the dvi file M.dvi is created into
$MY_MEGAWAVE2/tmp/megawave2_doc/user.

$ \bigcirc$Macro


mwdocxdvi - Display on the screen the documentation of a given module




$ \bigcirc$Usage


mwdocxdvi [-adm] [-macro] M




$ \bigcirc$Description


This command compiles a single module documentation file using the macro mwdoclatex, and then call the DVI previewer for the X Window System, xdvi, to display the documentation on the screen.




$ \bigcirc$Options


-adm : Say that M is a public module or a public macro from $MEGAWAVE2 and not from $MY_MEGAWAVE2. In that case, if you are not the administrator but a plain user, and if the administrator didn't make this doc already, the dvi file M.dvi is created into
$MY_MEGAWAVE2/tmp/megawave2_doc/user.

-macro : Say that M is a user's macro and not a module. In that case, the macro cmw2macro is called to generate a file M.doc. You normally don't need to set this option, since the command recognizes if M is a macro by its name, which should begin with a capital letter.


next up previous contents index
Next: List of modules Up: System's macros Previous: System's macros   Contents   Index
mw 2004-05-05