PATH Name
PATH Purpose
Examine and modify the IDL path. Category
Calling Sequence
path, new Inputs
new = new path name to add to existing path. in
Ignored if already in path. May be a string array
of new paths. May also give a single path with
leading +, this will be expanded to include all
subdirectories with *.pro files.
Keyword Parameters
Keywords
/LAST forces new path to be added to end of existing
path instead of front which is default.
/LIST displays a numbered list of all the paths.
path with no arguments is the same as path,/list.
/RESET restores initial path (found on first call).
/INIT save current path. /RESET will restore it.
FRONT=n move the n'th directory to the front.
FRONT may also be a string, a regular expression
to match and move to front. Ex: "abc$" matches
abc at end of path. NOTE for Windows: make sure to
double any backslashes (for stregex),
REMOVE=n remove the n'th directory from the path.
n may also be a string, items with it will be dropped.
Be careful with the string option. If given 'map' then
any directories with 'map' will be removed, like 'map',
'map2',... Use 'map$' to remove just the one ending in
'map', or whatever gives the correct match.
PATHARRAY=txt Return in a text array directories on path.
Outputs
Common Blocks
path_com Notes
Notes: can use paths like ../xxx or [-.xxx] as a shortcut.
Useful to turn on & off libraries of IDL routines.
Modification History
R. Sterner, 20 Sep, 1989
R. Sterner, 24 Sep, 1991 --- Added DOS.
R. Sterner, 24 Jan, 1994 --- Added MACOS.
R. Sterner, 2000 Sep 20 --- Dropped DOS, added WINDOWS.
Kristian Kj�r (Kristian.Kjaer@risoe.dk) requested WINDOWS
and the use of !version.os_family.
KK 18 Apr 2001 --- Added patharray=patharray
R. Sterner, 2002 Feb 18 --- Added the REMOVE=n keyword.
R. Sterner, 2002 Sep 19 --- Allowed FRONT to be a string. Added /INIT.
R. Sterner, 2002 Dec 18 --- Add new only if not there.
R. Sterner, 2002 Dec 23 --- Upgraded remove.
R. Sterner, 2003 Jan 29 --- Fixed add new, cleaned up some.
R. Sterner, 2003 Feb 27 --- Cleaned up some.
R. Sterner, 2003 Mar 04 --- Fixed leading : problem.
R. Sterner, 2004 Oct 14 --- Allowed array of paths, also leading +.
R. Sterner, 2006 Mar 21 --- Noted Windows double backslash for FRONT=.
R. Sterner, 2008 Sep 12 --- Continue if FRONT repeated but ok.
R. Sterner, 2010 Apr 29 --- Converted arrays from () to [].
Copyright (C) 1989, Johns Hopkins University/Applied Physics Laboratory
This software may be used, copied, or redistributed as long as it is not
sold and this copyright notice is reproduced on each copy made. This
routine is provided as is without any express or implied warranties
whatsoever. Other limitations apply as described in the file disclaimer.txt.