Previous Next        Current Page: NeXtMidas Training / Getting Started - Part 1 / Getting Help / Command Line / Explain
back
Start Here   
Background   
Common Midas Concepts   
Getting Started - Part 1   
   + NeXtMidas Shell   
   + Running NeXtMidas Commands   
   + Results Parameters   
   + Lab 1   
   - Getting Help   
      - Online Documentation   
      - Command Line   
         - Default   
         - Explain   
         - Menu   
         - Query   
      - Help Desk   
   + Lab 2   
Getting Started - Part 2   
Working with Files   
Option Trees   
Macros - Part 1 (Basics)   
Macros - Part 2 (Graphics)   
NetBeans - Part 1 (Setup)   
NetBeans - Part 2 (GUIs)   
NetBeans - Part 3 (Profiler)   
Eclipse - Part 1 (Setup)   
Eclipse - Part 2 (GUIs)   
Primitives   
WebStart   
Maps & Imagery   
X-Midas Interoperability   
RMIF & Remoting   
Installing NeXtMidas   
Support & Maintenance   
File Handlers   


  • Using EXPLAIN <command>:
    • Every command has an explain file that explains how to use the command.
    • You can read the explain file of any NeXtMidas command by typing EXPLAIN <command> and the command name after the NeXtMidas prompt. For example:
      nM> expl BEEP
      BEEP - Emits an audio beep.
      
      <func>  - ON|OFF|n, where n = number of beeps
      <delay> - Delay between beeps [SECS] (<func> = n only)
      
      Causes the system to beep. The <func>=ON and <func>=OFF
      may be used to turn ON/OFF verification beeps after a
      command is executed (these have the same effect as using
      "VERIFY ON BEEP" and "VERIFY OFF BEEP").
      
      Examples:
        nM> beep 2 2 ! Beep 2 times with 2 seconds between beeps.
      
        nM> beep on  ! Beep after completion of each command.
      
      SEE ALSO: VERIFY
      
    • If you know what you're looking for, you can also specify a particular section to examine. For example:
      nM> expl BEEP examples
      Examples:
        nM> beep 2 2 ! Beep 2 times with 2 seconds between beeps.
      
        nM> beep on  ! Beep after completion of each command.
      
  • What it shows:
    • Command name, parameters and switches
    • Explanation of how to use the command
    • Examples of how to use the command

back