/usr/share/doc/plplot-doc/html/plsetusage.html

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN""http://www.w3.org/TR/html4/loose.dtd">
<HTML
><HEAD
><TITLE
>&#13;      plSetUsage: Set the strings used in usage
      and syntax messages.
    </TITLE
><META
NAME="GENERATOR"
CONTENT="Modular DocBook HTML Stylesheet Version 1.79"><LINK
REL="HOME"
TITLE="The PLplot Plotting Library"
HREF="index.html"><LINK
REL="UP"
TITLE="The Specialized C API for PLplot"
HREF="api-c.html"><LINK
REL="PREVIOUS"
TITLE="
      plsabort: Set abort handler
    "
HREF="plsabort.html"><LINK
REL="NEXT"
TITLE="
      plsexit: Set exit handler
    "
HREF="plsexit.html"><LINK
REL="STYLESHEET"
TYPE="text/css"
HREF="stylesheet.css"></HEAD
><BODY
CLASS="sect1"
BGCOLOR="#FFFFFF"
TEXT="#000000"
LINK="#0000FF"
VLINK="#840084"
ALINK="#0000FF"
><DIV
CLASS="NAVHEADER"
><TABLE
SUMMARY="Header navigation table"
WIDTH="100%"
BORDER="0"
CELLPADDING="0"
CELLSPACING="0"
><TR
><TH
COLSPAN="3"
ALIGN="center"
>The PLplot Plotting Library: Programmer's Reference Manual</TH
></TR
><TR
><TD
WIDTH="10%"
ALIGN="left"
VALIGN="bottom"
><A
HREF="plsabort.html"
ACCESSKEY="P"
>Prev</A
></TD
><TD
WIDTH="80%"
ALIGN="center"
VALIGN="bottom"
>Chapter 20. The Specialized C API for PLplot</TD
><TD
WIDTH="10%"
ALIGN="right"
VALIGN="bottom"
><A
HREF="plsexit.html"
ACCESSKEY="N"
>Next</A
></TD
></TR
></TABLE
><HR
ALIGN="LEFT"
WIDTH="100%"></DIV
><DIV
CLASS="sect1"
><H3
CLASS="sect1"
><A
NAME="plSetUsage"
><CODE
CLASS="function"
>plSetUsage</CODE
>: Set the strings used in usage
      and syntax messages.</A
></H3
><P
>&#13;      <DIV
CLASS="funcsynopsis"
><P
></P
><A
NAME="AEN13901"
></A
><TABLE
CLASS="funcprototype"
><TR
><TD
><CODE
CLASS="FUNCDEF"
>&#13;	    plSetUsage
	  </CODE
>(program_string, usage_string);</TD
></TR
></TABLE
><P
></P
></DIV
>
    </P
><P
>&#13;      Sets the program string and usage string displayed by the command 
      line help option (-h) and by <A
HREF="ploptusage.html"
><CODE
CLASS="function"
>plOptUsage</CODE
></A
>.
    </P
><TABLE
CLASS="variablelist"
><TR
><TD
><DL
><DT
><CODE
CLASS="parameter"
>program_string</CODE
>
	  (<TT
CLASS="literal"
>const char *</TT
>, input)</DT
><DD
><P
>&#13;	    String to appear as the name of program. 
	  </P
></DD
><DT
><CODE
CLASS="parameter"
>usage_string</CODE
>
	  (<TT
CLASS="literal"
>const char *</TT
>, input)</DT
><DD
><P
>&#13;	  String to appear as the usage text.
	  </P
></DD
></DL
></TD
></TR
></TABLE
><P
>&#13;      This function is currently available in C, C++, Java, Ocaml, Octave
      and Python.
    </P
><P
>&#13;      This function is not used in any examples.
    </P
></DIV
><DIV
CLASS="NAVFOOTER"
><HR
ALIGN="LEFT"
WIDTH="100%"><TABLE
SUMMARY="Footer navigation table"
WIDTH="100%"
BORDER="0"
CELLPADDING="0"
CELLSPACING="0"
><TR
><TD
WIDTH="33%"
ALIGN="left"
VALIGN="top"
><A
HREF="plsabort.html"
ACCESSKEY="P"
>Prev</A
></TD
><TD
WIDTH="34%"
ALIGN="center"
VALIGN="top"
><A
HREF="index.html"
ACCESSKEY="H"
>Home</A
></TD
><TD
WIDTH="33%"
ALIGN="right"
VALIGN="top"
><A
HREF="plsexit.html"
ACCESSKEY="N"
>Next</A
></TD
></TR
><TR
><TD
WIDTH="33%"
ALIGN="left"
VALIGN="top"
><CODE
CLASS="function"
>plsabort</CODE
>: Set abort handler</TD
><TD
WIDTH="34%"
ALIGN="center"
VALIGN="top"
><A
HREF="api-c.html"
ACCESSKEY="U"
>Up</A
></TD
><TD
WIDTH="33%"
ALIGN="right"
VALIGN="top"
><CODE
CLASS="function"
>plsexit</CODE
>: Set exit handler</TD
></TR
></TABLE
></DIV
></BODY
></HTML
>
plplot-doc 5.9.9-2ubuntu2 / usr / share / doc / plplot-doc / html / plsetusage.html
