Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 7 additions & 6 deletions doc/rst/source/basemap.rst
Original file line number Diff line number Diff line change
Expand Up @@ -12,11 +12,12 @@ Synopsis

.. include:: common_SYN_OPTs.rst_

**gmt basemap** |-J|\ *parameters*
**gmt basemap**
|SYN_OPT-Rz|
[ |-A|\ [*file*] ]
[ |SYN_OPT-B| ]
[ |-F|\ *box* ]
[ |-J|\ *parameters* ]
[ |-J|\ **z**\|\ **Z**\ *parameters* ]
[ |-L|\ *scalebar* ]
[ |-T|\ *rose* ]
Expand All @@ -43,11 +44,6 @@ specified.
Required Arguments
------------------

.. |Add_-J| replace:: |Add_-J_links|
.. include:: explain_-J.rst_
:start-after: **Syntax**
:end-before: **Description**

.. |Add_-R| replace:: |Add_-R_links|
.. include:: explain_-R.rst_
:start-after: **Syntax**
Expand Down Expand Up @@ -90,6 +86,11 @@ Optional Arguments

.. include:: explain_-L_scale.rst_

.. |Add_-J| replace:: |Add_-J_links|
.. include:: explain_-J.rst_
:start-after: **Syntax**
:end-before: **Description**

.. _-T:

.. include:: explain_-T_rose.rst_
Expand Down
15 changes: 8 additions & 7 deletions doc/rst/source/clip.rst
Original file line number Diff line number Diff line change
Expand Up @@ -12,11 +12,12 @@ Synopsis

.. include:: common_SYN_OPTs.rst_

**gmt clip** [ *table* ] |-J|\ *parameters* |-C|\ [*n*]
**gmt clip** [ *table* ] |-C|\ [*n*]
|SYN_OPT-Rz|
[ |-A|\ [**x**\|\ **y**] ]
[ |SYN_OPT-B| ]
|-J|\ **z**\|\ **Z**\ *parameters* ]
[ |-J|\ *parameters* ]
[ |-J|\ **z**\|\ **Z**\ *parameters* ]
[ |-N| ]
[ |-T| ]
[ |SYN_OPT-U| ]
Expand Down Expand Up @@ -71,11 +72,6 @@ Required Arguments
Experts may restrict the termination to just *n* of the active
clipping path by passing that as the argument.

.. |Add_-J| replace:: |Add_-J_links|
.. include:: explain_-J.rst_
:start-after: **Syntax**
:end-before: **Description**

.. |Add_-R| replace:: |Add_-R_auto_table|
.. include:: explain_-R.rst_
:start-after: **Syntax**
Expand Down Expand Up @@ -109,6 +105,11 @@ Optional Arguments
:start-after: **Syntax**
:end-before: **Description**

.. |Add_-J| replace:: |Add_-J_links|
.. include:: explain_-J.rst_
:start-after: **Syntax**
:end-before: **Description**

.. _-N:

**-N**
Expand Down
13 changes: 7 additions & 6 deletions doc/rst/source/coast.rst
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ Synopsis

.. include:: common_SYN_OPTs.rst_

**gmt coast** |-J|\ *parameters*
**gmt coast**
|SYN_OPT-R|
[ |SYN_OPT-Area| ]
[ |SYN_OPT-B| ]
Expand All @@ -22,6 +22,7 @@ Synopsis
[ |-F|\ *box* ]
[ |-G|\ [*fill*] ]
[ |-I|\ *river*\ [/\ *pen*] ]
[ |-J|\ *parameters* ]
[ |-J|\ **z**\|\ **Z**\ *parameters* ]
[ |-L|\ *scalebar* ]
[ |-M| ]
Expand Down Expand Up @@ -66,11 +67,6 @@ At least one of options -C, -G, -S, -E, -I, -N, -Q and -W must be specified.
Required Arguments
------------------

.. |Add_-J| replace:: |Add_-J_links|
.. include:: explain_-J.rst_
:start-after: **Syntax**
:end-before: **Description**

.. _-R:

.. |Add_-Rgeo| replace:: Not required when |-E| is used.
Expand Down Expand Up @@ -210,6 +206,11 @@ Optional Arguments
- i = All intermittent rivers (5-7)
- c = All canals (8-10)

.. |Add_-J| replace:: |Add_-J_links|
.. include:: explain_-J.rst_
:start-after: **Syntax**
:end-before: **Description**

.. _-L:

