cmdline_tools

Index

.     _     A     B     C     D     F     G     H     I     K     L     M     N     O     P     R     T     V     W     Y    

.

./ directory

Main source directory for the cmdline_tools.

_

_extra keyword in routine man_resolveroutine in file man.pro

keywords to RESOLVE_ROUTINE

_extra keyword in routine mg_breakpoint in file mg_breakpoint.pro

keywords to BREAKPOINT

_extra keyword in routine mg_build_cmdline_tools in file mg_build_cmdline_tools.pro

keywords to MG_MAKE_DLL

A

all keyword in routine ls in file ls.pro

report all files (even hidden files like .*)

all keyword in routine mg_file_which in file mg_file_which.pro

set to return all matches instead of just the first one

B

background_black keyword in routine mg_ansicode in file mg_ansicode.pro

background_blue keyword in routine mg_ansicode in file mg_ansicode.pro

background_bright keyword in routine mg_ansicode in file mg_ansicode.pro

background_cyan keyword in routine mg_ansicode in file mg_ansicode.pro

background_green keyword in routine mg_ansicode in file mg_ansicode.pro

background_magenta keyword in routine mg_ansicode in file mg_ansicode.pro

background_red keyword in routine mg_ansicode in file mg_ansicode.pro

background_white keyword in routine mg_ansicode in file mg_ansicode.pro

background_yellow keyword in routine mg_ansicode in file mg_ansicode.pro

black keyword in routine mg_ansicode in file mg_ansicode.pro

set to color foreground text black

blue keyword in routine mg_ansicode in file mg_ansicode.pro

bold keyword in routine mg_ansicode in file mg_ansicode.pro

bright keyword in routine mg_ansicode in file mg_ansicode.pro

set to color foreground text to a brighter shade

C

cmdline_tools.dlm .dlm file in ./ directory

Tools for the command line

csv keyword in routine mg_profiler_report in file mg_profiler_report.pro

set to create CSV output

cyan keyword in routine mg_ansicode in file mg_ansicode.pro

D

dirs parameter in routine mg_set_path in file mg_set_path.pro

string array of directories in the path in the correct order; +, , and other abbreviations used by EXPAND_PATH are legal; array elements of dirs that begin with ";" are ignored

dlm keyword in routine mg_set_path in file mg_set_path.pro

set to set IDL_DLM_PATH instead of IDL_PATH

F

file parameter in routine mg_file_which in file mg_file_which.pro

file to search for, may include wildcards

filename parameter in routine man_printdocs in file man.pro

filename of the .pro file

filename keyword in routine mg_profiler_report in file mg_profiler_report.pro

set to a filename to send output to; if not set, output goes to standard output

filename keyword in routine mg_sysreport in file mg_sysreport.pro

if present, filename to send output to

filename parameter in routine more in file more.pro

filename to display

G

green keyword in routine mg_ansicode in file mg_ansicode.pro

H

html keyword in routine mg_profiler_report in file mg_profiler_report.pro

set to output HTML output

I

include_current_dir keyword in routine mg_file_which in file mg_file_which.pro

set to include current directory in the search path

indent keyword in routine man_print in file man.pro

string to prefix each line except the first

is_function keyword in routine man_printdocs in file man.pro

set to specify that the given routine is a function

K

KEYWORDS keyword in routine MG_PRINT in file cmdline_tools.dlm

L

level keyword in routine mg_varput in file mg_varput.pro

level of stack to place the variable: 0 for current level, positive values denote absolute levels of the stack with 1 being the main-level, negative values being relative to the current level with -1 being the routine that called the caller of MG_VARPUT

line parameter in routine mg_breakpoint in file mg_breakpoint.pro

line number with the file (normally) or routine (when ROUTINE keyword is set)

list parameter in routine man_checkroutine in file man.pro

list of routines to check against

long keyword in routine ls in file ls.pro

more information about each file is listed

ls routine in ls.pro

Substitute for UNIX ls command.

ls.pro .pro file in ./ directory

Equivalent to UNIX ls command.

M

magenta keyword in routine mg_ansicode in file mg_ansicode.pro

man routine in man.pro

Print comments about a routine or finds matching routines.

man.pro .pro file in ./ directory

Prints basic information about a routine.

man_checkroutine routine in man.pro

Checks to see if routine is in list.

man_print routine in man.pro

Print a string by splitting it across lines on spaces and indents every line except the first using the value of the INDENT keyword.

man_printdocs routine in man.pro

Print header docs for a routine in a given file.

man_resolveroutine routine in man.pro

Routine to resolve a given routine without crashing.

man_routineinfo routine in man.pro

