.\" Man page generated from reStructuredText.
.
.TH "X2SYS_PUT" "1gmt" "May 21, 2019" "5.4.5" "GMT"
.SH NAME
x2sys_put \- Update track index database from track bin file
.
.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
\fBx2sys_put\fP [ \fIinfo.tbf\fP ]  \fB\-T\fP\fITAG\fP [  \fB\-D\fP ] [  \fB\-F\fP ]
[  \fB\-V\fP[\fIlevel\fP] ]
.sp
\fBNote:\fP No space is allowed between the option flag and the associated arguments.
.SH DESCRIPTION
.sp
\fBx2sys_put\fP accepts a track bin\-index file created by
x2sys_binlist and adds this information about the data tracks to
the relevant data base. You may chose to overwrite existing data with
new information for older tracks (\fB\-F\fP) and even completely remove
information for certain tracks (\fB\-D\fP). The x2sys \fITAG\fP must match the
tag encoded in the \fIinfo.tbf\fP file. To inquire about tracks in the data
base, use x2sys_get\&.
.SH REQUIRED ARGUMENTS
.INDENT 0.0
.TP
.B \fIinfo.tbf\fP
Name of a single track bin file. If not given, \fIstdin\fP will be read.
.UNINDENT
.INDENT 0.0
.TP
\fB\-T\fP\fITAG\fP
Specify the x2sys \fITAG\fP which tracks the attributes of this data type.
.UNINDENT
.SH OPTIONAL ARGUMENTS
.INDENT 0.0
.TP
\fB\-D\fP
Delete all tracks found in the track bin file [Default will try to
add them as new track entries].
.UNINDENT
.INDENT 0.0
.TP
\fB\-F\fP
Replace any existing database information for these tracks with the
new information in the track bin file [Default refuses to process
tracks already in the database].
.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.
.UNINDENT
.SH EXAMPLES
.sp
To add the information stored in the track bin\-index file latest.tbf to
the track data bases associated with the tag MGD77, and replace any
exiting information for these tracks, try
.INDENT 0.0
.INDENT 3.5
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
gmt x2sys_put latest.tbf \-F \-V \-TMGD77
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.SH X2SYS DATABASES
.sp
The \fBx2sys_put\fP utility adds new information to the x2sys data bases.
These consists of two files: The first file contains a listing of all
the tracks that have been added to the system; it is named
\fITAG\fP_tracks.d and is in ASCII format. The second file is named
\fITAG\fP_index.b and is in native binary format. It contains information
on which tracks cross each of the bins, and what data sets were observed
while crossing the bin. The bins are defined by the  \fB\-R\fP and  \fB\-I\fP
options passed to x2sys_init when the \fITAG\fP was first initiated.
Both data base files are stored in the \fB$X2SYS_HOME\fP/\fITAG\fP directory.
Do not attempt to edit these files by hand.
.SH SEE ALSO
.sp
x2sys_binlist, x2sys_get
.SH COPYRIGHT
2019, P. Wessel, W. H. F. Smith, R. Scharroo, J. Luis, and F. Wobbe
.\" Generated by docutils manpage writer.
.