! Widely used in most programs that need grid increments to be set */ ! \param GMT ... \param option ... \param error ... */
| 8719 | \param error ... |
| 8720 | */ |
| 8721 | void gmt_inc_syntax (struct GMT_CTRL *GMT, char option, bool error) { |
| 8722 | struct GMTAPI_CTRL *API = GMT->parent; |
| 8723 | if (error) GMT_Report (GMT->parent, GMT_MSG_ERROR, "Option -%c parsing failure. Correct syntax:\n", option); |
| 8724 | GMT_Usage (API, 1, "\n-%c%s", option, GMT_inc_OPT); |
| 8725 | GMT_Usage (API, -2, "Specify increment(s) and optionally append units or modifiers. " |
| 8726 | "For geographic regions in degrees you can optionally append units from this list: " |
| 8727 | "(d)egree [Default], (m)inute, (s)econd, m(e)ter, (f)oot, (k)ilometer, (M)ile, (n)autical mile, s(u)rvey foot."); |
| 8728 | GMT_Usage (API, 3, "+e Adjust the region to fit increments [Adjust increment to fit domain]."); |
| 8729 | GMT_Usage (API, 3, "+n Increment specifies the number of nodes instead. Then, the actual increments " |
| 8730 | "are calculated from the given domain and node-registration settings (see Appendix B for details)."); |
| 8731 | GMT_Usage (API, -2, "Note: If -R<grdfile> was used then -%c " |
| 8732 | "(and -R and maybe -r) have been set; use -%c to override those increments.", option, option); |
| 8733 | } |
| 8734 | |
| 8735 | /*! . |
| 8736 | \param GMT ... |
no test coverage detected