GNOME.org
 

Re: System Monitor stub topics


Realized I should have sent these to the list before, here are the patches for a couple pages I've written for system-monitor docs. Criticism and corrections, if you would be so kind? 
From 5d96e7683d2c10de166ea66da4ed3fed9cab6b5a Mon Sep 17 00:00:00 2001
From: Kelly Sinnott <ksinnott5ht gmail com>
Date: Tue, 12 Jul 2011 07:50:53 -0700
Subject: [PATCH] Wrote commandline.page, linked it to index
 	modified:   commandline.page
 	modified:   index.page

---
 commandline.page |   37 +++++++++++++++++++++++++++----------
 index.page       |    4 +++-
 2 files changed, 30 insertions(+), 11 deletions(-)

diff --git a/commandline.page b/commandline.page
index 0b7a32a..8eaf1ec 100644
--- a/commandline.page
+++ b/commandline.page
@@ -2,12 +2,12 @@
       type="topic" style="task"
       id="commandline">
   <info>
-    <revision version="0.1" date="2011-06-18" status="stub"/>
-    <!--<link type="guide" xref="..." />-->
+    <revision version="0.1" date="2011-07-12" status="review"/>
+    <link type="guide" xref="index" />
 
     <credit type="author copyright">
-      <name>Phil Bull</name>
-      <email>philbull gmail com</email>
+      <name>Kelly Sinnott</name>
+      <email>ksinnott5ht gmail com</email>
       <years>2011</years>
     </credit>
 
@@ -21,12 +21,29 @@
     <p>Briefly list a few useful command line tools which can provide some of the same information as System Monitor. Don't go into too much detail.</p>
   </comment>
 
-  <p>Short introductory text...</p>
+  <p>If you would like to access the information provided by the System Monitor from the terminal, there are several handy command-line tools available.</p>
 
-  <steps>
-    <item><p>First step...</p></item>
-    <item><p>Second step...</p></item>
-    <item><p>Third step...</p></item>
-  </steps>
+<table shade="rows">
+  <tr>
+	<td><p>System information</p></td>
+	<td><p>The command <cmd>uname -a</cmd> will give you information about your system including your machine's hostname, operating system, and processor.</p></td>
 
+  </tr>
+  <tr>
+	<td><p>Running processes and other live system data</p></td>
+	<td><p>The tool <cmd>top</cmd> displays a continually updating view of current processes, their CPU and memory usage, and other details.</p></td>
+	</tr>
+  <tr>
+	<td><p>Disk space</p></td>
+	<td><p>To review available disk space, mount location, and file type of mounted file systems, issue the command <cmd>df -h</cmd>.</p>
+	</td>
+  </tr>
+
+  <tr>
+	<td><p>Network information</p></td>
+	<td><p>The command <cmd>iftop</cmd> works like <cmd>top</cmd>, displaying continually updating network statistics. This command must be run as an administrator.
+	Note: iftop may not be included in your distribution. It should be available via your package manager.</p>
+	</td>
+   </tr>
+</table>
 </page>
diff --git a/index.page b/index.page
index 15d2474..3119f33 100644
--- a/index.page
+++ b/index.page
@@ -2,7 +2,7 @@
       type="guide"
       id="index">
   <info>
-    <revision version="0.1" date="2011-06-18" status="stub"/>
+    <revision version="0.1" date="2011-07-12" status="stub"/>
 
     <credit type="author copyright">
       <name>Phil Bull</name>
@@ -11,10 +11,12 @@
     </credit>
 
     <desc>Use the System Monitor to view information on how well your computer is running and whether there are any problems.</desc>
+    <link type="topic" id="commandline"/>
   </info>
 
 <title>System Monitor</title>
 
+
 <section id="noname">
  <title>Some Section</title>
  
-- 
1.6.1


From ba158bd0e9860fb40b57b2e052d253461da1e3eb Mon Sep 17 00:00:00 2001
From: Kelly Sinnott <ksinnott5ht gmail com>
Date: Tue, 12 Jul 2011 12:46:59 -0700
Subject: [PATCH] wrote cpu-check, updated multicore, index
 	modified:   cpu-check.page
 	modified:   cpu-multicore.page
 	modified:   index.page