.. include:: explain_-L_scale.rst_
Expand Down
12 changes: 6 additions & 6 deletions doc/rst/source/contour.rst
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,6 @@ Synopsis
.. include:: common_SYN_OPTs.rst_

**gmt contour** [ *table* ]
|-J|\ *parameters*
|SYN_OPT-Rz|
[ |-A|\ [**n**\|\ *contours*][*labelinfo*] ]
[ |SYN_OPT-B| ]
Expand All @@ -23,6 +22,7 @@ Synopsis
[ |-E|\ *indexfile*\ [**+b**] ]
[ |-G|\ [**d**\|\ **f**\|\ **n**\|\ **l**\|\ **L**\|\ **x**\|\ **X**]\ *params* ]
[ |-I| ]
[ |-J|\ *parameters* ]
[ |-J|\ **z**\|\ **Z**\ *parameters* ]
[ |-L|\ *pen* ]
[ |-N| ]
Expand Down Expand Up @@ -70,11 +70,6 @@ Required Arguments
.. |Add_intables| unicode:: 0x20 .. just an invisible code
.. include:: explain_intables.rst_

.. |Add_-J| replace:: |Add_-J_links|
.. include:: explain_-J.rst_
:start-after: **Syntax**
:end-before: **Description**

.. |Add_-R| replace:: |Add_-R_auto_table|
.. include:: explain_-R.rst_
:start-after: **Syntax**
Expand Down Expand Up @@ -171,6 +166,11 @@ Optional Arguments
**-I**
Color the triangles using the CPT.

.. |Add_-J| replace:: |Add_-J_links|
.. include:: explain_-J.rst_
:start-after: **Syntax**
:end-before: **Description**

.. _-L:

**-L**\ *pen* :ref:`(more ...) <set-pens>`
Expand Down
12 changes: 6 additions & 6 deletions doc/rst/source/events.rst
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,6 @@ Synopsis
.. include:: common_SYN_OPTs.rst_

**gmt events**
|-J|\ *parameters*
|SYN_OPT-Rz|
|-T|\ *now*
[ *table* ]
Expand All @@ -25,6 +24,7 @@ Synopsis
[ |-F|\ [**+a**\ *angle*][**+f**\ *font*][**+j**\ *justify*][**+r**\ [*first*]\|\ **z**\ [*format*]] ]
[ |-G|\ *color* ]
[ |-H|\ *labelbox* ]
[ |-J|\ *parameters* ]
[ |-L|\ [*length*\|\ **t**] ]
[ |-M|\ **i**\|\ **s**\|\ **t**\|\ **v**\ *val1*\ [**+c**\ *val2*] ]
[ |-N|\ [**c**\|\ **r**] ]
Expand Down Expand Up @@ -86,11 +86,6 @@ Required Arguments
.. |Add_intables| unicode:: 0x20 .. just an invisible code
.. include:: explain_intables.rst_

.. |Add_-J| replace:: |Add_-J_links|
.. include:: explain_-J.rst_
:start-after: **Syntax**
:end-before: **Description**

.. |Add_-R| replace:: |Add_-R_links|
.. include:: explain_-R.rst_
:start-after: **Syntax**
Expand Down Expand Up @@ -221,6 +216,11 @@ Optional Arguments
indicates the shift relative to the foreground text box [4\ **p**/-4\ **p**] and *shade* changes
the fill used for shading [gray50]. **Note**: Modifier **+s** requires **+g** as well.

.. |Add_-J| replace:: |Add_-J_links|
.. include:: explain_-J.rst_
:start-after: **Syntax**
:end-before: **Description**

.. include:: explain_-Jz.rst_

.. _-L:
Expand Down
2 changes: 1 addition & 1 deletion doc/rst/source/grdcontour-classic.rst
Original file line number Diff line number Diff line change
Expand Up @@ -13,13 +13,13 @@ Synopsis
.. include:: common_SYN_OPTs.rst_

**gmt grdcontour** *ingrid*
|-J|\ *parameters*
[ |-A|\ [**n**\ *contours*][*labelinfo*] ]
[ |SYN_OPT-B| ]
[ |-C|\ *contours* ]
[ |-D|\ *template* ]
[ |-F|\ [**l**\|\ **r**] ]
[ |-G|\ [**d**\|\ **f**\|\ **n**\|\ **l**\|\ **L**\|\ **x**\|\ **X**]\ *params* ]
[ |-J|\ *parameters* ]
[ |-J|\ **z**\|\ **Z**\ *parameters* ] [ |-K| ]
[ |-L|\ *low/high*\|\ **n**\|\ **N**\|\ **P**\|\ **p** ]
[ |-N|\ [*cpt*] ]
Expand Down
13 changes: 7 additions & 6 deletions doc/rst/source/grdcontour.rst
Original file line number Diff line number Diff line change
Expand Up @@ -13,12 +13,13 @@ Synopsis
.. include:: common_SYN_OPTs.rst_

