libstatgrab/docs/get_general_stats.xml

<?xml version="1.0"?>

<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
               "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">

<refentry id="get_general_stats">

  <refentryinfo>
    <date>$Date: 2004/03/11 17:35:24 $</date>
    <releaseinfo>$Id: get_general_stats.xml,v 1.3 2004/03/11 17:35:24 tdb Exp $</releaseinfo>
  </refentryinfo>
  
  <refmeta>
    <refentrytitle>get_general_stats</refentrytitle>
    <manvolnum>3</manvolnum>
    <refmiscinfo>i-scream</refmiscinfo>
  </refmeta>
  
  <refnamediv>
    <refname>get_general_stats</refname>
    <refpurpose>get general operating system statistics</refpurpose>
  </refnamediv>
    
  <refsynopsisdiv>
    <funcsynopsis>
      <funcsynopsisinfo>#include &lt;statgrab.h&gt;</funcsynopsisinfo>
      <funcprototype>
        <funcdef>general_stat_t *<function>get_general_stats</function></funcdef>
        <void/>
      </funcprototype>
    </funcsynopsis>
  </refsynopsisdiv>
    
  <refsect1>
    <title>Description</title>
    <para>
      This call returns details on the operating system.
    </para>
    <para>
      It returns a pointer to a static buffer of
      <structname>general_stat_t</structname>.
    </para>
  </refsect1>
  
  <refsect1>
    <title>Return Values</title>

    <para>
      The structure returned is of type
      <structname>general_stat_t</structname>.
    </para>

    <programlisting>
typedef struct{
        char *os_name;
        char *os_release;
        char *os_version;
        char *platform;
        char *hostname;
        time_t uptime;
}general_stat_t;
    </programlisting>

    <variablelist>
      <varlistentry>
        <term><structfield>os_name</structfield></term>
        <listitem>
          <para>
            the operating system name.
            (eg. SunOS or Linux)
          </para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><structfield>os_release</structfield></term>
        <listitem>
          <para>
            the operating system release.
            (eg. 5.8 or 5.9 or Solaris)
          </para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><structfield>os_version</structfield></term>
        <listitem>
          <para>
            the version level of the OS.
          </para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><structfield>platform</structfield></term>
        <listitem>
          <para>
            the hardware platform (architecture) the OS runs on.
          </para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><structfield>hostname</structfield></term>
        <listitem>
          <para>
            the name of the machine.
          </para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><structfield>uptime</structfield></term>
        <listitem>
          <para>
            the uptime of the machine in seconds.
          </para>
        </listitem>
      </varlistentry>
    </variablelist>
  </refsect1>

  <refsect1>
    <title>See Also</title>

    <simplelist type="inline">
      <member>
        <citerefentry>
          <refentrytitle>statgrab</refentrytitle>
          <manvolnum>3</manvolnum>
        </citerefentry>
      </member>
    </simplelist>
  </refsect1>
  
  <refsect1>
    <title>Website</title>
    
    <simplelist type="vert">
      <member>
        <ulink url="http://www.i-scream.org/libstatgrab/">
          http://www.i-scream.org/libstatgrab/
        </ulink>
      </member>
    </simplelist>
  </refsect1>

</refentry>
Revision:	1.4
Committed:	Sun May 2 09:35:15 2004 UTC (20 years ago) by tdb
Content type:	text/xml
Branch:	MAIN
CVS Tags:	HEAD
Changes since 1.3:	+2 -2 lines
State:	*FILE REMOVED*
Log Message:	Do a repo copy of the documentation to their new names, then delete the old ones. They still need their content updating though. We also need docs for the new process stats stuff, the error reporting code, and I think the FS stats which seem to be missing.
#	Content
1	<?xml version="1.0"?>
2
3	<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
4	"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
5
6	<refentry id="get_general_stats">
7
8	<refentryinfo>
9	<date>$Date: 2004/03/11 17:35:24 $</date>
10	<releaseinfo>$Id: get_general_stats.xml,v 1.3 2004/03/11 17:35:24 tdb Exp $</releaseinfo>
11	</refentryinfo>
12
13	<refmeta>
14	<refentrytitle>get_general_stats</refentrytitle>
15	<manvolnum>3</manvolnum>
16	<refmiscinfo>i-scream</refmiscinfo>
17	</refmeta>
18
19	<refnamediv>
20	<refname>get_general_stats</refname>
21	<refpurpose>get general operating system statistics</refpurpose>
22	</refnamediv>
23
24	<refsynopsisdiv>
25	<funcsynopsis>
26	<funcsynopsisinfo>#include <statgrab.h></funcsynopsisinfo>
27	<funcprototype>
28	<funcdef>general_stat_t *<function>get_general_stats</function></funcdef>
29	<void/>
30	</funcprototype>
31	</funcsynopsis>
32	</refsynopsisdiv>
33
34	<refsect1>
35	<title>Description</title>
36	<para>
37	This call returns details on the operating system.
38	</para>
39	<para>
40	It returns a pointer to a static buffer of
41	<structname>general_stat_t</structname>.
42	</para>
43	</refsect1>
44
45	<refsect1>
46	<title>Return Values</title>
47
48	<para>
49	The structure returned is of type
50	<structname>general_stat_t</structname>.
51	</para>
52
53	<programlisting>
54	typedef struct{
55	char *os_name;
56	char *os_release;
57	char *os_version;
58	char *platform;
59	char *hostname;
60	time_t uptime;
61	}general_stat_t;
62	</programlisting>
63
64	<variablelist>
65	<varlistentry>
66	<term><structfield>os_name</structfield></term>
67	<listitem>
68	<para>
69	the operating system name.
70	(eg. SunOS or Linux)
71	</para>
72	</listitem>
73	</varlistentry>
74	<varlistentry>
75	<term><structfield>os_release</structfield></term>
76	<listitem>
77	<para>
78	the operating system release.
79	(eg. 5.8 or 5.9 or Solaris)
80	</para>
81	</listitem>
82	</varlistentry>
83	<varlistentry>
84	<term><structfield>os_version</structfield></term>
85	<listitem>
86	<para>
87	the version level of the OS.
88	</para>
89	</listitem>
90	</varlistentry>
91	<varlistentry>
92	<term><structfield>platform</structfield></term>
93	<listitem>
94	<para>
95	the hardware platform (architecture) the OS runs on.
96	</para>
97	</listitem>
98	</varlistentry>
99	<varlistentry>
100	<term><structfield>hostname</structfield></term>
101	<listitem>
102	<para>
103	the name of the machine.
104	</para>
105	</listitem>
106	</varlistentry>
107	<varlistentry>
108	<term><structfield>uptime</structfield></term>
109	<listitem>
110	<para>
111	the uptime of the machine in seconds.
112	</para>
113	</listitem>
114	</varlistentry>
115	</variablelist>
116	</refsect1>
117
118	<refsect1>
119	<title>See Also</title>
120
121	<simplelist type="inline">
122	<member>
123	<citerefentry>
124	<refentrytitle>statgrab</refentrytitle>
125	<manvolnum>3</manvolnum>
126	</citerefentry>
127	</member>
128	</simplelist>
129	</refsect1>
130
131	<refsect1>
132	<title>Website</title>
133
134	<simplelist type="vert">
135	<member>
136	<ulink url="http://www.i-scream.org/libstatgrab/">
137	http://www.i-scream.org/libstatgrab/
138	</ulink>
139	</member>
140	</simplelist>
141	</refsect1>
142
143	</refentry>