diff options
Diffstat (limited to 'logview/help/C/index.docbook')
| -rw-r--r-- | logview/help/C/index.docbook | 365 |
1 files changed, 365 insertions, 0 deletions
diff --git a/logview/help/C/index.docbook b/logview/help/C/index.docbook new file mode 100644 index 00000000..fe51cfe6 --- /dev/null +++ b/logview/help/C/index.docbook @@ -0,0 +1,365 @@ +<?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.12"> + <!ENTITY manrevision "2.4"> + <!ENTITY date "October 2005"> + <!ENTITY app "System Log Viewer"> +]> +<!-- + (Do not remove this comment block.) + Maintained by the MATE Documentation Project + http://developer.mate.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</title> + + <abstract role="description"> + <para>System Log Viewer is a graphical user interface to view and monitor + system log files.</para> + </abstract> + + <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> MATE Documentation Project </publishername> + </publisher> + + &legal; + + <authorgroup> + <author> + <firstname>Sun</firstname> + <surname>MATE Documentation Team</surname> + <affiliation> + <orgname>Sun Microsystems</orgname> + <address> <email>[email protected]</email> </address> + </affiliation> + </author> + + <author> + <firstname>Judith</firstname> + <surname>Samson</surname> + <affiliation> + <orgname>MATE Documentation Project</orgname> + <address> <email>[email protected]</email> </address> + </affiliation> + </author> + + <author> + <firstname>Paul</firstname> + <surname>Cutler</surname> + <affiliation> + <orgname>MATE Documentation Team</orgname> + <address> <email>[email protected]</email> </address> + </affiliation> + </author> + + <author role="maintainer"> + <firstname>Vincent</firstname> + <surname>Noel</surname> + <affiliation> + <address><email>[email protected]</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>[email protected]</email> </address> + </affiliation> + <contrib>Latin translation</contrib> + </othercredit> +--> + </authorgroup> + + <revhistory> + <revision> + <revnumber>&app; Manual V2.5</revnumber> + <date>October 2009</date> + <revdescription> + <para role="author">Paul Cutler + <email>[email protected]</email> + </para> + <para role="publisher">MATE Documentation Project</para> + </revdescription> + </revision> + <revision> + <revnumber>&app; Manual V2.4</revnumber> + <date>October 2005</date> + <revdescription> + <para role="author">Vincent Noel + <email>[email protected]</email> + </para> + <para role="publisher">MATE Documentation Project</para> + </revdescription> + </revision> + <revision> + <revnumber>System Log Viewer Manual V2.3</revnumber> + <date>October 2002</date> + <revdescription> + <para role="author">Sun MATE Documentation Team + <email>[email protected]</email> + </para> + <para role="publisher">MATE Documentation Project</para> + </revdescription> + </revision> + <revision> + <revnumber>System Log Viewer Manual V2.2</revnumber> + <date>August 2002</date> + <revdescription> + <para role="author">Sun MATE Documentation Team + <email>[email protected]</email> + </para> + <para role="publisher">MATE Documentation Project</para> + </revdescription> + </revision> + <revision> + <revnumber>System Log Viewer Manual V2.1</revnumber> + <date>July 2002</date> + <revdescription> + <para role="author">Sun MATE Documentation Team + <email>[email protected]</email> + </para> + <para role="publisher">MATE Documentation Project</para> + </revdescription> + </revision> + <revision> + <revnumber>System Log Viewer Manual V2.0</revnumber> + <date>May 2002</date> + <revdescription> + <para role="author">Sun MATE Documentation Team + <email>[email protected]</email> + </para> + <para role="publisher">MATE Documentation Project</para> + </revdescription> + </revision> + <revision> + <revnumber>Logview Manual</revnumber> + <date>2000</date> + <revdescription> + <para role="author">Judith Samson + <email>[email protected]</email> + </para> + <para role="publisher">MATE 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="help:mate-feedback" + type="help">MATE 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> + <application>&app;</application> is a graphical, menu-driven + viewer that you can use to view and monitor your system + logs. <application>&app;</application> comes with a few functions that + can help you manage your logs, including a log monitor and log statistics + display. + </para> + + <para> + <application>&app;</application> is useful if you are new to system + administration because it provides an easier, more user-friendly + display of your logs than a + text display of the log file. It is also useful for more + experienced administrators, as it contains a monitor to enable you + to continuously monitor crucial logs. + </para> + + <warning><para><application>&app;</application> is useful only to those + who have access to the system log files, which generally requires root + access.</para></warning> + + </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>Log File Viewer</guimenuitem></menuchoice>.</para> + </listitem> + </varlistentry> + <varlistentry> + <term>Command line</term> + <listitem> + <para>Type <command>mate-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>The first time you start <application>&app;</application>, the application + displays several log files by default (such as + <filename>/var/log/messages</filename>). + Opened logs are listed on the left side of the + application window. The log selected in this list is displayed in the + main area of the application window. + </para> + + <para>By default, <application>&app;</application> + monitors every opened log, and any change appears automatically in the + main window. See <xref linkend="syslog-monitor"/> for more information.</para> + + </sect1> + +<!-- ================ Usage ================================ --> + + <sect1 id="syslog-usage"> + <title>Usage</title> + + <sect2 id="syslog-open"> + <title>To View a Log</title> + <para>To view a log, choose <menuchoice><guimenu>File</guimenu><guimenuitem>Open</guimenuitem></menuchoice>. + In the <guilabel>Open Log</guilabel> dialog, select the + log that you want to open, then click + <guibutton>Open</guibutton>. Use the scrollbars to scroll through the + log.</para> + + <para>You can open as many logs as you + want. <application>&app;</application> displays one log at a time in + the <guilabel>System Log Viewer</guilabel> window. Opened logs are listed on the left side of the + application window. The log selected in this list is displayed in the + main area of the application window. To display another log + already opened in <application>&app;</application>, select it in the + log list.</para> + + <para>Note that <application>&app;</application> also lets you open + zipped logs (whole filenames end in ".gz").</para> + </sect2> + + <sect2 id="syslog-selection"> + <title>To Copy Log Lines to the Clipboard</title> + <para>To copy one or more log lines to the clipboard, just select the lines in + the main area and choose the + <menuchoice><guimenu>Edit</guimenu><guimenuitem>Copy</guimenuitem></menuchoice> + menu option. + If you want to copy the entire log to the clipboard, select it entirely + using the <menuchoice><guimenu>Edit</guimenu><guimenuitem>Select + All</guimenuitem></menuchoice> menu option, then choose + <menuchoice><guimenu>Edit</guimenu><guimenuitem>Copy</guimenuitem></menuchoice>. + </para> + </sect2> + + <sect2 id="syslog-hide-sidebar"> + <title>To Hide the Sidebar</title> + <para>To hide the left sidebar, which contains the log list and calendar, + just select the + <menuchoice><guimenu>View</guimenu><guimenuitem>Side pane</guimenuitem></menuchoice> + menu option.</para> + </sect2> + + <sect2 id="syslog-monitor"> + <title>To Monitor Logs</title> + <para>You can use <application>&app;</application> to monitor + logs. By default, all logs opened in <application>&app;</application> + are monitored for changes. If new lines are added to a log monitored + by <application>&app;</application>, the log name will appear in bold in + the log list. If the log is currently displayed in the main area, the + new lines will appear automatically at the end of the log and, after five + seconds, the log name will turn back to normal in the list.</para> + + </sect2> + + <sect2 id="syslog-stats"> + <title>To View Log Information</title> + <para>Log information are generally displayed in the status bar, + including :</para> + <itemizedlist> + <listitem><para>Number of lines in the log.</para> + </listitem> + <listitem><para>Size of the log in bytes.</para> + </listitem> + <listitem><para>Date the log was last modified.</para> + </listitem> + </itemizedlist> + <para>The status bar can be displayed or hidden using the + <menuchoice><guimenu>View</guimenu><guimenuitem>Statusbar</guimenuitem></menuchoice> + option.</para> + </sect2> + + <sect2 id="syslog-close"> + <title>To Close a Log</title> + <para>To close a log, 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> |