/*-------------------------------------------------------------------- * $Id: gmt_synopsis.h,v 1.5 2008/04/16 02:57:35 remko Exp $ * * Copyright (c) 1991-2008 by P. Wessel and W. H. F. Smith * See COPYING file for copying and redistribution conditions. * * This program is free software; you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by * the Free Software Foundation; version 2 of the License. * * This program is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU General Public License for more details. * * Contact info: gmt.soest.hawaii.edu *--------------------------------------------------------------------*/ /* * Contains macros for presenting the GMT common options in program * synopsis - yielding consistent presentation from all programs. * See common_options.txt for macros for the man pages. * * Author: Paul Wessel * Date: 6-APR-2006 * Version: 4 * */ #ifndef GMT_SYNOPSIS_H #define GMT_SYNOPSIS_H #define GMT_B_OPT "-B<params>" #define GMT_H_OPT "-H[i][<nrec>]" #define GMT_Ho_OPT "-H[<nrec>]" #define GMT_I_OPT "-I<xinc>[u][=|+][/<yinc>[u][=|+]]" #define GMT_inc_OPT "<xinc>[u][=|+][/<yinc>[u][=|+]]" #define GMT_Id_OPT "-I<xinc>[m|c][/<yinc>[m|c]]" #define GMT_J_OPT "-J<params>" #define GMT_Jx_OPT "-Jx|X<params>" #define GMT_Jz_OPT "-Jz|Z<params>" #define GMT_Rgeo_OPT "-R<west>/<east>/<south>/<north>[r]" #define GMT_Rgeoz_OPT "-R<west>/<east>/<south>/<north>[/<zmin/zmax>][r]" #define GMT_Rx_OPT "-R<xmin>/<xmax>/<ymin>/<ymax>[r]" #define GMT_M_OPT "-M[i|o][<flag>]" #define GMT_Mo_OPT "-M[<flag>]" #define GMT_U_OPT "-U[<just>/<dx>/<dy>/][c|<label>]" #define GMT_X_OPT "-X[a|c|r]<x_shift>[u]" #define GMT_Y_OPT "-Y[a|c|r]<x_shift>[u]" #define GMT_c_OPT "-c<ncopies>" #define GMT_t_OPT "-:[i|o]" /* Use b, f when applies to both i and o, else use only the bi, bo, fi, fo variants */ #define GMT_b_OPT "-b[i|o][s|S|d|D[<ncol>]|c[<var1>/...]]" #define GMT_bi_OPT "-bi[s|S|d|D[<ncol>]|c[<var1>/...]]" #define GMT_bo_OPT "-bo[s|S|d|D[<ncol>]|c[<var1>/...]]" #define GMT_f_OPT "-f[i|o]<colinfo>" #define GMT_fi_OPT "-f<colinfo>" #define GMT_fo_OPT "-f<colinfo>" /* Options for map rose and scale, used in pscoast and psbasemap */ #define GMT_TROSE "-T[f|m][x]<lon0>/<lat0>/<size>[/<info>][:w,e,s,n:][+<gint>[/<mint>]]" #define GMT_SCALE "-L[f][x]<lon0>/<lat0>[/<slon>]/<slat>/<length>[m|n|k][:<label>:<just>][+p<pen>][+f<fill>]" /* Argument to *contour programs */ #define GMT_CONTG "-G[d|f|n|l|L|x|X]<params>" /* Used in tools that sets grdheader information via a -D option */ #define GMT_GRDEDIT "-D<xname>/<yname>/<zname>/<scale>/<offset>/<title>/<remark>" #endif /* GMT_SYNOPSIS_H */