**gmt grdcontour** *ingrid*
|-J|\ *parameters* [ |-A|\ [**n**\|\ *contours*][*labelinfo*] ]
[ |-A|\ [**n**\|\ *contours*][*labelinfo*] ]
[ |SYN_OPT-B| ]
[ |-C|\ *contours*\|\ *cpt* ]
[ |-D|\ *template* ]
[ |-F|\ [**l**\|\ **r**] ]
[ |-G|\ [**d**\|\ **f**\|\ **n**\|\ **l**\|\ **L**\|\ **x**\|\ **X**]\ *params* ]
[ |-J|\ *parameters* ]
[ |-L|\ *low/high*\|\ **n**\|\ **N**\|\ **P**\|\ **p** ]
[ |-N|\ [*cpt*] ]
[ |-Q|\ [*n*\|\ *length*\ [*unit*]][**+z**] ]
Expand Down Expand Up @@ -58,11 +59,6 @@ Required Arguments
:start-after: ingrid-syntax-begins
:end-before: ingrid-syntax-ends

.. |Add_-J| replace:: |Add_-J_links|
.. include:: explain_-J.rst_
:start-after: **Syntax**
:end-before: **Description**

Optional Arguments
------------------

Expand Down Expand Up @@ -159,6 +155,11 @@ Optional Arguments

.. include:: explain_contlabel.rst_

.. |Add_-J| replace:: |Add_-J_links|
.. include:: explain_-J.rst_
:start-after: **Syntax**
:end-before: **Description**

.. _-L:

**-L**\ *low/high*\|\ **n**\|\ **N**\|\ **P**\|\ **p**
Expand Down
13 changes: 7 additions & 6 deletions doc/rst/source/grdvector.rst
Original file line number Diff line number Diff line change
Expand Up @@ -12,12 +12,13 @@ Synopsis

.. include:: common_SYN_OPTs.rst_

**gmt grdvector** *grid1* *grid2* |-J|\ *parameters*
**gmt grdvector** *grid1* *grid2*
[ |-A| ]
[ |SYN_OPT-B| ]
[ |-C|\ [*section*/]\ *master*\|\ *cpt*\|\ *color*\ :math:`_1`,\ *color*\ :math:`_2`\ [,\ *color*\ :math:`_3`\ ,...]\ [**+h**\ [*hinge*]][**+i**\ *dz*][**+u**\|\ **U**\ *unit*][**+s**\ *fname*] ]
[ |-G|\ *fill* ]
[ |-I|\ [**x**]\ *dx*\ [/*dy*] ]
[ |-J|\ *parameters* ]
[ |-N| ] [ |-Q|\ *parameters* ]
[ |SYN_OPT-R| ]
[ |-S|\ [**i**\|\ **l**]\ *scale*\ [**+c**\ [[*slon*/]\ *slat*]][**+s**\ *refsize*] ]
Expand Down Expand Up @@ -61,11 +62,6 @@ For :math:`(x,y)`, *grid1* is expected to be the *x*\ -component, and *grid2* to
For :math:`(r,\theta)`, *grid1* is expected to be the magnitude (:math:`r`),
and *grid2* (:math:`\theta`), to be the azimuth (|-Z|) or direction (|-A|).

.. |Add_-J| replace:: |Add_-J_links|
.. include:: explain_-J.rst_
:start-after: **Syntax**
:end-before: **Description**

Optional Arguments
------------------

