Function usage

src/psmask.c:436–484

}

static int usage (struct GMTAPI_CTRL *API, int level) {
	const char *name = gmt_show_name_and_purpose (API, THIS_MODULE_LIB, THIS_MODULE_CLASSIC_NAME, THIS_MODULE_PURPOSE);
	if (level == GMT_MODULE_PURPOSE) return (GMT_NOERROR);
	GMT_Usage (API, 0, "usage: %s <table> %s %s %s [%s] [-C] [-D<template>] [-F[l|r]] [-G<fill>] %s[-L<grdfile>[+i|o]] [-N] "
		"%s%s[-Q<min>] [-S%s] [-T] [%s] [%s] [%s] [%s] %s [%s] [%s] [%s] [%s] [%s] [%s] [%s] [%s] [%s] [%s] [%s] [%s]\n",
		name, GMT_I_OPT, GMT_J_OPT, GMT_Rgeoz_OPT, GMT_B_OPT, API->K_OPT, API->O_OPT, API->P_OPT, GMT_RADIUS_OPT, GMT_U_OPT,
		GMT_V_OPT, GMT_X_OPT, GMT_Y_OPT, GMT_b_OPT, API->c_OPT, GMT_d_OPT, GMT_e_OPT, GMT_h_OPT, GMT_i_OPT, GMT_p_OPT,
		GMT_qi_OPT, GMT_r_OPT, GMT_t_OPT, GMT_w_OPT, GMT_colon_OPT, GMT_PAR_OPT);

	if (level == GMT_SYNOPSIS) return (GMT_MODULE_SYNOPSIS);

	GMT_Message (API, GMT_TIME_NONE, "  REQUIRED ARGUMENTS:\n");
	GMT_Option (API, "<,I,J-Z,R");
	GMT_Message (API, GMT_TIME_NONE, "\n  OPTIONAL ARGUMENTS:\n");
	GMT_Option (API, "B-");
	GMT_Usage (API, 1, "\n-C Terminate existing clip-path.  No other options required.");
	GMT_Usage (API, 1, "\n-D<template>");
	GMT_Usage (API, -2, "Dump clip polygons as data polygons; no plotting takes place. "
		"Append filename <template> which may contain a C-format specifier. "
		"If no filename is given we write all polygons to standard output. "
		"If filename has no specifiers then we write all polygons to a single file. "
		"If an integer format (e.g., %%06d) is found we substitute a running segment count "
		"and write all polygons to individual files; see module documentation for more examples.");
	GMT_Usage (API, -2, "Note: Cannot be used with -T; see -Q to eliminate small polygons.");
	GMT_Usage (API, 1, "\n-F[l|r]");
	GMT_Usage (API, -2, "Force clip contours to be oriented so that the higher z-values "
		"are to the left (-Fl [Default]) or right (-Fr) as we move along "
		"the contour lines [Default is not oriented].");
	gmt_fill_syntax (API->GMT, 'G', NULL, "Select fill color/pattern [Default is no fill].");
	GMT_Option (API, "K");
	GMT_Usage (API, 1, "\n-L<grdfile>[+i|o]");
	GMT_Usage (API, -2, "Save internal on/off grid to <grdfile> for testing [no grid saved]. Optionally, add a modifier:");
	GMT_Usage (API, 3, "+i Change inside nodes to NaNs.");
	GMT_Usage (API, 3, "+o Change outside nodes to NaNs.");
	GMT_Usage (API, 1, "\n-N Invert the sense of the clipping [or tiling].");
	GMT_Option (API, "O,P");
	GMT_Usage (API, 1, "\n-Q<min>");
	GMT_Usage (API, -2, "Do not dump contours with less than <min> points [Dump all contours]. "
		"Note: Ignored unless -D is set.");
	gmt_dist_syntax (API->GMT, "S" GMT_RADIUS_OPT, "Set search radius to identify inside points.");
	GMT_Usage (API, -2, "Grid nodes inside circles of <radius> centered on the input "
		"data points are considered to be reliable estimates of the surface. "
		"Default is -S0, i.e., only the nearest node is considered reliable.");
	GMT_Usage (API, 1, "\n-T Paint tiles [Default will trace data outline and set a clip path]. "
		"Note: If set you must also specify a color/fill with -G.");
	GMT_Option (API, "U,V,X,bi2,bo,c,d,e,h,i,p,qi,r,t,w,:,.");

	return (GMT_MODULE_USAGE);
}

static int parse (struct GMT_CTRL *GMT, struct PSMASK_CTRL *Ctrl, struct GMT_OPTION *options) {
	/* This parses the options provided to psmask and sets parameters in Ctrl.