---
 cpu-check.page             |   17 +++++++----------
 cpu-multicore.page         |    4 ++++
 index.page                 |    8 ++------
 process-priority-what.page |    2 ++
 4 files changed, 15 insertions(+), 16 deletions(-)

diff --git a/cpu-check.page b/cpu-check.page
index 41fc025..bd5f4dd 100644
--- a/cpu-check.page
+++ b/cpu-check.page
@@ -2,12 +2,12 @@
       type="topic" style="task"
       id="cpu-check">
   <info>
-    <revision version="0.1" date="2011-06-18" status="stub"/>
-    <!--<link type="guide" xref="..." />-->
+    <revision version="0.1" date="2011-07-12" status="review"/>
+    <link type="guide" xref="index"/>
 
     <credit type="author copyright">
-      <name>Phil Bull</name>
-      <email>philbull gmail com</email>
+      <name>Kelly Sinnott</name>
+      <email>ksinnott5ht gmail com</email>
       <years>2011</years>
     </credit>
 
@@ -22,12 +22,9 @@
     <p>Be careful here, as there are a number of technical terms (process, CPU/processor, multi-core, system resources...) that may be used here, but which will need to be explained for less advanced users.</p>
   </comment>
 
-  <p>Short introductory text...</p>
+  <p>The role of the <em>CPU</em>, or central processing unit, is to execute the series of instructions called a <em>computer program</em>. While a program is being executed, it is known as a <em>process</em>. At any given time, your computer will likely be running many processes simultaneously. There are individual processes to manage your internet connection, audio settings, passwords, file manager, and so on. Some applications are composed of multiple processes known as <em>threads</em>. The CPU must divide its processing "attention" between the running processes. The amount of time required by each process is expressed as a percentage by the System Monitor.</p>
+ <note><p>Some processors are actually composed of multiple independent processors in one component. These are referred to as <em>multi-core</em> processors. Multi-core CPUs allow an increase in overall performance otherwise limited by physical constraints on a single core. However, a single process or thread is limited to a single core. Because of this, a single demanding, non-threaded process can dominate a core, failing to take advantage of the full CPU.</p></note>
 
-  <steps>
-    <item><p>First step...</p></item>
-    <item><p>Second step...</p></item>
-    <item><p>Third step...</p></item>
-  </steps>
+<p>To view a live graph of CPU usage over time, click the <gui>Resources</gui> tab. The graph labeled "CPU History" will show a line for each core. Multiple cores will be color-coded; these colors can be changed by clicking the corresponding colored box for each core under the graph.</p>
 
 </page>
diff --git a/cpu-multicore.page b/cpu-multicore.page
index 8210415..c88fe4f 100644
--- a/cpu-multicore.page
+++ b/cpu-multicore.page
@@ -19,6 +19,10 @@
   <comment>
     <cite date="2011-06-18" href="mailto:philbull gmail com">Phil Bull</cite>
     <p>Explain why more than one CPU might be shown in the Resources tab. (Multi-core system.) Explain the implications of having multiple cores - the computer can do more simultaneously, but individual processes won't generally run faster. Don't go into too much technical detail.</p>
+</comment>
+<comment>
+    <cite date="2011-07-12" href="mailto:ksinnott5ht gmail com">Kelly Sinnott</cite>
+	<p>I've included a pretty concise paragraph on this in cpu-check.page; I'm not sure if it should be moved here, copied here, or what...probably what.</p>
   </comment>
 
   <p>Short introductory text...</p>
diff --git a/index.page b/index.page
index 3119f33..3d38538 100644
--- a/index.page
+++ b/index.page
@@ -11,15 +11,11 @@
     </credit>
 
     <desc>Use the System Monitor to view information on how well your computer is running and whether there are any problems.</desc>
-    <link type="topic" id="commandline"/>
+    
+
   </info>
 
 <title>System Monitor</title>
 
 
