[gnome-system-monitor/wip/mallard-help: 29/68] Completed process-columns, added p-i-f description

[Ekaterina Gerasimova <egerasimov src gnome org>]

commit cfd34f02dbeea14a87807a2d9dad1db5e2c45a2b
Author: Michael Hill <mdhill src gnome org>
Date:   Sat Oct 29 12:18:56 2011 -0400

    Completed process-columns, added p-i-f description

 help/C/memory-map-use.page        |  122 +++++++++++++++++++++++++++++++++++++
 help/C/process-columns.page       |  112 ++++++++++++++++++++++++++++++++--
 help/C/process-identify-file.page |    2 +-
 3 files changed, 230 insertions(+), 6 deletions(-)
---
diff --git a/help/C/memory-map-use.page b/help/C/memory-map-use.page
index 234bd0d..4c2175d 100644
--- a/help/C/memory-map-use.page
+++ b/help/C/memory-map-use.page
@@ -29,4 +29,126 @@
     <item><p>Click <gui>Memory Maps</gui> in the <gui>View</gui> menu.</p></item>
   </steps>
 
+  <p>When a program is launched, the system assigns it a unique process ID (PID)
+ and its <em>instructions</em> and <em>data</em> are loaded into memory in
+ <em>pages</em>. The page table of each process maps the correspondence between
+ its pages in virtual memory and their location in physical memory. The
+ <gui>memory map</gui> displays the total virtual memory use of the process, and
+ can be used to determine the memory cost of running a single or multiple
+ instances of the program, to ensure the use of the correct shared libraries, to
+ see the results of adjusting various performance tuning parameters the program
+ may have, or to diagnose issues such as memory leaks.</p>
+
+  <p>If multiple copies of a program are running, the instructions (or <em>text</em>)
+ of the program only need to be loaded once into physical memory. Each time a
+ new instance of the program is launched (as a unique process with its own virtual
+ memory pages), its page table maps the location of the text in virtual memory to
+ those instructions in the original real memory location. In addition, any dynamic
+ shared libraries used by the process appear as distinct in virtual memory, but
+ are shared references to a single copy of the library's text segment in real
+ memory. When accounting for the total memory use of a process, it is important
+ to note that the cost of shared libraries loaded into memory can be spread
+ across all the processes currently using them.</p>
+
+  <p>When the system needs more pages of memory than are available, some of the
+ existing pages will be <em>paged out</em> or written to the <link xref="mem-swap">swap space</link>.
+ Text pages are flagged read-execute in memory and don't need to be written to
+ swap since they can be re-loaded from their original location on disk. Data
+ pages have read-write permissions, and if modified when in memory, they are
+ labeled <em>dirty</em>, and when designated for swapping, must be paged out.
+ When a page in swap space is required by a running process, it needs to be
+ swapped back in before use, perhaps causing another page to be paged out.</p>
+
+  <p>Reading the memory map:</p>
+  <list>
+
+    <item>
+      <p>Addresses are diplayed in hexadecimal (base 16).</p>
+    </item>
+    <item>
+      <p>Sizes are displayed in <link xref="units">IEC binary prefixes</link>.</p>
+    </item>
+    <item>
+      <p>At runtime the process can allocate more memory dynamically into an area
+ called the <em>heap</em>, and store arguments and variables into another area
+ called the <em>stack</em>.</p>
+    </item>
+    <item>
+      <p>The program itself and each of the shared libraries have three entries
+ each, one for the read-execute text segment, one for the read-write data segment
+ and one for a read-only data segment. Both data segments need to be paged out
+ at swap time.</p>
+    </item>
+  </list>
+
+ <terms>
+ <title>Properties</title>
+  <item>
+    <title><gui>Filename</gui></title>
+    <p>The location of a shared library that is currently used by the process.
+ If this field is blank, the memory information in this row describes memory
+ that is owned by the process whose name is displayed above the memory-map
+ table.</p>
+  </item>
+  <item>
+    <title><gui>VM Start</gui></title>
+    <p>The address at which the memory segment begins. VM Start, VM End and VM
+ Offset together specify the location on disk to which the shared library is
+ mapped.</p>
+  </item>
+  <item>
+    <title><gui>VM End</gui></title>
+    <p>The address at which the memory segment ends.</p>
+  </item>
+    <item>
+      <title><gui>VM Offset</gui></title>
+    <p>The location of the address within the memory segment, measured from VM
+ Start.</p>
+    </item>
+  <item>
+    <title><gui>VM Size</gui></title>
+    <p>The size of the memory segment.</p>
+  </item>
+  <item>
+    <title><gui>Flags</gui></title>
+    <p>The following flags describe the different types of memory-segment access
+ that the process can have:</p>
+    <terms>
+    <item>
+      <title><gui>p</gui></title>
+    <p>The memory segment is private to the process, and is not accessible to
+ other processes.</p>
+    </item>
+    <item>
+      <title><gui>r</gui></title>
+    <p>The process has permission to read from the memory segment.</p>
+    </item>
+    <item>
+      <title><gui>s</gui></title>
+    <p>The memory segment is shared with other processes.</p>
+    </item>
+    <item>
+      <title><gui>w</gui></title>
+    <p>The process has permission to write into the memory segment.</p>
+    </item>
+    <item>
+      <title><gui>x</gui></title>
+    <p>The process has permission to execute instructions that are contained
+ within the memory segment.</p>
+    </item>
+    <item>
+      <title><gui>Device</gui></title>
+    <p>The major and minor numbers of the device on which the shared library
+ filename is located. Together these specify a partition on the system.</p>
+    </item>
+    <item>
+      <title><gui>Inode</gui></title>
+    <p>The inode on the device from which the shared library location is loaded
+ into memory. An inode is the structure the filesystem uses to store a file, and
+ the number assigned to it is unique.</p>
+    </item>
+  </terms>
+  </item>
+</terms>
+
 </page>
