doc/xml/AdminReference/sect8/fstrace_lslog.xml

   1 <?xml version="1.0" encoding="UTF-8"?>
   2 <refentry id="fstrace_lslog8">
   3   <refmeta>
   4     <refentrytitle>fstrace lslog</refentrytitle>
   5     <manvolnum>8</manvolnum>
   6   </refmeta>
   7   <refnamediv>
   8     <refname>fstrace lslog</refname>
   9     <refpurpose>Displays information about a log</refpurpose>
  10   </refnamediv>
  11   <refsect1>
  12     <title>Synopsis</title>
  13     <para><emphasis role="bold">fstrace lslog</emphasis> [<emphasis role="bold">-set</emphasis> &lt;<emphasis>set name</emphasis>&gt;+] [<emphasis role="bold">-log</emphasis> &lt;<emphasis>log name</emphasis>&gt;]
  14         [<emphasis role="bold">-long</emphasis>] [<emphasis role="bold">-help</emphasis>]</para>
  15
  16     <para><emphasis role="bold">fstrace lsl</emphasis> [<emphasis role="bold">-s</emphasis> &lt;<emphasis>set name</emphasis>&gt;+] [<emphasis role="bold">-log</emphasis> &lt;<emphasis>log name</emphasis>&gt;] [<emphasis role="bold">-lon</emphasis>]
  17         [<emphasis role="bold">-h</emphasis>]</para>
  18
  19   </refsect1>
  20   <refsect1>
  21     <title>Description</title>
  22     <para>The <emphasis role="bold">fstrace lslog</emphasis> command reports whether the <computeroutput>cmfx</computeroutput> log is available
  23     for use. If the <emphasis role="bold">-long</emphasis> argument is included, the output reports the
  24     log's defined size, and whether that amount of space is currently
  25     allocated in kernel memory or not.</para>
  26
  27     <para>To change the <computeroutput>cmfx</computeroutput> trace log's size, use the <emphasis role="bold">fstrace setlog</emphasis>
  28     command. To display or set whether space is allocated for it in kernel
  29     memory, use the <emphasis role="bold">fstrace lsset</emphasis> or <emphasis role="bold">fstrace setset</emphasis> command to display
  30     or set the state of the corresponding <computeroutput>cm</computeroutput> event set, respectively.</para>
  31
  32   </refsect1>
  33   <refsect1>
  34     <title>Options</title>
  35     <variablelist>
  36       <varlistentry>
  37         <term><emphasis role="bold">-set</emphasis> &lt;<emphasis>set name</emphasis>&gt;+</term>
  38         <listitem>
  39           <para>Names the event set for which to display information about the
  40           corresponding trace log. The only acceptable value is <computeroutput>cm</computeroutput> (for which the
  41           associated trace log is <computeroutput>cmfx</computeroutput>). Provide either this argument or the
  42           <emphasis role="bold">-log</emphasis> argument, or omit both to display information about the <computeroutput>cmfx</computeroutput>
  43           log by default.</para>
  44
  45         </listitem>
  46       </varlistentry>
  47       <varlistentry>
  48         <term><emphasis role="bold">-log</emphasis> &lt;<emphasis>log name</emphasis>&gt;</term>
  49         <listitem>
  50           <para>Names the trace log about which to report. The only acceptable value is
  51           <computeroutput>cmfx</computeroutput>. Provide either this argument or the <emphasis role="bold">-set</emphasis> argument, or omit
  52           both to report on the <computeroutput>cmfx</computeroutput> log by default.</para>
  53
  54         </listitem>
  55       </varlistentry>
  56       <varlistentry>
  57         <term><emphasis role="bold">-long</emphasis></term>
  58         <listitem>
  59           <para>Reports the defined size of the log in kilobyte units and whether that
  60           amount of space is currently allocated in kernel memory.</para>
  61
  62         </listitem>
  63       </varlistentry>
  64       <varlistentry>
  65         <term><emphasis role="bold">-help</emphasis></term>
  66         <listitem>
  67           <para>Prints the online help for this command. All other valid options are
  68           ignored.</para>
  69
  70         </listitem>
  71       </varlistentry>
  72     </variablelist>
  73   </refsect1>
  74   <refsect1>
  75     <title>Output</title>
  76     <para>By default, the <emphasis role="bold">fstrace lslog</emphasis> command displays only the name of the
  77     available log, <computeroutput>cmfx</computeroutput>, in the following format:</para>
  78
  79 <programlisting>
  80    Available logs:
  81    cmfx
  82
  83 </programlisting>
  84       <para>When the <emphasis role="bold">-long</emphasis> flag is included, the output also reports the defined
  85       size of the log in kilobytes, and whether or not that amount of space is
  86       currently allocated in kernel memory, in the following format:</para>
  87
  88 <programlisting>
  89    Available logs:
  90    cmfx : &amp;lt;log_size&amp;gt; kbytes (allocated | unallocated)
  91
  92 </programlisting>
  93         <para>The <computeroutput>allocated</computeroutput> state indicates that the indicated number of kilobytes is
  94         reserved for the <computeroutput>cmfx</computeroutput> trace log in kernel memory. The <computeroutput>cm</computeroutput> event set's
  95         state is either <computeroutput>active</computeroutput> or <computeroutput>inactive</computeroutput>, as reported by the <emphasis role="bold">fstrace
  96         lsset</emphasis> command, and set by the <emphasis role="bold">fstrace setset</emphasis> command's <emphasis role="bold">-active</emphasis> or
  97         <emphasis role="bold">-inactive</emphasis> flags respectively.</para>
  98
  99         <para>The <computeroutput>unallocated</computeroutput> state indicates that no kernel memory is currently
 100         reserved for the <computeroutput>cmfx</computeroutput> trace log. The <emphasis role="bold">cm</emphasis> event set's state is
 101         <computeroutput>dormant</computeroutput>, as reported by the <emphasis role="bold">fstrace lsset</emphasis> command and set by the
 102         <emphasis role="bold">fstrace setset</emphasis> command's <emphasis role="bold">-dormant</emphasis> flag. If the event set's state is
 103         later changed to active or inactive, the number of kilobytes indicated as
 104         &lt;log_size&gt; are again allocated in kernel memory.</para>
 105
 106       </refsect1>
 107       <refsect1>
 108         <title>Examples</title>
 109         <para>The following example uses the -long flag to display information
 110         about the <computeroutput>cmfx</computeroutput> log:</para>
 111
 112 <programlisting>
 113    # fstrace lslog -log cmfx -long
 114    Available logs:
 115    cmfx : 60 kbytes (allocated)
 116
 117 </programlisting>
 118         </refsect1>
 119         <refsect1>
 120           <title>Privilege Required</title>
 121           <para>The issuer must be logged in as the local superuser <computeroutput>root</computeroutput>.</para>
 122
 123         </refsect1>
 124         <refsect1>
 125           <title>See Also</title>
 126           <para><link linkend="fstrace8">fstrace(8)</link>,
 127           <link linkend="fstrace_lsset8">fstrace_lsset(8)</link>,
 128           <link linkend="fstrace_setlog8">fstrace_setlog(8)</link></para>
 129
 130         </refsect1>
 131         <refsect1>
 132           <title>Copyright</title>
 133           <para>IBM Corporation 2000. &lt;http://www.ibm.com/&gt; All Rights Reserved.</para>
 134
 135           <para>This documentation is covered by the IBM Public License Version 1.0.  It was
 136           converted from HTML to POD by software written by Chas Williams and Russ
 137           Allbery, based on work by Alf Wachsmann and Elizabeth Cassell.</para>
 138
 139         </refsect1>
 140       </refentry>