.. index:: ! psclip
.. include:: module_core_purpose.rst_

******
psclip
******

|psclip_purpose|

Synopsis
--------

.. include:: common_SYN_OPTs.rst_

**gmt psclip** [ *table* ] |-J|\ *parameters* |-C|\ [*n*]
|SYN_OPT-Rz|
[ |-A|\ [**x**\|\ **y**] ]
[ |SYN_OPT-B| ]
[ |-K| ] [ |-N| ] [ |-O| ]
[ |-P| ] [ |-T| ]
[ |SYN_OPT-U| ]
[ |SYN_OPT-V| ]
[ |-W|\ [*pen*] ]
[ |SYN_OPT-X| ]
[ |SYN_OPT-Y| ]
[ |SYN_OPT-bi| ]
[ |SYN_OPT-di| ]
[ |SYN_OPT-e| ]
[ |SYN_OPT-f| ]
[ |SYN_OPT-g| ]
[ |SYN_OPT-h| ]
[ |SYN_OPT-i| ]
[ |SYN_OPT-p| ]
[ |SYN_OPT-qi| ]
[ |SYN_OPT-t| ]
[ |SYN_OPT-:| ]
[ |SYN_OPT--| ]

.. include:: clip.rst
    :start-after: .. module_common_begins
    :end-before: .. module_common_ends

.. include:: common_classic.rst_

Examples
--------

To see the effect of a simple clip path which result in some symbols
being partly visible or missing altogether, try

   ::

    gmt psclip -R0/6/0/6 -Jx2.5c -W1p,blue -P -K << EOF > clip.ps
    0 0
    5 1
    5 5
    EOF
    gmt psxy @tut_data.txt -Gred -Sc2c -R -J -O -K >> clip.ps
    gmt psclip -C -O -R -J -Baf >> clip.ps

where we activate and deactivate the clip path.  Note we also draw the
outline of the clip path to make it clear what is being clipped.

See Also
--------

:doc:`gmt`, :doc:`grdmask`,
:doc:`psbasemap`, :doc:`psmask`
