Content-type: text/html Manpage of INTRO

INTRO

Section: User Commands (1)
Updated: 29 July 1993
Index Return to Main Contents
 

DESCRIPTION

MIRIAD is an astronomical data-reduction and analysis package suitable to manipulate raw radio-interferometric observations and images. A rich visibility data-format has been designed to allow a very flexible approach to calibrate and map the data, particularly for arrays with a small number of antennae. Specific calibration routines for the BIMA and ATNF arrays are available. Most common image processing techniques, including a wide variety of deconvolution programs, are available.

Interfaces exist to import and export data through the FITS format, visibility data as well as image data.  

GETTING STARTED

What you need to do to set yourself up for MIRIAD:

There are many ways to add MIRIAD to your environment. Essentially, the $MIR environment variable is defined as the root directory of the software package on your local site, after which some startup file is executed. For example, you can add the following lines to your .cshrc file, but AFTER your command search path (PATH environment variable or path shell variable) has been set:

    ...
    set path = ( ... )
    ...
    setenv MIR /usr/miriad                  # or where ever
    if(-e $MIR/MIRRC) source $MIR/MIRRC
    ...
    set path = ( ... $MIRBIN $path )

Important to note is that the second path modification is not needed in cases where the MIRRC file does this for you. This is a site dependant feature, and you need to consult you local MIRIAD guru.  

HOW TO RUN MIRIAD PROGRAMS

MIRIAD programs can be run just as any other command in Unix, in that sense MIRIAD is nothing more than an extension of Unix. There are also fancy shell programs, called miriad, mirtool and xmirtool, (under development) for people who prefer a more AIPS-like or point-and-click environment.

MIRIAD programs all work by using a series of keyword=value pairs on the commandline. The command mirhelp should give you help on any particular program (or even subroutine) in MIRIAD, e.g.

    mirhelp itemize
although within xman (mirman) the information is easier accessable.  

FURTHER INFORMATION

The MIRIAD Users Guide contains most of the information you need to run programs. The MIRIAD Programmers Guide explains how to write your own programs.

 

XMAN RESIZING WINDOWS

You can resize any of the windows in xman with your window manager, and xman will do the best it can to resize everything internally into a useful configuration. The only control over the internal arrangement that you have is moving the border between the manual page and directory when both are displayed. This is done by clicking and holding the any pointer button when the cursor is over the small square (grip) on the right side of the screen. The grip is located on the horizontal line which separates the panes. The grip may be moved up and down to resize the panes of the screen, and when the pointer button is released xman will move the pane boundary to the newly specified location.

 

XMAN MENU COMMANDS

There are two ways to activate the menus. The first is to click any pointer button in the menu button corresponding to the menu you want to activate. The second method is to hold down the "Control" key and click the left pointer button for the Options menu or the middle pointer button for the Sections menu. Reguardless of how the menu was activated, selecting items is the same.

Once a menu is activated, continue to hold down the pointer button and drag the pointer cursor over the item that you would like to activate. Once the item that you want to select is highlighted, select it by releasing the pointer button. To avoid making a menu selection, move the pointer cursor outside the menu and release the button.

Selecting one of the items in the Sections menu will display the named directory.

The following commands are available through the Options menu:

Display Directory       Show the current section directory.

Display Manual Page     Show the current manual page.

Help                    Create a help window with this text displayed.

Search                  Pop up a dialogue box that allows the entire tree
                        of manual pages to be searched for a specific name.
                        A keyword (apropos) search is also available through
                        this dialogue box.

Show Both Screens       Split the manual page display window to display
                        both the current manual page and the directory. 
Show One Screen         Return to a single screen display of either a 
                        manual page or directory listing.

Remove This Man Page    Remove this manual page, do not quit.

Open New Man Page       Pop up a new manual page browser window.

Show Version            Print the current version of xman to the information
                        display window.  Please include the version number
                        when reporting bugs.
 
Quit                    Close all xman windows and quit xman.

 

XMAN SUMMARY OF BASIC ACTIONS

In a menu button:

        CLICK:          Pop up a menu

In a directory, manual page, or scroll bar:

        <CONTROL> CLICK LEFT:           Pop up the Options menu.
        <CONTROL> CLICK MIDDLE: Pop up the Sections menu.

In a  directory:

        CLICK LEFT:                             Bring up named manual page
        <SHIFT> CLICK MIDDLE:           Go to manual page previously chosen.

In a manual page or apropos listing:

        <SHIFT> CLICK MIDDLE:           Go to directory of manual pages.

In scroll bars:

        CLICK LEFT:             Move down - more if pointer is near bottom
                                                    of window, less if at top.
        CLICK MIDDLE:           Move top of page to current pointer position.
        CLICK RIGHT:            Move up - more if pointer is near bottom
                                          of window, less if at top.
 

XMAN SEARCHING

Xman has a built-in searching utility that allows the user to search the entire manual page tree for a specific topic (manual page search) or a keyword (apropos search). The search dialogue box can be activated from the Options menu, or by the key Control-s. If the search is started from the small initial topbox xman will open a new manual page if the search was successful, and fail silently if the search was unsuccessful.

Manual page searches are performed starting in the currently displayed section. If no match is found then the remaining sections are searched in the order that the sections appear in the Sections menu, starting at the top. The current version of xman immediately displays the first manual page that it finds. If the manual page cannot be found that fact is noted in the informational display.

An apropos search will search a list of short descriptions for all manual pages on the system and return a list of all descriptions which contain the keyword specified.

 

XMAN KEYBOARD ACCELERATORS

Xman contains a set of preinstalled keyboard accelerators. These are a set of key bindings that perform many of the same operations as the menu items. Since it is not necessary to pull down the menu, these actions can be performed more quickly, hence the name accelerators.

The default key bindings for xman are:

Anywhere:

        Control - c             Exit xman
        Control - h             Create the help window
        Control - n             Create a new man page
        Control - q             Exit xman
        Control - s             Create a search popup 

In a manual page, directory, or help window:

        Control - r             Remove this manual page or help display
        Control - v             Show the current version of xman

In a manual page or directory:

        Control - d             Display Directory
        Control - m             Display Man Page

In a manual page only:

        b                       Page Back
        f                       Page forward
        <Space>                 Page forward
        1                       One line forward
        2                       Two lines forward
        3                       Three lines forward
        4                       Four lines forward

Note: Control-s does not have any effect in the help window.

 

XMAN FURTHER INFORMATION

Xman is highly customizable. Through the X resource database a user can customize the look and feel of this application so that it meets a preferred style of interaction. Almost any configuration that is available dynamically can be specified through resources. This includes changing the size, color, and fonts, starting with no topbox, showing both screens,
and rebinding the keyboard accelerators.  

SEE ALSO

xman(1), aips(1), sde, iraf, midas  

HISTORY


23-mar-92 Created for UMD version of mir.man  PJT
27-jul-93 Ported to other sites -- added some xman.helpPJT
24-mar-99 Slight adaptations for linux            PJT


 

Index

DESCRIPTION
GETTING STARTED
HOW TO RUN MIRIAD PROGRAMS
FURTHER INFORMATION
XMAN RESIZING WINDOWS
XMAN MENU COMMANDS
XMAN SUMMARY OF BASIC ACTIONS
XMAN SEARCHING
XMAN KEYBOARD ACCELERATORS
XMAN FURTHER INFORMATION
SEE ALSO
HISTORY

This document was created by man2html, using the manual pages.
Time: 18:35:38 GMT, July 05, 2011