Print comments about a routine.

man_termavailable routine in man.pro

Determines if a term capable of paging is available:

man_width routine in man.pro

Wrapper for MG_TERMCOLUMNS in case it is not available.

mg_ansicode routine in mg_ansicode.pro

Set ANSI color codes for the given text.

mg_ansicode.pro .pro file in ./ directory

Set ANSI escape codes for the given text.

mg_backspace routine in mg_backspace.pro

Backspaces a nchars characters.

mg_backspace.pro .pro file in ./ directory

mg_breakpoint routine in mg_breakpoint.pro

A helpful wrapper for BREAKPOINT which finds files in the !path and allows relative line numbers within routines.

mg_breakpoint.pro .pro file in ./ directory

Convenience wrapper for BREAKPOINT that finds files in !path without having to use a full path specification.

mg_build_cmdline_tools routine in mg_build_cmdline_tools.pro

Build the cmdline_tools DLM.

mg_build_cmdline_tools.pro .pro file in ./ directory

mg_file_which routine in mg_file_which.pro

Wrapper for FILE_WHICH, but has an ALL keyword to find all matches.

mg_file_which.pro .pro file in ./ directory

MG_HEAPID routine in cmdline_tools.dlm

MG_PRINT routine in cmdline_tools.dlm

mg_print_path routine in mg_print_path.pro

Print a search path nicely in the output log.

mg_print_path.pro .pro file in ./ directory

mg_profiler_report routine in mg_profiler_report.pro

Produce a report for the PROFILER.

mg_profiler_report.pro .pro file in ./ directory

mg_set_path routine in mg_set_path.pro

Set the IDL path (!path) or DLM path (!dlm_path) given an array of directories.

mg_set_path.pro .pro file in ./ directory

mg_sysreport routine in mg_sysreport.pro

Prints system information.

mg_sysreport.pro .pro file in ./ directory

MG_TERMCOLUMNS routine in cmdline_tools.dlm

MG_TERMISTTY routine in cmdline_tools.dlm

MG_TERMLINES routine in cmdline_tools.dlm

mg_varput routine in mg_varput.pro

Copies a variable or expression to another stack level, e.g., the main-level.

mg_varput.pro .pro file in ./ directory

more routine in more.pro

Page the contents of the filename to the screen.

more.pro .pro file in ./ directory

N

name parameter in routine mg_breakpoint in file mg_breakpoint.pro

name of file (with or without the .pro extension) or routine (when the ROUTINE keyword is set)

nchars parameter in routine mg_backspace in file mg_backspace.pro

number of characters to backspace

no_page keyword in routine man in file man.pro

set to not page the output

O

output keyword in routine man_printdocs in file man.pro

accumulation of output

output keyword in routine man_print in file man.pro

accumulation of output

output keyword in routine man_routineinfo in file man.pro

accumulation of output

P

param0 parameter in routine MG_HEAPID in file cmdline_tools.dlm

path parameter in routine mg_file_which in file mg_file_which.pro

path to search, delimited by path_sep(/search_path)

path parameter in routine mg_print_path in file mg_print_path.pro

list of directories concatented using the system OS separator character, as in !path or !dlm_path

pattern parameter in routine ls in file ls.pro

pattern to match filenames against

pwd routine in pwd.pro

Prints the IDL's current directory to the output log like the UNIX command of the same name.

pwd.pro .pro file in ./ directory

R

red keyword in routine mg_ansicode in file mg_ansicode.pro

set to color foreground text red

resolved keyword in routine man_resolveroutine in file man.pro

set to a named variable to find out if the routine was resolved

routine parameter in routine man_checkroutine in file man.pro

name of routine to check (case-insensitive)

routine parameter in routine man_routineinfo in file man.pro

routine name to look up

routine parameter in routine man in file man.pro

routine name to look up

routine keyword in routine mg_breakpoint in file mg_breakpoint.pro

set to specify a routine name and a line number within the routine definition

routine parameter in routine man_resolveroutine in file man.pro

name of routine to resolve

routinename parameter in routine man_printdocs in file man.pro

name of the routine to check docs for

T

text parameter in routine man_print in file man.pro

line to print

text parameter in routine mg_ansicode in file mg_ansicode.pro

text to colorize

V

variable parameter in routine mg_varput in file mg_varput.pro

variable to be copied

varname parameter in routine mg_varput in file mg_varput.pro

name of the variable in the new location; defaults to the current name if the variable is a named variable, i.e., not an expression

W

white keyword in routine mg_ansicode in file mg_ansicode.pro

Y

yellow keyword in routine mg_ansicode in file mg_ansicode.pro