<?xml version="1.0"?>
<!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN" 
"http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" [ 
  <!ENTITY legal SYSTEM "legal.xml">
  <!ENTITY appversion "2.1.1">
  <!ENTITY manrevision "2.4">
  <!ENTITY date "January 2003">
  <!ENTITY app "System Log Viewer">
]>
<!-- 
      (Do not remove this comment block.)
  Maintained by the GNOME Documentation Project
  http://developer.gnome.org/projects/gdp
  Template version: 2.0 beta
  Template last modified Apr 11, 2002
  
-->
<!-- =============Document Header ============================= -->
<article id="index" lang="en">
<!-- please do not change the id; for translations, change lang to -->
<!-- appropriate code -->
  <articleinfo> 
    <title>&app; Manual V&manrevision;</title>       

    <copyright> 
      <year>2003</year> 
      <holder>Sun Microsystems</holder> 
    </copyright> 
    <copyright> 
      <year>2000</year> 
      <holder>Judith Samson</holder> 
    </copyright> 
<!-- translators: uncomment this:

  <copyright>
   <year>2002</year>
   <holder>ME-THE-TRANSLATOR (Latin translation)</holder>
  </copyright>

   -->
    <publisher> 
      <publishername> GNOME Documentation Project </publishername> 
    </publisher> 

   &legal;

   <authorgroup> 
   <author> 
		<firstname>Sun</firstname> 
		<surname>GNOME Documentation Team</surname> 
		<affiliation> 
	  	<orgname>Sun Microsystems</orgname> 
	  	<address> <email>gdocteam@sun.com</email> </address> 
		</affiliation> 
   </author> 

   <author> 
		<firstname>Judith</firstname> 
		<surname>Samson</surname> 
		<affiliation> 
	  	<orgname>GNOME Documentation Project</orgname> 
	  	<address> <email>judith@samsonsource.com</email> </address> 
		</affiliation> 
   </author> 
      
<!-- This is appropriate place for other contributors: translators,
      maintainers,  etc. Commented out by default.
   <othercredit role="translator">
		<firstname>Latin</firstname> 
		<surname>Translator 1</surname> 
		<affiliation> 
	  	<orgname>Latin Translation Team</orgname> 
	  	<address> <email>translator@gnome.org</email> </address> 
		</affiliation>
		<contrib>Latin translation</contrib>
   </othercredit>
-->
    </authorgroup>

    <revhistory>
      <revision> 
		<revnumber>&app; Manual V&manrevision;</revnumber> 
		<date>&date;</date> 
		<revdescription> 
	  		<para role="author">Sun GNOME Documentation Team
	    		<email>gdocteam@sun.com</email>
	  		</para>
	  		<para role="publisher">GNOME Documentation Project</para>
		</revdescription> 
      </revision>
      <revision> 
		<revnumber>System Log Viewer Manual V2.3</revnumber> 
		<date>October 2002</date> 
		<revdescription> 
	  		<para role="author">Sun GNOME Documentation Team
	    		<email>gdocteam@sun.com</email>
	  		</para>
	  		<para role="publisher">GNOME Documentation Project</para>
		</revdescription> 
      </revision>
      <revision> 
		<revnumber>System Log Viewer Manual V2.2</revnumber> 
		<date>August 2002</date> 
		<revdescription> 
	  		<para role="author">Sun GNOME Documentation Team
	    		<email>gdocteam@sun.com</email>
	  		</para>
	  		<para role="publisher">GNOME Documentation Project</para>
		</revdescription> 
      </revision>
      <revision> 
		<revnumber>System Log Viewer Manual V2.1</revnumber> 
		<date>July 2002</date> 
		<revdescription> 
	  		<para role="author">Sun GNOME Documentation Team
	    		<email>gdocteam@sun.com</email>
	  		</para>
	  		<para role="publisher">GNOME Documentation Project</para>
		</revdescription> 
      </revision>
      <revision> 
		<revnumber>System Log Viewer Manual V2.0</revnumber> 
		<date>May 2002</date> 
		<revdescription> 
	  		<para role="author">Sun GNOME Documentation Team
	    		<email>gdocteam@sun.com</email>
	  		</para>
	  		<para role="publisher">GNOME Documentation Project</para>
		</revdescription> 
      </revision> 
      <revision> 
		<revnumber>Logview Manual</revnumber> 
		<date>2000</date> 
		<revdescription> 
	  		<para role="author">Judith Samson
	    		<email>judith@samsonsource.com</email>
	  		</para>
	  		<para role="publisher">GNOME Documentation Project</para>
			</revdescription> 
      </revision> 
    </revhistory> 

    <releaseinfo>This manual describes version &appversion; of &app;.
    </releaseinfo> 
    <legalnotice> 
      <title>Feedback</title> 
      <para>To report a bug or make a suggestion regarding the &app; application or
	this manual, follow the directions in the 
	<ulink url="ghelp:gnome-feedback"
	  type="help">GNOME Feedback Page</ulink>. 
      </para>