diff --git a/help/C/process-columns.page b/help/C/process-columns.page
index 4fc59fd..464b23e 100644
--- a/help/C/process-columns.page
+++ b/help/C/process-columns.page
@@ -18,15 +18,117 @@
 
   <comment>
     <cite date="2011-06-18" href="mailto:philbull gmail com">Phil Bull</cite>
-    <p>Briefly explain how to add other columns to the list in the Processes tab and explain what each 
column means!</p>
+    <p>Briefly explain how to add other columns to the list in the Processes tab
+    and explain what each column means!</p>
   </comment>
 
-  <p>Short introductory text...</p>
+  <p>To display different or additional information in the process list:</p>
 
   <steps>
-    <item><p>First step...</p></item>
-    <item><p>Second step...</p></item>
-    <item><p>Third step...</p></item>
+    <item><p>Click <guiseq><gui>Edit</gui><gui>Preferences</gui></guiseq>.</p></item>
+    <item><p>Click the <gui>Processes</gui> tab.</p></item>
+    <item><p>Select the desired headings in the <gui>Information Fields</gui> list.</p></item>
   </steps>
 
+  <p>For each process listed in the <gui>Processes</gui> tab, <app>System Monitor</app>
+ provides information in a number of categories. </p>
+
+<table shade="rows">
+  <tr>
+       <td><p>Process Name</p></td>
+       <td><p>The name of the task. This column may also contain an icon to
+        indicate the application that is associated with the process.</p></td>
+
+  </tr>
+
+  <tr>
+       <td><p>User</p></td>
+       <td><p>The user name of the task's owner.</p></td>
+  </tr>
+
+  <tr>
+       <td><p>Status</p></td>
+       <td><p>The status of the task. </p>
+       </td>
+  </tr>
+
+  <tr>
+       <td><p>Virtual Memory</p></td>
+       <td><p>The total amount of virtual memory used by the task.</p>
+       </td>
+   </tr>
+
+  <tr>
+       <td><p>Resident Memory</p></td>
+       <td><p>The non-swapped physical memory used by the task.</p></td>
+   </tr>
+
+  <tr>
+       <td><p>Writable Memory</p></td>
+       <td><p>The amount of memory that can be written by the process.</p></td>
+   </tr>
+
+  <tr>
+       <td><p>Shared Memory</p></td>
+       <td><p>The amount of shared memory used by the task (potentially shared
+        with other processes).</p></td>
+   </tr>
+
+  <tr>
+       <td><p>X Server Memory</p></td>
+       <td><p>The amount of X server memory that is used by the process.</p></td>
+   </tr>
+
+  <tr>
+       <td><p>% CPU</p></td>
+       <td><p>The task's share of the elapsed CPU time since the last screen
+        update, expressed as a percentage of total CPU time. In a true SMP
+        environment, if 'Irix mode' is Off, top will operate in 'Solaris mode'
+        where a task's cpu usage will be divided by the total number of CPUs.
+        You toggle 'Irix/Solaris' modes with the 'I' interactive command.</p></td>
+   </tr>
+
+  <tr>
+       <td><p>CPU Time</p></td>
+       <td><p>Total CPU time the task has used since it started.</p></td>
+   </tr>
+
+  <tr>
+       <td><p>Started</p></td>
+       <td><p>When the process began running.</p></td>
+   </tr>
+
+  <tr>
+       <td><p>Nice</p></td>
+       <td><p>The nice value of the task.</p></td>
+   </tr>
+
+  <tr>
+       <td><p>ID</p></td>
+       <td><p>The task's unique process ID.</p></td>
+   </tr>
+
+  <tr>
+       <td><p>Security Context</p></td>
+       <td><p>The security context in which the process is running.</p></td>
+   </tr>
+
+  <tr>
+       <td><p>Command Line</p></td>
+       <td><p>Command line or Program name used to start a task.</p></td>
+   </tr>
+
+  <tr>
+       <td><p>Memory</p></td>
+       <td><p>A tasks currently-used share of available physical memory.</p></td>
+   </tr>
+
+  <tr>
+       <td><p>Waiting Channel</p></td>
+       <td><p>Location in the kernel where the process waits for data or
+        processing time.</p></td>
+   </tr>
+
+</table>
+
 </page>
diff --git a/help/C/process-identify-file.page b/help/C/process-identify-file.page
index 871cd8a..d2df25c 100644
--- a/help/C/process-identify-file.page
+++ b/help/C/process-identify-file.page
@@ -11,7 +11,7 @@
       <years>2011</years>
     </credit>
 
-    <desc>XXXX</desc>
+    <desc>Search for a file that's open to display which process is using it.</desc>
   </info>
 
   <title>Find which program is using a specific file</title>