/usr/include/gmt/gmt_synopsis.h is in libgmt-dev 5.2.1+dfsg-3build1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 | /*--------------------------------------------------------------------
* $Id: gmt_synopsis.h 15178 2015-11-06 10:45:03Z fwobbe $
*
* Copyright (c) 1991-2015 by P. Wessel, W. H. F. Smith, R. Scharroo, J. Luis and F. Wobbe
* See LICENSE.TXT 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 Lesser General Public License as published by
* the Free Software Foundation; version 3 or any later version.
*
* 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 Lesser General Public License for more details.
*
* Contact info: gmt.soest.hawaii.edu
*--------------------------------------------------------------------*/
/*
* Contains macros for presenting variations of GMT common options in program
* synopsis - yielding consistent presentation from all programs.
*
* Author: Paul Wessel
* Date: 1-JAN-2010
* Version: 5 API
*
*/
/*!
* \file gmt_synopsis.h
* \brief Macros for presenting variations of GMT common options in program synopsis.
*/
#ifndef GMT_SYNOPSIS_H
#define GMT_SYNOPSIS_H
#define GMT_inc_OPT "<xinc>[<unit>][=|+][/<yinc>[<unit>][=|+]]"
#define GMT_Id_OPT "-I<xinc>[m|s][/<yinc>[m|s]]"
#define GMT_Jx_OPT "-Jx|X<args>"
#define GMT_Jz_OPT "-Jz|Z<args>"
#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[<unit>]<xmin>/<xmax>/<ymin>/<ymax>[r]"
/* Use b, f, h, when applies to both i and o, else use only the bi, bo, fi, fo variants */
#define GMT_bi_OPT "-bi[<ncol>][t][w][+L|B]"
#define GMT_bo_OPT "-bo[<ncol>][t][w][+L|B]"
#define GMT_di_OPT "-di<nodata>"
#define GMT_do_OPT "-do<nodata>"
#define GMT_fi_OPT "-f<info>"
#define GMT_fo_OPT "-f<info>"
#define GMT_ho_OPT "-ho[<nrecs>][+c][+d][+r<remark>][+t<title>]"
#ifdef GMT_MP_ENABLED
#define GMT_x_OPT " [-x[[-]<n>]] " /* Must add spaces and brackets here and place via %s since it may be blank */
#define GMT_ADD_x_OPT "x"
#else /* No Open-MP support */
#define GMT_ADD_x_OPT ""
#define GMT_x_OPT ""
#endif
/* For options needing a length or radius */
#define GMT_DIST_OPT "[-|+]<dist>[<unit>]"
#define GMT_RADIUS_OPT "[-|+]<radius>[<unit>]"
/* Options for map rose, scale and insert, used in pscoast and psbasemap */
#define GMT_XYANCHOR "[g|j|J|n|x]<refpoint>"
#define GMT_JUSTIFY "[+j<justify>]"
#define GMT_OFFSET "[+o<dx>[/<dy>]]"
#define GMT_TROSE_DIR GMT_XYANCHOR "+w<width>[+f[<level>]]" GMT_JUSTIFY "[+l<w,e,s,n>]" GMT_OFFSET
#define GMT_TROSE_MAG GMT_XYANCHOR "+w<width>[+d[<dec>[/<dlabel>]]][+i<pen>]" GMT_JUSTIFY "[+l<w,e,s,n>][+p<pen>][+t<ints>]" GMT_OFFSET
#define GMT_SCALE GMT_XYANCHOR "+c[<slon>/]<slat>+w<length>[e|f|M|n|k|u][+a<align>][+f][+l[<label>]]" GMT_OFFSET "[+u]"
#define GMT_INSERT_A GMT_XYANCHOR "+w<width>[<unit>][/<height>[<unit>]]" GMT_JUSTIFY GMT_OFFSET "[+s<file>]"
#define GMT_INSERT_B "[<unit>]<xmin>/<xmax>/<ymin>/<ymax>[r][+s<file>]"
/* Options for background panel, used in gmtlogo, psimage, pslegend and psscale */
#define GMT_PANEL "-F[+c<clearance(s)>][+g<fill>][+i[[<gap>/]<pen>]][+p[<pen>]][+r[<radius>]][+s[<dx>/<dy>/][<fill>]]"
/* Argument to *contour programs */
#define GMT_CONTG "-G[d|f|n|l|L|x|X]<args>"
#define GMT_CONTT "-T[+|-][+d<gap>[c|i|p][/<length>[c|i|p]]][+l[<labels>]]"
/* Options for coastline extraction */
#define GMT_A_OPT "-A<min_area>[/<min_level>/<max_level>][+ag|i|s|S][+r|l][+p<percent>]"
/* Used in tools that sets grdheader information via a -D option */
#define GMT_GRDEDIT "-D<xname>/<yname>/<zname>/<scale>/<offset>/<invalid>/<title>/<remark>"
/*! Macros for the common GMT options used in a program's usage synopsis */
#define GMT_B_OPT "-B<args>"
#define GMT_I_OPT "-I<xinc>[<unit>][=|+][/<yinc>[<unit>][=|+]]"
#define GMT_J_OPT "-J<args>"
#define GMT_R2_OPT "-R[<unit>]<xmin>/<xmax>/<ymin>/<ymax>[r]"
#define GMT_R3_OPT "-R[<unit>]<xmin>/<xmax>/<ymin>/<ymax>[/<zmin>/<zmax>][r]"
#define GMT_U_OPT "-U[<just>/<dx>/<dy>/][c|<label>]"
#define GMT_V_OPT "-V[<level>]"
#define GMT_X_OPT "-X[a|c|r]<xshift>[<unit>]"
#define GMT_Y_OPT "-Y[a|c|r]<yshift>[<unit>]"
#define GMT_a_OPT "-a<col>=<name>[,...]"
#define GMT_b_OPT "-b[i|o][<ncol>][t][w][+L|B]"
#define GMT_c_OPT "-c<ncopies>"
#define GMT_d_OPT "-d[i|o]<nodata>"
#define GMT_f_OPT "-f[i|o]<info>"
#define GMT_g_OPT "-g[a]x|y|d|X|Y|D|[<col>]z[-|+]<gap>[<unit>]"
#define GMT_h_OPT "-h[i|o][<nrecs>][+c][+d][+r<remark>][+t<title>]"
#define GMT_i_OPT "-i<cols>[l][s<scale>][o<offset>][,...]"
#define GMT_n_OPT "-n[b|c|l|n][+a][+b<BC>][+c][+t<threshold>]"
#define GMT_o_OPT "-o<cols>[,...]"
#define GMT_p_OPT "-p[x|y|z]<azim>/<elev>[/<zlevel>][+w<lon0>/<lat0>[/<z0>][+v<x0>/<y0>]"
#define GMT_r_OPT "-r"
#define GMT_s_OPT "-s[<cols>][a|r]"
#define GMT_t_OPT "-t<+a|[-]n>"
#define GMT_colon_OPT "-:[i|o]"
/*! Macro for tools that need to specify FFT information (prepend option flag, e.g., -N and put GMT_FFT_OPT inside [] ) */
#define GMT_FFT_OPT "[f|q|s|<nx>/<ny>][+a|d|l][+e|m|n][+t<width>][+w<suffix>][+z[p]]"
#endif /* GMT_SYNOPSIS_H */
|