.\" DO NOT MODIFY THIS FILE!  It was generated by help2man 1.47.17.
.TH MATCH "1" "January 2021" "GNU Astronomy Utilities 0.14" "User Commands"
.SH NAME
Match \- match catalogs by 1D or 2D positions
.SH SYNOPSIS
.B astmatch
[\fI\,OPTION\/\fR...] \fI\,ASTRdata\/\fR
.SH DESCRIPTION
Match is part of GNU Astronomy Utilities 0.14.
Match matches catalogs of objects and (by default) will return the re\-arranged
matching inputs. The optional log file will return low\-level information about
the match (indexs and distances).
.PP
For more information, please run any of the following commands. In particular
the second contains a very comprehensive explanation of Match's invocation:
expected input(s), output(s), and a full description of all the options.
.TP
All options and their values:
$ astmatch \fB\-P\fR
.TP
Inputs/Outputs and options:
$ info astmatch
.TP
Full section in manual/book:
$ info Match
.TP
Full Gnuastro manual/book:
$ info gnuastro
.PP
If you couldn't find your answer in the manual, you can get direct help from
experienced Gnuastro users and developers. For more information, please run:
.IP
\f(CW$ info help-gnuastro\fR
.PP
Match options:
.IP
Input:
.TP
\fB\-h\fR, \fB\-\-hdu\fR=\fI\,STR\/\fR/INT
Extension name or number of first input.
.TP
\fB\-H\fR, \fB\-\-hdu2\fR=\fI\,STR\/\fR/INT
Extension name or number of second input.
.TP
\fB\-I\fR, \fB\-\-ignorecase\fR
Ignore case in matching/searching columns.
.TP
\fB\-\-searchin\fR=\fI\,STR\/\fR
Select column(s): 'name', 'unit', 'comment'.
.TP
\fB\-\-stdintimeout\fR=\fI\,INT\/\fR
Micro\-seconds to wait for standard input.
.IP
Output:
.TP
\fB\-D\fR, \fB\-\-dontdelete\fR
Don't delete output if it exists.
.TP
\fB\-K\fR, \fB\-\-keepinputdir\fR
Keep input directory for automatic output.
.TP
\fB\-l\fR, \fB\-\-logasoutput\fR
No rearranging of inputs, output is log file
.TP
\fB\-\-notmatched\fR
Output is rows that don't match.
.TP
\fB\-\-outcols\fR=\fI\,STR\/\fR
Out cols in CSV, 'a': first, 'b': second input.
.TP
\fB\-o\fR, \fB\-\-output\fR=\fI\,STR\/\fR
Output file name.
.TP
\fB\-\-tableformat\fR=\fI\,STR\/\fR
Table fmt: 'fits\-ascii', 'fits\-binary', 'txt'.
.IP
Catalog matching
.TP
\fB\-a\fR, \fB\-\-aperture\fR=\fI\,FLT[\/\fR,...]
Acceptable aperture for matching.
.TP
\fB\-c\fR, \fB\-\-ccol1\fR=\fI\,STR[\/\fR,STR]
Column name/number of first catalog.
.TP
\fB\-C\fR, \fB\-\-ccol2\fR=\fI\,STR[\/\fR,STR]
Column name/number of second catalog.
.TP
\fB\-d\fR, \fB\-\-coord\fR=\fI\,FLT[\/\fR,FLT]
Manually input coordiantes.
.IP
Operating modes:
.TP
\-?, \fB\-\-help\fR
give this help list
.TP
\fB\-\-checkconfig\fR
List all config files and variables read.
.TP
\fB\-\-cite\fR
BibTeX citation for this program.
.TP
\fB\-\-config\fR=\fI\,STR\/\fR
Read configuration file STR immediately.
.TP
\fB\-\-lastconfig\fR
Do not parse any more configuration files.
.TP
\fB\-\-log\fR
Information about output(s) in a log file.
.TP
\fB\-\-minmapsize\fR=\fI\,INT\/\fR
Minimum bytes in array to not use ram RAM.
.TP
\fB\-\-onlyversion\fR=\fI\,STR\/\fR
Only run if the program version is STR.
.TP
\fB\-P\fR, \fB\-\-printparams\fR
Print parameter values to be used and abort.
.TP
\fB\-\-quietmmap\fR
Don't print mmap'd file's name and size.
.TP
\fB\-q\fR, \fB\-\-quiet\fR
Only report errors, remain quiet about steps.
.TP
\fB\-S\fR, \fB\-\-setdirconf\fR
Set default values for this directory and abort.
.TP
\fB\-\-usage\fR
give a short usage message
.TP
\fB\-U\fR, \fB\-\-setusrconf\fR
Set default values for this user and abort.
.TP
\fB\-V\fR, \fB\-\-version\fR
print program version
.PP
Mandatory or optional arguments to long options are also mandatory or optional
for any corresponding short options.
.PP
GNU Astronomy Utilities home page: http://www.gnu.org/software/gnuastro/
.SH "REPORTING BUGS"
Report bugs to bug\-gnuastro@gnu.org.
.SH COPYRIGHT
Copyright \(co 2015\-2021, Free Software Foundation, Inc.
License GPLv3+: GNU General public license version 3 or later.
.br
This is free software: you are free to change and redistribute it.
There is NO WARRANTY, to the extent permitted by law.
.PP
Written/developed by Mohammad Akhlaghi
.SH "SEE ALSO"
The full documentation for
.B Match
is maintained as a Texinfo manual.  If the
.B info
and
.B Match
programs are properly installed at your site, the command
.IP
.B info Match
.PP
should give you access to the complete manual.