<!-- Translators may also add here feedback address for translations -->
    </legalnotice> 
  </articleinfo> 

  <indexterm> 
    <primary>System Log Viewer</primary> 
  </indexterm> 

<!-- ============= Document Body ============================= -->
<!-- ============= Introduction ============================== -->

  <sect1 id="syslog-introduction"> 
    <title>Introduction</title> 
    <para>The <application>&app;</application> application enables you to monitor and view system log files. 
    To view system log files, you may need to log in as root.</para>
  </sect1>

  <sect1 id="syslog-getting-started">
    <title>Getting Started</title> 

    <para>You can start <application>&app;</application> in the following ways:
    </para> 
    <variablelist>
    	<varlistentry>
    		<term><guimenu>Applications</guimenu> menu</term>
    		<listitem>
    		<para>Choose <menuchoice><guisubmenu>System Tools</guisubmenu><guimenuitem>System Log</guimenuitem></menuchoice>.</para>
    		</listitem>
    	</varlistentry>
    	<varlistentry>
    		<term>Command line</term>
    		<listitem>
    		<para>Type <command>gnome-system-log</command>, then press <keycap>Return</keycap>.</para>
    		<para> 		 
    		</para> 
    		</listitem>
    	</varlistentry>
    </variablelist>

    <para>When you start <application>&app;</application>, the following window is displayed.</para>

    <!-- ==== Figure ==== -->
      <figure id="syslog-fig"> 
	<title>&app; Window</title> 
	<screenshot> 
	  <mediaobject> 
	    <imageobject>
	    <imagedata fileref="figures/syslog_window.png" format="PNG"/> 
	    </imageobject>
	    <textobject> 
	      <phrase>Shows &app; main window. Contains menubar, display area, scrollbars, and statusbar. </phrase> 
	    </textobject> 
	  </mediaobject> 
	</screenshot> 
      </figure>
    <!-- ==== End of Figure ==== -->
    <para>When you start <application>&app;</application>, the application displays the <filename>/var/log/messages</filename> 
    log file by default.</para>

  </sect1>

