.\" Man page generated from reStructuredText.
.
.TH "GMTWHICH" "1gmt" "Sep 07, 2019" "6.0.0rc4" "GMT"
.SH NAME
gmtwhich \- Find full path to specified files
.
.nr rst2man-indent-level 0
.
.de1 rstReportMargin
\\$1 \\n[an-margin]
level \\n[rst2man-indent-level]
level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
-
\\n[rst2man-indent0]
\\n[rst2man-indent1]
\\n[rst2man-indent2]
..
.de1 INDENT
.\" .rstReportMargin pre:
. RS \\$1
. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
. nr rst2man-indent-level +1
.\" .rstReportMargin post:
..
.de UNINDENT
. RE
.\" indent \\n[an-margin]
.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
.nr rst2man-indent-level -1
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
.SH SYNOPSIS
.sp
\fBgmt which\fP \fIfiles\fP [  \fB\-A\fP ] [  \fB\-C\fP ] [  \fB\-D\fP ] [  \fB\-G\fP[\fBc\fP|\fBl\fP|\fBu\fP] ] [  \fB\-V\fP[\fIlevel\fP] ] [ \fB\-\-PAR\fP=\fIvalue\fP ]
.sp
\fBNote:\fP No space is allowed between the option flag and the associated arguments.
.SH DESCRIPTION
.sp
\fBwhich\fP reports the full paths to the files given on the command
line. We look for the file in (1) the current directory,
(2) in $GMT_USERDIR (if defined), (3) in $GMT_DATADIR (if defined), or
(4) in $GMT_CACHEDIR (if defined). If
found we print the full path name to the file, just the directory (see
\fB\-D\fP), or a confirmation (see \fB\-C\fP). The $GMT_USERDIR and
$GMT_DATADIR environment variables can be comma\-separated list of
directories, and we search recursively down any directory that ends with
/ (i.e., /export/data is a single directory whereas /export/data/ will
be searched recursively.)
.SH REQUIRED ARGUMENTS
.INDENT 0.0
.TP
.B \fIfiles\fP
One or more file names of any data type (grids, tables, etc.).
.UNINDENT
.SH OPTIONAL ARGUMENTS
.INDENT 0.0
.TP
\fB\-A\fP
Only consider files that the user has permission to read [Default consider
all files found].
.UNINDENT
.INDENT 0.0
.TP
\fB\-C\fP
Instead of reporting the paths, print the confirmation Y if the file
is found and N if it is not.
.UNINDENT
.INDENT 0.0
.TP
\fB\-D\fP
Instead of reporting the paths, print the directories that contains
the files.
.UNINDENT
.INDENT 0.0
.TP
\fB\-G\fP[\fBc\fP|\fBl\fP|\fBu\fP]
If a file argument is a downloadable file (either a full URL, a @file for
downloading from the GMT Site Cache, or @earth_relief_*.grd) we will try
to download the file if it is not found in your local data or cache dirs.
By default [\fB\-Gl\fP] we download to the current directory. Append \fBc\fP to place
in the user cache directory or \fBu\fP user data directory instead.
.UNINDENT
.INDENT 0.0
.TP
\fB\-V\fP[\fIlevel\fP] (more ...)
Select verbosity level [c].  
.UNINDENT
.INDENT 0.0
.TP
\fB\-^\fP or just \fB\-\fP
Print a short message about the syntax of the command, then exits (NOTE: on Windows just use \fB\-\fP).
.TP
\fB\-+\fP or just \fB+\fP
Print an extensive usage (help) message, including the explanation of
any module\-specific option (but not the GMT common options), then exits.
.TP
\fB\-?\fP or no arguments
Print a complete usage (help) message, including the explanation of all options, then exits.
.TP
\fB\-\-PAR\fP=\fIvalue\fP
Temporarily override a GMT default setting; repeatable. See /gmt.conf for parameters.
.UNINDENT
.SH EXAMPLES
.sp
To see the full path to the file myjunk.txt, use
.INDENT 0.0
.INDENT 3.5
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
gmt which myjunk.txt
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.sp
To download the 10 arc\-minute global relief file from the GMT data site, use
.INDENT 0.0
.INDENT 3.5
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
gmt which \-Gu @earth_relief_10m.grd
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.sp
which will print the path (after downloading if not already present).  The file will
be placed in the user\(aqs GMT_USER_DIR.  To obtain a GMT example or test file from the
GMT cache site, try
.INDENT 0.0
.INDENT 3.5
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
gmt which \-Gc @hotspots.txt
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.sp
which will print the path (after downloading if not already present).  The file will
be placed in the user\(aqs GMT_CACHE_DIR directory.
.SH SEE ALSO
.sp
gmt
.SH COPYRIGHT
2019, The GMT Team
.\" Generated by docutils manpage writer.
.