Expand Down Expand Up @@ -99,6 +95,11 @@ Optional Arguments
**s** for arc seconds. Alternatively, use **-Ix** to specify the
multiples *multx*\ [/*multy*] directly [Default plots every node].

.. |Add_-J| replace:: |Add_-J_links|
.. include:: explain_-J.rst_
:start-after: **Syntax**
:end-before: **Description**

.. _-N:

**-N**
Expand Down
13 changes: 7 additions & 6 deletions doc/rst/source/grdview.rst
Original file line number Diff line number Diff line change
Expand Up @@ -12,11 +12,12 @@ Synopsis

.. include:: common_SYN_OPTs.rst_

**gmt grdview** *reliefgrid* |-J|\ *parameters*
**gmt grdview** *reliefgrid*
[ |SYN_OPT-B| ]
[ |-C|\ [*section*/]\ *master*\|\ *cpt*\|\ *color*\ :math:`_1`,\ *color*\ :math:`_2`\ [,\ *color*\ :math:`_3`\ ,...]\ [**+h**\ [*hinge*]][**+i**\ *dz*][**+u**\|\ **U**\ *unit*][**+s**\ *fname*] ]
[ |-G|\ *drapegrid*\|\ *drapeimage* ]
[ |-I|\ [*file*\|\ *intens*\|\ **+a**\ *azimuth*][**+d**][**+m**\ *ambient*][**+n**\ *args*] ]
[ |-J|\ *parameters* ]
[ |-Jz|\ \|\ **Z**\ *parameters* ]
[ |-N|\ [*level*]\ [**+g**\ *fill*] ]
[ |-Q|\ **c**\|\ **i**\|\ **m**\ [**x**\|\ **y**]\|\ **s**\ [**m**]\ [*color*][**+m**] ]
Expand Down Expand Up @@ -53,11 +54,6 @@ Required Arguments
2-D gridded data set to be imaged (the relief of the surface). (See
:ref:`Grid File Formats <grd_inout_full>`).

.. |Add_-J| replace:: |Add_-J_links|
.. include:: explain_-J.rst_
:start-after: **Syntax**
:end-before: **Description**

Optional Arguments
------------------

Expand All @@ -84,6 +80,11 @@ Optional Arguments

.. include:: explain_intense.rst_

.. |Add_-J| replace:: |Add_-J_links|
.. include:: explain_-J.rst_
:start-after: **Syntax**
:end-before: **Description**

.. _-Jz:

.. include:: explain_-Jz.rst_
Expand Down
3 changes: 2 additions & 1 deletion doc/rst/source/mapproject.rst
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ Synopsis

.. include:: common_SYN_OPTs.rst_

**gmt mapproject** [ *table* ] |-J|\ *parameters*
**gmt mapproject** [ *table* ]
|SYN_OPT-R|
[ |-A|\ **b**\|\ **f**\|\ **o**\ [*lon0*/*lat0*][**+v**] ]
[ |-C|\ [*dx*/*dy*][**+m**] ]
Expand All @@ -21,6 +21,7 @@ Synopsis
[ |-F|\ [**e**\|\ **f**\|\ **k**\|\ **M**\|\ **n**\|\ **u**\|\ **c**\|\ **i**\|\ **p**] ]
[ |-G|\ [*lon0*/*lat0*][**+a**][**+i**][**+u**\ *unit*][**+v**] ]
[ |-I| ]
[ |-J|\ *parameters* ]
[ |-L|\ *table*\ [**+p**][**+u**\ *unit*] ]
[ |-N|\ [**a**\|\ **c**\|\ **g**\|\ **m**] ]
[ |-Q|\ [**d**\|\ **e**] ]
Expand Down
12 changes: 6 additions & 6 deletions doc/rst/source/mask.rst
Original file line number Diff line number Diff line change
Expand Up @@ -14,13 +14,13 @@ Synopsis

**gmt mask** [ *table* ]
|SYN_OPT-I|
|-J|\ *parameters*
|SYN_OPT-R|
[ |SYN_OPT-B| ]
[ |-C| ]
[ |-D|\ *dumpfile* ]
[ |-F|\ [**l**\|\ **r**] ]
[ |-G|\ *fill* ]
[ |-J|\ *parameters* ]
[ |-Jz|\ \|\ **Z**\ *parameters* ]
[ |-L|\ *nodegrid*\ [**+i**\|\ **o**] ]
[ |-N| ]
Expand Down Expand Up @@ -71,11 +71,6 @@ Required Arguments

.. include:: explain_-I.rst_

.. |Add_-J| replace:: [Not mandatory with |-D|]. |Add_-J_links|
.. include:: explain_-J.rst_
:start-after: **Syntax**
:end-before: **Description**

.. |Add_-R| replace:: |Add_-R_auto_table|
.. include:: explain_-R.rst_
:start-after: **Syntax**
Expand Down Expand Up @@ -123,6 +118,11 @@ Optional Arguments
**-G**\ *fill*
Paint the clip polygons (or tiles) with a selected fill [Default is no fill].

.. |Add_-J| replace:: |Add_-J_links|
.. include:: explain_-J.rst_
:start-after: **Syntax**
:end-before: **Description**

.. _-Jz:

.. include:: explain_-Jz.rst_
Expand Down
Loading