<!-- ================ Usage ================================ -->

  <sect1 id="syslog-usage"> 
    <title>Usage</title>

    <sect2 id="syslog-open">
    	<title>To View a Log File</title>
    	<para>To view a log file, choose <menuchoice><guimenu>File</guimenu><guimenuitem>Open</guimenuitem></menuchoice>. 
    	In the <guilabel>Open new logfile</guilabel> dialog, enter the name of the log file that you want to open, then click 
    	<guibutton>OK</guibutton>. Use the scrollbars to scroll through the log file.</para>
    	<para>You can open as many log files as you want. <application>&app;</application> displays one log file at a time in 
    	the <guilabel>System Log Viewer</guilabel> window. To display another log file that is already open in 
    	<application>&app;</application>, choose <menuchoice><guimenu>File</guimenu><guimenuitem>Switch Log</guimenuitem></menuchoice>. 
    	To continue to move through the open log files, choose <menuchoice><guimenu>File</guimenu><guimenuitem>Switch Log</guimenuitem>
    	</menuchoice>.</para> 
    </sect2>
    
    <sect2 id="syslog-details">
    	<title>To View More Information About a Log File Entry</title>
    	<para>To view more detailed information about a log file entry, select the entry in the display area, then choose
    	<menuchoice><guimenu>View</guimenu><guimenuitem>Entry Detail</guimenuitem></menuchoice>. <application>&app;</application>
    	displays a <guilabel>Zoom view</guilabel> window that contains the following information:</para>
    	<itemizedlist>
    		<listitem><para>The date of the log entry.</para>
    		</listitem>
    		<listitem><para>The name of the process that caused the log entry.</para>
    		</listitem>
    		<listitem><para>The log message.</para>
    		</listitem>
    		<listitem><para>A description of the log message if available.</para>
    		</listitem>
    	</itemizedlist> 
    </sect2>
    
    <sect2 id="syslog-monitor">
    	<title>To Monitor Log Files</title>
    	<para>You can use <application>&app;</application> to monitor selected log files. When you select a log file to monitor, 
    	<application>&app;</application> displays the most recent entries from the log file in a separate window. 
    	<application>&app;</application> updates the <guilabel>Monitoring logs</guilabel> window to display new entries 
    	as they are added.</para>
    	<para>To monitor a log file, perform the following steps:</para>
    	<orderedlist>
    		<listitem><para>Choose <menuchoice><guimenu>File</guimenu><guimenuitem>Monitor</guimenuitem></menuchoice>.</para></listitem>
    		<listitem><para>Select the log file that you want to monitor in the left pane of the <guilabel>Monitor options</guilabel> 
    		dialog. </para></listitem>
    		<listitem><para>Click <guibutton>Add</guibutton>. </para></listitem>
    		<listitem><para>To hide the main <application>&app;</application> window while you are monitoring log files, 
    		select the <guilabel>Hide Application</guilabel> checkbox. </para></listitem>
    	</orderedlist>	
    	<para><application>&app;</application> displays the log file in a <guilabel>Monitoring logs</guilabel> window. 
    	<application>&app;</application> can monitor several log files simultaneously but the application only displays one file 
    	at a time in the <guilabel>Monitoring logs</guilabel> window. <application>&app;</application> adds a tab for each log
    	file that the application is monitoring.</para> 
    </sect2>
    
    <sect2 id="syslog-calendar">
    	<title>To View a Calendar</title>
    	<para>To view a calendar, choose <menuchoice><guimenu>View</guimenu><guimenuitem>Calendar</guimenuitem></menuchoice>. The dates
    	for which log files exist are displayed in bold. To view the log files for a particular date, select the date in the calendar.</para> 
    </sect2>
    
    <sect2 id="syslog-stats">
    	<title>To View Log File Properties</title>
    	<para>To view the properties of the log file, choose <menuchoice><guimenu>File</guimenu><guimenuitem>Properties</guimenuitem></menuchoice>.
    	The <guilabel>Log stats</guilabel> dialog displays the following information about the file:</para> 
    	<itemizedlist>
    		<listitem><para>Size of the file in bytes.</para>
    		</listitem>
    		<listitem><para>Date the file was last modified.</para>
    		</listitem>
    		<listitem><para>Date the file was created.</para>
    		</listitem>
    		<listitem><para>Date of the most recent log entry.</para>
    		</listitem>
    		<listitem><para>Number of lines in the file.</para>
    		</listitem>
    	</itemizedlist> 
    </sect2>
    
    <sect2 id="syslog-close">
    	<title>To Close a Log File</title>
    	<para>To close a log file, choose <menuchoice><guimenu>File</guimenu><guimenuitem>Close</guimenuitem></menuchoice>. </para> 
    </sect2>
    
    <sect2 id="syslog-exit">
    	<title>To Exit &app;</title>
    	<para>To exit <application>&app;</application>, choose <menuchoice><guimenu>File</guimenu><guimenuitem>Quit</guimenuitem></menuchoice>. </para> 
    </sect2>
 
  </sect1>

</article>
