Function usage

src/pshistogram.c:563–638

}

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 -T[<min>/<max>/]<inc>[+i|n] [-A] [%s] [-C<cpt>[+b]] [-D[+b][+f<font>][+o<off>][+r]] "
		"[-E<width>[+o<offset>]] [-F] [-G<fill>] [-I[o|O]] %s[-Ll|h|b] [-N[<mode>][+p<pen>]] %s%s[-Q[r]] [%s] [-S] [%s] [%s] "
		"[-W<pen>] [%s] [%s] [-Z[<mode>][+w]] %s[%s] [%s] [%s] [%s] [%s] [%s] [%s] [%s] [%s] [%s] [%s] [%s] [%s]\n",
		name, GMT_Jx_OPT, GMT_B_OPT, API->K_OPT, API->O_OPT, API->P_OPT, GMT_Rx_OPT, GMT_U_OPT, GMT_V_OPT, GMT_X_OPT, GMT_Y_OPT,
		API->c_OPT, GMT_bi_OPT, GMT_di_OPT, GMT_e_OPT, GMT_f_OPT, GMT_h_OPT, GMT_i_OPT, GMT_o_OPT, GMT_p_OPT, GMT_qi_OPT, GMT_s_OPT,
		GMT_t_OPT, GMT_w_OPT, GMT_PAR_OPT);

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

	GMT_Message (API, GMT_TIME_NONE, "  REQUIRED ARGUMENTS:\n");
	GMT_Option (API, "<");
	GMT_Usage (API, 1, "\n-Jx|X<x-scl>|<width>[/<y-scl>|<height>] for Cartesian scaling.");
	GMT_Usage (API, 1, "\n-T[<min>/<max>/]<inc>[+i|n]");
	GMT_Usage (API, -2, "Make evenly spaced bin boundaries from <min> to <max> by <inc>. "
		"If <min>/<max> is not given then boundaries in -R is used. "
		"For absolute time bins, append a valid time unit (%s) to the increment.", GMT_TIME_UNITS_DISPLAY);
	GMT_Usage (API, 3, "+n Indicate <inc> is the number of bin boundaries to produce instead.");
	GMT_Usage (API, 3, "+i Indicate <inc> is the reciprocal of desired <inc> (e.g., 3 for 0.3333.....).");
	GMT_Usage (API, -2, "Alternatively, give a file with bin boundaries in the first column, or a comma-separate list of values.");
	GMT_Message (API, GMT_TIME_NONE, "\n  OPTIONAL ARGUMENTS:\n");
	GMT_Usage (API, 1, "\n-A Plot horizontal bars, i.e., flip x and y axis [Default is vertical].");
	GMT_Option (API, "B-");
	GMT_Usage (API, 1, "\n-C<cpt>[+b]");
	GMT_Usage (API, -2, "Use CPT to assign color to bars based on the mid-bar coordinate.  Alternatively, append +b "
		"to assign color based on the histogram value instead (count or percent only; see -Z).");
	GMT_Usage (API, 1, "\n-D[+b][+f<font>][+o<off>][+r]");
	GMT_Usage (API, -2, "Place histogram count labels on top of each bar; optionally append modifiers:");
	GMT_Usage (API, 3, "+b Place the labels beneath the bars [above].");
	GMT_Usage (API, 3, "+f Sets the label <font> [FONT_ANNOT_PRIMARY].");
	GMT_Usage (API, 3, "+o Sets the offset <off> between bar and label [6p].");
	GMT_Usage (API, 3, "+r Rotate the label to be vertical [horizontal].");
	GMT_Usage (API, 1, "\n-E<width>[+o<offset>]");
	GMT_Usage (API, -2, "Use custom bar <width> and optionally <offset>. "
		"By default, the bar width is implicitly set via -T and the offset is zero. "
		"Append desired bar width in data units, or append a valid unit (%s) for a fixed width.", GMT_DIM_UNITS_DISPLAY);
	GMT_Usage (API, 3, "+o Add an offset in data units, or append a valid unit (%s) for a fixed offset [0].", GMT_DIM_UNITS_DISPLAY);
	GMT_Usage (API, 1, "\n-F The bin boundaries given should be considered bin centers instead.");
	gmt_fill_syntax (API->GMT, 'G', NULL, "Select color/pattern for columns.");
	GMT_Usage (API, 1, "\n-I[o|O]");
	GMT_Usage (API, -2, "Inquire about min/max x and y.  No plotting is done. Optionally append a directive:");
	GMT_Usage (API, 3, "o: Output the resulting x, y data.");
	GMT_Usage (API, 3, "O: Output all resulting x, y data even with y=0.");
	GMT_Option (API, "K");
	GMT_Usage (API, 1, "\n-Ll|h|b");
	GMT_Usage (API, -2, "Append l|h|b to place extreme values in the first, last, or both bins [skip extremes].");
	GMT_Usage (API, 1, "\n-N[<mode>][+p<pen>]");
	GMT_Usage (API, -2, "Draw the equivalent normal distribution; append desired pen [0.25p,black]. "
		"The <mode> selects which central location and scale to use:");
	GMT_Usage (API, 3, "0: Mean and standard deviation [Default].");
	GMT_Usage (API, 3, "1: Median and L1 scale (MAD w.r.t. median).");
	GMT_Usage (API, 3, "2: LMS mode and LMS scale (MAD w.r.t. mode).");
	GMT_Usage (API, -2, "Note: The -N option may be repeated to draw several of these curves.");
	GMT_Option (API, "O,P");
	GMT_Usage (API, 1, "\n-Q[r]");
	GMT_Usage (API, -2, "Plot a cumulative histogram; append r for reverse cumulative histogram. "