-<section id="noname">
- <title>Some Section</title>
- 
-</section>
-
 </page>
diff --git a/process-priority-what.page b/process-priority-what.page
index 1a9782d..b83a48e 100644
--- a/process-priority-what.page
+++ b/process-priority-what.page
@@ -21,6 +21,8 @@
     <p>Explain, in brief and simple terms, what nice levels are, why they are
  used, and how process scheduling works (Wikipedia article on nice is good for
  this.)</p>
+</comment>
+<comment>
     <cite date="2011-06-23" href="mailto:mdhillca gmail com">Mike Hill</cite>
     <p>Needs to be simpler.</p>
   </comment>
-- 
1.6.1


From c7e2627ee2d06532dbb2584cc32db3a137745c4c Mon Sep 17 00:00:00 2001
From: Kelly Sinnott <ksinnott5ht gmail com>
Date: Thu, 14 Jul 2011 19:19:46 -0700
Subject: [PATCH] wrote cpu-mem-normal
 	modified:   cpu-mem-normal.page

---
 cpu-mem-normal.page |   22 ++++++++--------------
 1 files changed, 8 insertions(+), 14 deletions(-)

diff --git a/cpu-mem-normal.page b/cpu-mem-normal.page
index 8a31168..8fac931 100644
--- a/cpu-mem-normal.page
+++ b/cpu-mem-normal.page
@@ -2,12 +2,12 @@
       type="topic" style="task"
       id="cpu-mem-normal">
   <info>
-    <revision version="0.1" date="2011-06-18" status="stub"/>
-    <!--<link type="guide" xref="..." />-->
+    <revision version="0.1" date="2011-07-14" status="review"/>
+    <link type="guide" xref="index" />
 
     <credit type="author copyright">
-      <name>Phil Bull</name>
-      <email>philbull gmail com</email>
+      <name>Kelly Sinnott</name>
+      <email>ksinnott5ht gmail com</email>
       <years>2011</years>
     </credit>
 
@@ -16,17 +16,11 @@
 
   <title>Is it normal for my computer to be using this much CPU or memory?</title>
 
-  <comment>
-    <cite date="2011-06-18" href="mailto:philbull gmail com">Phil Bull</cite>
-    <p>Explain when it is normaly for a computer to use lots of CPU and/or memory, and when it isn't. If a process has hung or is using too many resources, you can kill it.</p>
-  </comment>
+    <p> There are certain tasks which require more processing time or memory.  This may include playing video (in a media player or in your web browser), playing a graphics-intensive game, burning a CD or DVD, or other complex tasks. Another possibility is that there are simply too many processes running; a cumulative effect may be just as taxing as a single culprit. For example, you may have several browser windows open, each full of tabs with loaded web pages. Keeping these tabs ready to spring open at a moment's notice requires extra memory. Yet another issue might be that a process has frozen or continues to run after an application has closed.</p> 
 
-  <p>Short introductory text...</p>
+<p>You can try to identify these resource-heavy processes in the <gui>Processes</gui> tab of <app>System Monitor</app>. Using the buttons across the top of the process list, you can sort by <gui>% CPU</gui> or <gui>Memory</gui> to identify the worst offenders. To toggle between ascending and descending sorting, click the button again. If you find a process which seems to be using a lot of CPU or memory, you can right click on it to bring up a menu which allows you to end it.</p>
+
+<note><p>The right-click menu for a process contains <gui>Stop Process</gui>, <gui>End Process</gui>, and <gui>Kill Process</gui>. <gui>Stop Process</gui> means to pause the process temporarily. It can be resumed with <gui>Continue Process</gui>. <gui>End Process</gui> tries to end the process as the programmer intended, using the built in "quit" or "exit" function. <gui>Kill Process</gui> forces the process to close immediately, and should be used only if <gui>End Process</gui> does not work.</p></note>
 
-  <steps>
-    <item><p>First step...</p></item>
-    <item><p>Second step...</p></item>
-    <item><p>Third step...</p></item>
-  </steps>
 
 </page>
-- 
1.6.1
[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]