Initial xfce4-taskmanager documentationxfce4-taskmanager-master

3 files changed, 507 insertions, 0 deletions

diff --git a/Makefile b/Makefile
new file mode 100644
index 0000000..a3cf55f
--- /dev/null
+++ b/Makefile
@@ -0,0 +1,4 @@
+all:
+	#gnome-doc-tool css
+	gnome-doc-tool html -c index.css index.page
+
diff --git a/index.css b/index.css
new file mode 100644
index 0000000..09bed2e
--- /dev/null
+++ b/index.css
@@ -0,0 +1,361 @@
+
+html { height: 100%; }
+body {
+  font-family: "DejaVuSerif", "Times New Roman", Times, serif;
+  color: black;
+  background-color: #f9f9f6;
+  margin: 0px;
+  min-height: 100%;
+  direction: ltr;
+}
+
+ul, ol, dl, dd { margin: 0; }
+div, pre, p, li, dt { margin: 1em 0 0 0; padding: 0; }
+.first-child { margin-top: 0; }
+li.condensed { margin-top: 0.2em; }
+a {
+  text-decoration: none;
+  color: #1f609f;
+}
+a:visited {
+  color: #9f1f6f;
+}
+a:hover { text-decoration: underline; }
+
+div.headbar {
+  margin: 0;
+  max-width: 48em;
+}
+div.footbar {
+  margin: 0 auto;
+  padding: 0 0 2em 0;
+  max-width: 48em;
+}
+div.body {
+  margin: 2em auto;
+  padding: 1.6em 1.6em;
+  width: 80%;
+  max-width: 55em;
+  min-height: 20em;
+  -moz-border-radius: 6px;
+  border: solid 1px #e0e0df;
+  background-color: #ffffff;
+}
+div.contents {
+  text-align: justify;
+  line-height: 1.5em;
+}
+div.navbar {
+  margin: 0;
+  float: right;
+}
+a.navbar-prev::before {
+  content: '◀  ';
+  color: #3f3f3f;
+}
+a.navbar-next::after {
+  content: '  ▶';
+  color: #3f3f3f;
+}
+div.copyrights {
+  text-align: center;
+  color: #3f3f3f;
+}
+div.section { margin-top: 2.4em; clear: both; }
+div.section div.section {
+  margin-top: 1.72em;
+  margin-left: 1.72em;
+}
+div.section div.section div.section { margin-top: 1.44em; }
+div.header {
+  margin: 0 0 1em 0;
+  color: #3f3f3f;
+  border-bottom: solid 1px #e0e0df;
+}
+h1 {
+  font-size: 1.44em;
+  margin: 0;
+  padding: 0.34em 0;
+}
+h2, h3, h4, h5, h6, h7 {
+  font-size: 1.2em;
+  margin: 0;
+  padding: 0.2em 0;
+}
+table { border-collapse: collapse; }
+
+div.autolinks ul { margin: 0; padding: 0; }
+div.autolinks div.title { margin: 1em 0 0 1em; }
+div.autolinks div.title span {
+  border-bottom: solid 1px #e0e0df;
+}
+li.autolink { margin: 0.5em 0 0 0; padding: 0 0 0 1em; list-style-type: none; }
+
+div.linktrails {
+  margin: 0;
+}
+div.linktrail {
+  font-size: 0.83em;
+  margin: 0 1px 0.2em 1px;
+  padding-left: 1.2em;
+  color: #3f3f3f;
+}
+
+table.twocolumn { width: 100%; }
+td.twocolumnleft { width: 48%; vertical-align: top; padding: 0; margin: 0; }
+td.twocolumnright {
+  width: 52%; vertical-align: top;
+  margin: 0; padding: 0;
+  padding-left: 1em;
+}
+
+div.linkdiv div.title {
+  font-size: 1em;
+  color: inherit;
+}
+div.linkdiv {
+  margin: 0;
+  padding: 0.5em;
+  -moz-border-radius: 6px;
+  border: solid 1px #ffffff;
+}
+div.linkdiv:hover {
+  border-color: #c0c9ff;
+  background-color: #f0f9ff;
+}
+div.linkdivsep {
+  margin: 0.5em;
+  list-style-type: none;
+  max-width: 24em;
+  border-bottom: solid 1px #e0e0df;
+}
+
+div.title {
+  margin: 0 0 0.7em 0;
+  font-weight: bold;
+  color: #3f3f3f;
+}
+div.desc { margin: 0 0 0.2em 0; }
+div.desc-listing, div.desc-synopsis { font-style: italic; }
+div.desc-figure { margin: 0.2em 0 0 0; }
+pre.code {
+  /* FIXME: In RTL locales, we really want to align this left, but the watermark
+   * we have is designed to fit in the top right corner.  Either we need a new
+   * watermark, or we need a separate RTL version.
+   */
+  background: url('watermark-code.png') no-repeat top right;
+  border: solid 2px #e0e0df;
+  padding: 0.5em 1em 0.5em 1em;
+}
+div.example {
+  border-left: solid 4px #e0e0df;
+  padding-left: 1em;
+}
+div.figure {
+  margin-left: 1.72em;
+  padding: 4px;
+  color: #3f3f3f;
+  border: solid 1px #e0e0df;
+  background-color: #f9f9f6;
+}
+div.figure-contents {
+  margin: 0;
+  padding: 0.5em 1em 0.5em 1em;
+  text-align: center;
+  color: #000000;
+  border: solid 1px #e0e0df;
+  background-color: #ffffff;
+}
+div.listing-contents { margin: 0; padding: 0; }
+div.note {
+  padding: 0.5em 6px 0.5em 6px;
+  border-top: solid 1px #ffc0c0;
+  border-bottom: solid 1px #ffc0c0;
+  background-color: #fffff0;
+}
+div.note-inner {
+  margin: 0;
+  padding-left: 60px;
+  background-position: left top;
+  background-repeat: no-repeat;
+  min-height: 48px;
+  background-image: url("admon-note.png");
+}
+div.note-advanced div.note-inner {  }
+div.note-bug div.note-inner { background-image: url("admon-bug.png"); }
+div.note-important div.note-inner { background-image: url("admon-important.png"); }
+div.note-tip div.note-inner { background-image: url("admon-tip.png"); }
+div.note-warning div.note-inner { background-image: url("admon-warning.png"); }
+div.note-contents { margin: 0; padding: 0; }
+div.quote-inner {
+  margin: 0;
+  background-image: url('watermark-blockquote-201C.png');
+  background-repeat: no-repeat;
+  background-position: top left;
+  padding: 0.5em;
+  padding-left: 4em;
+}
+div.title-quote {
+  margin-left: 4em;
+}
+blockquote { margin: 0; padding: 0; }
+div.cite-comment {
+  margin-top: 0.5em;
+  color: #3f3f3f;
+}
+div.cite-quote {
+  margin-top: 0.5em;
+  color: #3f3f3f;
+}
+div.cite-quote::before {
+  
+  content: '― ';
+}
+pre.screen {
+  padding: 0.5em 1em 0.5em 1em;
+  background-color: #f9f9f6;
+  border: solid 2px #e0e0df;
+}
+div.synopsis-contents {
+  margin: 0;
+  padding: 0.5em 1em 0.5em 1em;
+  border-top: solid 2px;
+  border-bottom: solid 2px;
+  border-color: #c0c9ff;
+  background-color: #f9f9f6;
+}
+div.synopsis pre.code {
+  background: none;
+  border: none;
+  padding: 0;
+}
+
+div.list-contents { margin: 0; padding: 0; }
+div.title-list { margin-bottom: 0.5em; }
+ol.list, ul.list { margin: 0; padding: 0; }
+li.item-list { margin-left: 1.44em; }
+
+div.steps-contents {
+  margin: 0;
+  padding: 0.5em 1em 0.5em 1em;
+  border-top: solid 2px;
+  border-bottom: solid 2px;
+  border-color: #c0c9ff;
+  background-color: #fffff0;
+}
+div.steps-contents div.steps-contents {
+  padding: 0;
+  border: none;
+  background-color: none;
+}
+ol.steps, ul.steps { margin: 0; padding: 0; }
+li.item-steps { margin-left: 1.44em; }
+
+div.terms-contents { margin: 0; }
+dt.item-next { margin-top: 0; }
+dt.item-terms {
+  font-weight: bold;
+}
+dd.item-terms {
+  font-size: 0.95em;
+  margin-top: 0.2em;
+  margin-left: 1.44em;
+}
+
+ul.tree {
+  margin: 0; padding: 0;
+  list-style-type: none;
+}
+li.item-tree { margin: 0; padding: 0; }
+div.item-tree { margin: 0; padding: 0; }
+ul.tree ul.tree { margin-left: 1.44em; }
+div.tree-lines ul.tree { margin-left: 0; }
+
+table.table {
+  border-collapse: collapse;
+  border-color: #555753;
+  border-width: 1px;
+}
+table.table td {
+  padding: 0.1em 0.5em 0.1em 0.5em;
+  border-color: #888a85;
+  border-width: 1px;
+  vertical-align: top;
+}
+
+span.app { font-style: italic; }
+span.cmd {
+  font-family: monospace;
+  background-color: #f9f9f6;
+  padding: 0 0.2em 0 0.2em;
+}
+span.code { font-family: monospace; }
+span.em { font-style: italic; }
+span.email { color: red; }
+span.file { font-family: monospace; }
+span.gui, span.guiseq { color: #3f3f3f; }
+span.input { font-family: monospace; }
+span.hi {
+  background-color: #fffff0;
+}
+span.key {
+  color: #3f3f3f;
+  border: solid 1px #e0e0df;
+  padding: 0 0.2em 0 0.2em;
+}
+span.keyseq {
+  color: #3f3f3f;
+}
+span.output { font-family: monospace; }
+pre.screen span.output {
+  color: #3f3f3f;
+}
+pre.screen span.output-error {
+
+  color: #ff0000;
+}
+pre.screen span.output-prompt { font-weight: bold; }
+span.sys { font-family: monospace; }
+span.var { font-style: italic; }
+
+div.version {
+  position: absolute;
+  right: 12px;
+  opacity: 0.2;
+  margin-top: -1em;
+  padding: 0.5em 1em 0.5em 1em;
+  max-width: 24em;
+  -moz-border-radius: 6px;
+  border: solid 1px #e0e0df;
+  background-color: #fffff0;
+}
+div.version:hover { opacity: 0.8; }
+div.version p.version { margin-top: 0.2em; }
+div.linkdiv div.title span.status {
+  font-size: 0.83em;
+  font-weight: normal;
+  padding-left: 0.2em;
+  padding-right: 0.2em;
+  color: #3f3f3f;
+  border: solid 1px #ffc0c0;
+}
+div.linkdiv div.title span.status-stub { background-color: #fff0f0; }
+div.linkdiv div.title span.status-draft { background-color: #fff0f0; }
+div.linkdiv div.title span.status-incomplete { background-color: #fff0f0; }
+div.linkdiv div.title span.status-review { background-color: #fffff0; }
+div.linkdiv div.desc {
+  margin-top: 0.2em;
+  color: #3f3f3f;
+}
+div.comment {
+  padding: 0.5em;
+  border: solid 2px #ffc0c0;
+  background-color: #fff0f0;
+}
+div.comment div.comment {
+  margin: 1em 1em 0 1em;
+}
+div.comment div.cite {
+  margin: 0 0 0.5em 0;
+  font-style: italic;
+}
diff --git a/index.page b/index.page
new file mode 100644
index 0000000..ce0ebac
--- /dev/null
+++ b/index.page
@@ -0,0 +1,142 @@
+<?xml version="1.0"?>
+<page xmlns="http://projectmallard.org/1.0/"
+      xmlns:e="http://projectmallard.org/experimental/"
+      type="topic"
+      id="xfce4-taskmanager">
+
+  <info>
+    <revision docversion="0.1" pkgversion="1.1.0" date="2010-10-10" status="review" />
+    <license href="http://www.gnu.org/licenses/fdl-1.3-standalone.html">
+      Permission is granted to copy, distribute and/or modify this document under the terms of the GNU Free
+      Documentation License, Version 1.3 or any later version published by the Free Software Foundation; with
+      no Invariant Sections, with no Front-Cover Texts, and with no Back-Cover Texts. The complete license text
+      is available from the <link href="http://www.fsf.org/">Free Software Foundation</link>.
+    </license>
+    <desc>User documentation</desc>
+    <credit type="author copyright">
+      <name>Mike Massonnet</name>
+      <email>mmassonnet@xfce.org</email>
+      <years>2010</years>
+    </credit>
+    <credit type="editor">
+      <name>Bill Marr</name>
+    </credit>
+    <credit type="editor">
+      <name>Christian Dywan</name>
+    </credit>
+  </info>
+
+  <title>Task Manager</title>
+
+  <p><app>Task Manager</app> is a simple and intuitive tool to show the processes and applications currently
+    running on your system. You can also monitor your CPU and memory usage, and execute or terminate tasks.</p>
+
+  <p>It is compatible with Linux, OpenBSD, FreeBSD and OpenSolaris.</p>
+
+  <section id="getting-started">
+    <title>Getting Started</title>
+
+    <p>To run the <app>Task Manager</app> execute the command <cmd>xfce4-taskmanager</cmd> or select
+      it from <guiseq><gui>Applications menu</gui><gui>System</gui></guiseq>.</p>
+
+    <p>The application shows a toolbar, the list of <link xref="#processes">processes</link> and a status bar.</p>
+
+    <p>From the toolbar you can execute a new task, open a terminal or start an application finder (only when
+      available). You can open the settings dialog and tweak the application which is explained in the
+      <link xref="#customization">Customization</link> section. It also displays monitors with the history of the
+      CPU and memory usage.</p>
+
+    <p>The status bar lets you quickly know about the overall usage of the system. It displays the number of
+      processes running, and also the CPU, memory and swap usage.</p>
+  </section>
+
+  <section id="processes">
+    <title>Processes</title>
+
+    <p>The information about the processes are presented in multiple columns. These columns can be sorted and
+      rearranged by clicking and drag and dropping the headers.</p>
+
+    <p>When right clicking a task, it is possible to send it signals like "<em>Terminate</em>" or "<em>Kill</em>",
+      and to change its priority from "<em>Very Low</em>" to "<em>Very High</em>".</p>
+
+    <p>Newly executed tasks are highlighted in green, terminated tasks in red, and tasks with changing state (for
+      example from stopped to running) in yellow.</p>
+
+    <terms>
+      <title>Processes Columns</title>
+      <item><title>PID</title><p>The identifier of the process.</p></item>
+      <item><title>PPID</title><p>The identifier of the parent process.</p></item>
+      <item><title>State</title><p>The current state like running, stopped, or idling.</p></item>
+      <item><title>Virtual Bytes</title><p>The virtual memory size.</p></item>
+      <item><title>Private Bytes</title><p>The physical memory size.</p></item>
+      <item><title>UID</title><p>The effictive user name.</p></item>
+      <item><title>CPU</title><p>The usage over time of the CPU in percent.</p></item>
+      <item><title>Priority</title>
+        <p>The higher the priority of a process, the more it will be privileged by the task scheduler. The task scheduler
+	  continuously selects processes to be executed on one CPU core.</p></item>
+    </terms>
+  </section>
+
+  <section id="customization">
+    <title>Customization</title>
+
+    <p>Customizing the application can be done through the GUI via the settings button in the toolbar. Clicking the
+      settings button will open the <link xref="#settings-dialog">settings dialog</link>, and clicking the arrow
+      beneath the button will popup a contextual menu.</p>
+
+    <section id="settings-dialog">
+      <title>Settings Dialog</title>
+
+      <terms>
+        <title>Interface Style</title>
+        <item><title>Show application icons</title>
+          <p>Show application icons beneath the task name in the list of processes. Only available if built with the
+	    configure flag <code>--enable-wnck</code>.</p></item>
+        <item><title>Show full command lines</title>
+          <p>Show full command lines instead of short names for the processes.</p></item>
+        <item><title>Show values with more precision</title>
+          <p>Show percentage values (e.g. memory and CPU) with decimals for more precision.</p></item>
+        <item><title>Draw borders around monitors</title>
+          <p>Draw borders around the monitors.</p></item>
+        <item><title>Toolbar style</title>
+          <p>Combo list option to customize the toolbar style with small icons, large icons, or icons with text.</p></item>
+      </terms>
+
+      <terms>
+        <title>Miscellaneous</title>
+        <item><title>Prompt for terminating tasks</title>
+          <p>Prompt for terminating tasks when sending a "<em>Terminate</em>" signal to it. Disabling this option
+	    will terminate tasks instantaneously.</p></item>
+        <item><title>Hide into the notification area</title>
+          <p>When closing the window, hide the application inside the notification area. This option also activates the
+	    icon within the notification area.</p></item>
+      </terms>
+    </section>
+
+    <section id="settings-context-menu">
+      <title>Contextual Menu</title>
+      
+      <p>The contextual menu, when clicking the arrow beneath the settings button in the toolbar, lets you quickly filter
+        the information to display. You can <em>list all the processes</em> on the system, choose a different <em>refresh
+        rate</em>, and select which columns to show in the list of processes.</p>
+    </section>
+  </section>
+
+  <section id="support">
+    <title>Support</title>
+    
+    <p>To report a bug or a feature request use the <link href="http://bugzilla.xfce.org/">bug tracker</link>. If you have
+      questions please ask on the <link href="http://forum.xfce.org/">forum</link>, the
+      <link href="http://foo-projects.org/mailman/listinfo/xfce">mailing-list</link> or 
+      <link href="irc://irc.freenode.net/#xfce">IRC</link>.</p>
+  </section>
+
+  <section id="about">
+    <title>About</title>
+
+    <p>Task Manager was originally written by Johannes Zellner, and nowadays it is maintained by Mike
+      Massonnet. The software is released under the <link href="http://www.gnu.org/licenses/gpl-2.0-standalone.html">GNU
+      GPLv2 or later</link> license. You can visit the <link href="http://goodies.xfce.org/projects/applications/xfce4-taskmanager">project web page</link>.</p>
+  </section>
+
+</page>