naksh 0.2.0

data/COPYING-DOCS

@@ -0,0 +1,15 @@
+    NAKSH - Interactive Shell Emulator with Manipulated Commands
+    Copyright (C) 2011  Mahmut Bulut
+
+    This program is free software: you can redistribute it and/or modify
+    it under the terms of the GNU General Public License as published by
+    the Free Software Foundation, either version 3 of the License, or
+    (at your option) any later version.
+
+    This program is distributed in the hope that it will be useful,
+    but WITHOUT ANY WARRANTY; without even the implied warranty of
+    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+    GNU General Public License for more details.
+
+    You should have received a copy of the GNU General Public License
+    along with this program.  If not, see <http://www.gnu.org/licenses/>.

data/README.md

@@ -0,0 +1,45 @@
+Nodal Associative Knowledge Shell
+=========
+
+# Written by Mahmut Bulut
+# Project starting date May 21, 2011
+# Bleeding Edge Version: 0.2.0
+
+## Welcome to Naksh!
+
+
+No installation or uninstallation is required at the moment,
+just run naksh/lib/naksh.rb from any directory
+
+or install gem via
+
+<pre><code> # gem install naksh </code></pre>
+
+There are currently two interfaces, one in Gtk, which is fairly
+complete except for menu tooltips and tabs, and one in Wx, which has
+menu tooltips and proper tabbing, but nothing else.
+
+
+Lets rundown some important files
+
+lib/naksh.rb is the principal file.
+lib/naksh/syntax/bash.rb is the parser
+lib/naksh/buffer.rb is the buffering system (for piping)
+
+## Drive the project and SUPPORT
+
+If you have any issues, feel free to SCREAM in
+
+ * #naksh on irc.freenode.net
+
+## Repository
+
+The git repository is available
+
+'http://github.com/regularlambda/naksh'
+
+downloads are generally available at
+
+ * http://github.com/regularlambda/naksh
+
+'Downloads' section.

data/Rakefile

@@ -0,0 +1,129 @@
+#!/usr/local/bin/ruby
+# 2011 Mahmut Bulut
+
+# This file is part of Naksh.
+#
+# Naksh is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# Naksh is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with Naksh.  If not, see <http://www.gnu.org/licenses/>.
+
+load    'naksh.gemspec'
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+require 'rake/gempackagetask'
+require 'spec/rake/spectask'
+
+rule 'bin/*' do |*a|
+  p a
+  true
+end
+
+
+desc 'Remove any files outside the naksh main directory, such as those created by GConf'
+task :uninstall do |t|
+  `rm -r --force ~/.gconf/apps/naksh`
+end
+
+
+Rake::RDocTask.new do |rd|
+  rd.main = "README.rdoc"
+  rd.rdoc_files.include("README.rdoc", "lib/**/*.rb")
+end
+
+Rake::RDocTask.new :rdoc_dev do |rd|
+  rd.main = "README.doc"
+  rd.rdoc_files.include("README.rdoc", "lib/**/*.rb")
+  rd.options << "--all"
+end
+
+desc 'Send rdoc to rubyforge'
+task :rf_doc do
+  `sudo chmod -R 755 doc`
+  `/usr/bin/scp -r -p docs/rdoc* db-keen@rubyforge.org:/var/www/gforge-projects/naksh/docs/rdoc`
+end
+
+=begin
+desc "Run all tests"
+Rake::TestTask.new do |t|
+  t.libs << "test"
+  t.test_files = FileList['test/*/**/*.rb']
+  t.verbose = true
+end
+=end
+
+desc "Run all specs"
+Spec::Rake::SpecTask.new 'spec' do |t|
+  t.spec_files = FileList['test/**/*.rspec.rb']
+  t.spec_opts = ['--options', 'spec.opts']
+end
+
+
+desc "Run all specs and generate an rcov report"
+Spec::Rake::SpecTask.new 'spec:rcov' do |t|
+  t.spec_files = FileList['test/**/*.rspec.rb']
+  t.spec_opts = ['--options', 'spec.opts']
+  t.rcov = true
+  t.rcov_dir = 'coverage'
+  t.rcov_opts = ['--exclude', 'gems', '--exclude', 'spec']
+end
+
+
+Rake::GemPackageTask.new($spec) do |p|
+  p.need_tar     = true
+  p.need_tar_gz  = true
+  p.need_tar_bz2 = true
+  p.need_zip     = true
+  p.package_files.exclude("site")
+end
+
+desc 'Upgrade to a newer version of the same installation type'
+task :update do |t|
+  raise NotImplementedError
+end
+
+
+desc 'Copy working copy to public site'
+task 'commit_site' do |t|
+  `cd #{__FILE__}`
+  `svn commit`
+end
+desc "Generate HTML report for failing examples"
+Spec::Rake::SpecTask.new('failing_examples_with_html') do |t|
+  t.spec_files = FileList['failing_examples/**/*.rb']
+  t.spec_opts = ["--format", "html:../doc/output/documentation/tools/failing_examples.html", "--diff"]
+  t.fail_on_error = false
+end
+
+
+desc 'Copy website to working copy'
+task 'load_site' do |t|
+  raise NotImplementedError
+end
+
+desc "Generate PO translation files"
+task :prep_translation do
+  TEXT_DOMAIN = "naksh"
+  VERSION     = "Naksh 0.2.0"
+  GetText.update_pofiles(TEXT_DOMAIN,Dir.glob("{lib,bin,test}/**/*.{rb,nkc}"),VERSION)
+end
+
+desc 'Check online to see if a newer version is available (doesn\'t work)'
+task 'check_updates' do |t|
+  $stderr.puts 'check updates is not expected to work at this time'
+  raise NotImplementedError
+  require 'network/http'
+  require 'xri/url'
+  require 'scooter/json'
+  Json.load(Network.http_request('http://naksh.rubyforge.org/status/releases.json'.to_url).body).to_stnkct.latest.date>self.date
+end
+

data/TODO

@@ -0,0 +1,19 @@
+Todo
+
+bash.rb
+
+> redirection
+$var substitution
+* replacement
+
+
+
+We always need to add more commands!
+
+** Gem platform (Linux, Mac, Windows gem creation)
+** Hard coders apreciate above aim.
+** Tweakers will tweak built-ins.
+
+See naksh/commands/bash/echo.nkc.rb for an example.
+
+At the moment, the .nkc.rb ending is a flag to Naksh that it was built just for us.

data/bin/naksh

@@ -0,0 +1,2 @@
+#!/bin/sh
+ruby lib/naksh.rb

data/data/default.po

@@ -0,0 +1,16 @@
+msgid ""
+msgstr ""
+"Plural-Forms: singular,plural\n"
+"Project-Id-Version: Naksh 0.2.0\n"
+"POT-Creation-Date: \n"
+"PO-Revision-Date: 2011-12-24 18:18-0600\n"
+"Last-Translator: Mahmut Bulut <scienceblock@gmail.com>\n"
+"Language-Team: http://naksh.rubyforge.org/contributors#translators <naksh-developers@rubyforge.org>\n"
+"MIME-Version: 1.0\n"
+"Content-Type: text/plain; charset=utf-8\n"
+"Content-Transfer-Encoding: 8bit\n"
+"X-Poedit-Language: English\n"
+"X-Poedit-Country: UNITED STATES\n"
+"X-Poedit-SourceCharset: utf-8\n"
+"X-Poedit-KeywordsList: _(\n"
+

data/data/default2.po

@@ -0,0 +1,27 @@
+msgid ""
+msgstr ""
+"Project-Id-Version: Naksh 0.2.0\n"
+"POT-Creation-Date: \n"
+"PO-Revision-Date: 2011-12-24 18:22-0600\n"
+"Last-Translator: Mahmut Bulut <scienceblock@gmail.com>\n"
+"Language-Team: http://naksh.rubyforge.org/contributors <naksh-developers@rubyforge.org>\n"
+"MIME-Version: 1.0\n"
+"Content-Type: text/plain; charset=utf-8\n"
+"Content-Transfer-Encoding: 8bit\n"
+"Plural-Forms: Singular,Plural\n"
+"X-Poedit-Language: English\n"
+"X-Poedit-Country: UNITED STATES\n"
+"X-Poedit-SourceCharset: utf-8\n"
+
+#: lib/naksh.rb:55
+msgid "Naksh: "
+msgstr "Naksh says: "
+
+#: lib/naksh/command_handling.rb:88
+msgid "%{command}: command not found"
+msgstr "I couldn't find a command named `%{command}'."
+
+#: lib/naksh/syntax/bash.rb:117
+msgid "commands cannot begin with the following character"
+msgstr "You can't start a command with "
+

data/data/starter.pot

@@ -0,0 +1,29 @@
+# SOME DESCRIPTIVE TITLE.
+# Copyright (C) YEAR THE PACKAGE'S COPYRIGHT HOLDER
+# This file is distributed under the same license as the PACKAGE package.
+# FIRST AUTHOR <EMAIL@ADDRESS>, YEAR.
+#
+#, fuzzy
+msgid ""
+msgstr ""
+"Project-Id-Version: PACKAGE VERSION\n"
+"POT-Creation-Date: 2011-12-24 18:17-0600\n"
+"PO-Revision-Date: 2011-12-24 18:17-0600\n"
+"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
+"Language-Team: LANGUAGE <LL@li.org>\n"
+"MIME-Version: 1.0\n"
+"Content-Type: text/plain; charset=UTF-8\n"
+"Content-Transfer-Encoding: 8bit\n"
+"Plural-Forms: nplurals=INTEGER; plural=EXPRESSION;\n"
+
+#: lib/naksh.rb:55
+msgid "Naksh: "
+msgstr ""
+
+#: lib/naksh/command_handling.rb:88
+msgid "%{command}: command not found"
+msgstr ""
+
+#: lib/naksh/syntax/bash.rb:117
+msgid "commands cannot begin with the following character"
+msgstr ""

data/docs/gtk_manual.txt

@@ -0,0 +1,13 @@
+This is the manual for the GTK interface to Naksh.
+
+KEYS
+
+Up          - Go back one history entry
+Down        - Go forward one history entry
+PageUp      - Go to the first history entry
+PageDown    - Go to the last history entry
+Home        - Move cursor to the beginning of the current entry
+End         - Move cursor to the end of the current entry
+Return      - Submit
+KeypadEnter - 'line feed' character
+Escape      - erase current entry

data/docs/master_plan.svg

@@ -0,0 +1,74 @@
+<?xml version="1.0" encoding="UTF-8" standalone="no"?>
+<!DOCTYPE svg PUBLIC "-//W3C//DTD SVG 1.0//EN" "http://www.w3.org/TR/2001/PR-SVG-20010719/DTD/svg10.dtd">
+<svg width="19cm" height="20cm" viewBox="15 3 19 20">
+  <rect style="fill: #ffffff" x="15.45" y="3.85" width="6" height="1.35"/>
+  <rect style="fill: none; fill-opacity:0; stroke-width: 0.1; stroke: #000000" x="15.45" y="3.85" width="6" height="1.35"/>
+  <text style="fill: #000000; font-size: 0.8 cm; length: 5.1675 cm; font-family: sans; font-style: normal; font-weight: normal" x="15.8662" y="4.5975">input_mechanism</text>
+  <text style="fill: #000000; font-size: 0.8 cm; length: 10.4775 cm; font-family: sans; font-style: normal; font-weight: normal" x="15.7313" y="6.56647">Naksh.syntax.execute(script_str)</text>
+  <rect style="fill: #ffffff" x="15.45" y="7.35" width="6.3" height="1.25"/>
+  <rect style="fill: none; fill-opacity:0; stroke-width: 0.1; stroke: #000000" x="15.45" y="7.35" width="6.3" height="1.25"/>
+  <text style="fill: #000000; font-size: 0.8 cm; length: 5.535 cm; font-family: sans; font-style: normal; font-weight: normal" x="15.8325" y="8.03897">parser_mechanism</text>
+  <text style="fill: #000000; font-size: 0.8 cm; length: 17.995 cm; font-family: sans; font-style: normal; font-weight: normal" x="15.81" y="10.189">Naksh.send_command(command_name_str,array_of_args)</text>
+  <rect style="fill: #ffffff" x="15.44" y="20.955" width="6" height="1.35"/>
+  <rect style="fill: none; fill-opacity:0; stroke-width: 0.1; stroke: #000000" x="15.44" y="20.955" width="6" height="1.35"/>
+  <text style="fill: #000000; font-size: 0.8 cm; length: 5.59 cm; font-family: sans; font-style: normal; font-weight: normal" x="15.645" y="21.694">output_mechanism</text>
+  <text style="fill: #000000; font-size: 0.8 cm; length: 13.1625 cm; font-family: sans; font-style: normal; font-weight: normal" x="15.8387" y="17.489">Naksh.buffer.puts or Naksh.buffer.print</text>
+  <rect style="fill: #ffffff" x="15.5" y="14.55" width="8.3" height="1.35"/>
+  <rect style="fill: none; fill-opacity:0; stroke-width: 0.1; stroke: #000000" x="15.5" y="14.55" width="8.3" height="1.35"/>
+  <text style="fill: #000000; font-size: 0.8 cm; length: 0 cm; font-family: sans; font-style: normal; font-weight: normal" x="19.65" y="15.225"></text>
+  <text style="fill: #000000; font-size: 0.8 cm; length: 7.32 cm; font-family: sans; font-style: normal; font-weight: normal" x="15.99" y="15.2975">A separate command file</text>
+  <rect style="fill: #ffffff" x="15.45" y="11.45" width="7.4" height="1.4"/>
+  <rect style="fill: none; fill-opacity:0; stroke-width: 0.1; stroke: #000000" x="15.45" y="11.45" width="7.4" height="1.4"/>
+  <text style="fill: #000000; font-size: 0.8 cm; length: 6.845 cm; font-family: sans; font-style: normal; font-weight: normal" x="15.7275" y="12.2225">command/path handler</text>
+  <ellipse style="fill: #ffffff" cx="27.125" cy="8.05" rx="1.475" ry="0.8"/>
+  <ellipse style="fill: none; fill-opacity:0; stroke-width: 0.1; stroke: #000000" cx="27.125" cy="8.05" rx="1.475" ry="0.8"/>
+  <text style="fill: #000000; font-size: 0.8 cm; length: 2.225 cm; font-family: sans; font-style: normal; font-weight: normal" x="26.0125" y="8.1225">Bash.rb</text>
+  <line style="fill: none; fill-opacity:0; stroke-width: 0.1; stroke: #000000" x1="22.287" y1="8.00744" x2="25.1137" y2="8.0323"/>
+  <polygon style="fill: #000000" points="21.9121,8.00414 22.4142,7.75855 22.287,8.00744 22.4098,8.25853 "/>
+  <polygon style="fill: none; fill-opacity:0; stroke-width: 0.1; stroke: #000000" points="21.9121,8.00414 22.4142,7.75855 22.287,8.00744 22.4098,8.25853 "/>
+  <polygon style="fill: #000000" points="25.4886,8.0356 24.9865,8.2812 25.1137,8.0323 24.9909,7.78121 "/>
+  <polygon style="fill: none; fill-opacity:0; stroke-width: 0.1; stroke: #000000" points="25.4886,8.0356 24.9865,8.2812 25.1137,8.0323 24.9909,7.78121 "/>
+  <ellipse style="fill: #ffffff" cx="26.925" cy="4.225" rx="1.775" ry="0.825"/>
+  <ellipse style="fill: none; fill-opacity:0; stroke-width: 0.1; stroke: #000000" cx="26.925" cy="4.225" rx="1.775" ry="0.825"/>
+  <text style="fill: #000000; font-size: 0.8 cm; length: 2.3925 cm; font-family: sans; font-style: normal; font-weight: normal" x="25.7287" y="4.2975">Highline</text>
+  <line style="fill: none; fill-opacity:0; stroke-width: 0.1; stroke: #000000" x1="21.9869" y1="4.3998" x2="24.6343" y2="4.30609"/>
+  <polygon style="fill: #000000" points="21.6121,4.41307 22.1029,4.14554 21.9869,4.3998 22.1206,4.64522 "/>
+  <polygon style="fill: none; fill-opacity:0; stroke-width: 0.1; stroke: #000000" points="21.6121,4.41307 22.1029,4.14554 21.9869,4.3998 22.1206,4.64522 "/>
+  <polygon style="fill: #000000" points="25.009,4.29282 24.5182,4.56035 24.6343,4.30609 24.5005,4.06067 "/>
+  <polygon style="fill: none; fill-opacity:0; stroke-width: 0.1; stroke: #000000" points="25.009,4.29282 24.5182,4.56035 24.6343,4.30609 24.5005,4.06067 "/>
+  <ellipse style="fill: #ffffff" cx="27.4523" cy="21.575" rx="1.775" ry="0.825"/>
+  <ellipse style="fill: none; fill-opacity:0; stroke-width: 0.1; stroke: #000000" cx="27.4523" cy="21.575" rx="1.775" ry="0.825"/>
+  <text style="fill: #000000; font-size: 0.8 cm; length: 2.3925 cm; font-family: sans; font-style: normal; font-weight: normal" x="26.256" y="21.6475">Highline</text>
+  <line style="fill: none; fill-opacity:0; stroke-width: 0.1; stroke: #000000" x1="21.9769" y1="21.6031" x2="25.1905" y2="21.5787"/>
+  <polygon style="fill: #000000" points="21.6019,21.606 22.1,21.3522 21.9769,21.6031 22.1038,21.8522 "/>
+  <polygon style="fill: none; fill-opacity:0; stroke-width: 0.1; stroke: #000000" points="21.6019,21.606 22.1,21.3522 21.9769,21.6031 22.1038,21.8522 "/>
+  <polygon style="fill: #000000" points="25.5655,21.5758 25.0674,21.8296 25.1905,21.5787 25.0636,21.3297 "/>
+  <polygon style="fill: none; fill-opacity:0; stroke-width: 0.1; stroke: #000000" points="25.5655,21.5758 25.0674,21.8296 25.1905,21.5787 25.0636,21.3297 "/>
+  <ellipse style="fill: #ffffff" cx="29.7891" cy="12.25" rx="3.76086" ry="0.95"/>
+  <ellipse style="fill: none; fill-opacity:0; stroke-width: 0.1; stroke: #000000" cx="29.7891" cy="12.25" rx="3.76086" ry="0.95"/>
+  <text style="fill: #000000; font-size: 0.8 cm; length: 6.53 cm; font-family: sans; font-style: normal; font-weight: normal" x="26.5241" y="12.3225">command_handling.rb</text>
+  <line style="fill: none; fill-opacity:0; stroke-width: 0.1; stroke: #000000" x1="23.387" y1="12.2116" x2="25.5415" y2="12.2429"/>
+  <polygon style="fill: #000000" points="23.012,12.2061 23.5156,11.9634 23.387,12.2116 23.5083,12.4634 "/>
+  <polygon style="fill: none; fill-opacity:0; stroke-width: 0.1; stroke: #000000" points="23.012,12.2061 23.5156,11.9634 23.387,12.2116 23.5083,12.4634 "/>
+  <polygon style="fill: #000000" points="25.9165,12.2484 25.4129,12.4911 25.5415,12.2429 25.4202,11.9911 "/>
+  <polygon style="fill: none; fill-opacity:0; stroke-width: 0.1; stroke: #000000" points="25.9165,12.2484 25.4129,12.4911 25.5415,12.2429 25.4202,11.9911 "/>
+  <ellipse style="fill: #ffffff" cx="30.625" cy="15.075" rx="2.275" ry="0.775"/>
+  <ellipse style="fill: none; fill-opacity:0; stroke-width: 0.1; stroke: #000000" cx="30.625" cy="15.075" rx="2.275" ry="0.775"/>
+  <text style="fill: #000000; font-size: 0.8 cm; length: 3.305 cm; font-family: sans; font-style: normal; font-weight: normal" x="28.9725" y="15.1475">echo.nkc.rb</text>
+  <line style="fill: none; fill-opacity:0; stroke-width: 0.1; stroke: #000000" x1="24.3361" y1="15.161" x2="27.8148" y2="15.1134"/>
+  <polygon style="fill: #000000" points="23.9612,15.1661 24.4577,14.9093 24.3361,15.161 24.4645,15.4092 "/>
+  <polygon style="fill: none; fill-opacity:0; stroke-width: 0.1; stroke: #000000" points="23.9612,15.1661 24.4577,14.9093 24.3361,15.161 24.4645,15.4092 "/>
+  <polygon style="fill: #000000" points="28.1898,15.1083 27.6933,15.3651 27.8148,15.1134 27.6864,14.8651 "/>
+  <polygon style="fill: none; fill-opacity:0; stroke-width: 0.1; stroke: #000000" points="28.1898,15.1083 27.6933,15.3651 27.8148,15.1134 27.6864,14.8651 "/>
+  <rect style="fill: #ffffff" x="15.41" y="18.355" width="7.09" height="1.35"/>
+  <rect style="fill: none; fill-opacity:0; stroke-width: 0.1; stroke: #000000" x="15.41" y="18.355" width="7.09" height="1.35"/>
+  <text style="fill: #000000; font-size: 0.8 cm; length: 6.3175 cm; font-family: sans; font-style: normal; font-weight: normal" x="15.7962" y="19.1025">buffering_mechanism</text>
+  <ellipse style="fill: #ffffff" cx="27.4223" cy="18.975" rx="1.6277" ry="0.975"/>
+  <ellipse style="fill: none; fill-opacity:0; stroke-width: 0.1; stroke: #000000" cx="27.4223" cy="18.975" rx="1.6277" ry="0.975"/>
+  <text style="fill: #000000; font-size: 0.8 cm; length: 2.49 cm; font-family: sans; font-style: normal; font-weight: normal" x="26.1773" y="19.039">buffer.rb</text>
+  <line style="fill: none; fill-opacity:0; stroke-width: 0.1; stroke: #000000" x1="23.0361" y1="18.9972" x2="25.3078" y2="18.9789"/>
+  <polygon style="fill: #000000" points="22.6611,19.0002 23.1591,18.7462 23.0361,18.9972 23.1631,19.2462 "/>
+  <polygon style="fill: none; fill-opacity:0; stroke-width: 0.1; stroke: #000000" points="22.6611,19.0002 23.1591,18.7462 23.0361,18.9972 23.1631,19.2462 "/>
+  <polygon style="fill: #000000" points="25.6828,18.9759 25.1848,19.2299 25.3078,18.9789 25.1808,18.7299 "/>
+  <polygon style="fill: none; fill-opacity:0; stroke-width: 0.1; stroke: #000000" points="25.6828,18.9759 25.1848,19.2299 25.3078,18.9789 25.1808,18.7299 "/>
+</svg>

data/docs/userguide/en/about.xml

@@ -0,0 +1,42 @@
+<!--
+  This is part of the Naksh Manual.
+  Copyright (C) 2011-2008 Mahmut Bulut
+  See the file alexandria.xml for copying conditions.
+-->
+
+<!-- ============= About ================================== -->
+<!-- This section contains info about the program (not docs), such as
+     author's name(s), web page, license, feedback address. This
+     section is optional: primary place for this info is "About.." box of
+     the program. However, if you do wish to include this info in the
+     manual, this is the place to put it. Alternatively, you can put
+     this information in the title page.-->
+
+<section id="about">
+  <title>About &app;</title>
+
+  <para>
+    &app; was effectively created by chatter on the ruby-talk mailing
+    list in October 2011. It has thus far been written almost entirely
+    by Mahmut Bulut. For a list of other contributors, see
+    the file AUTHORS that came with &app;. For more information, visit
+    the &app; project <ulink url="http://naksh.rubyforge.org/"
+    type="http">web page</ulink>.
+  </para>
+
+  <para>
+    To report a bug or make a suggestion regarding the &app;
+    application or this manual, follow the directions on the <ulink
+    url="http://naksh.rubyforge.org/dev/feedback" type="http">&app;
+    Feedback web page</ulink>.
+  </para>
+
+  <para>
+    &app; is distributed under the terms of the GNU General Public
+    license as published by the Free Software Foundation; either
+    version 3 of the License, or (at your option) any later version. A
+    copy of this license can be found at this <ulink url="ghelp:gpl"
+    type="help">link</ulink>, or in the file COPYING included with the
+    source code of this program.
+  </para>
+</section>

data/docs/userguide/en/gnu-fdl-1.2.xml

@@ -0,0 +1,543 @@
+<!--
+  Copyright (C) 2000,2001,2002  Free Software Foundation, Inc.
+  51 Franklin St, Fifth Floor, Boston, MA  0.2.0-1301  USA
+  Everyone is permitted to copy and distribute verbatim copies
+  of this license document, but changing it is not allowed.
+-->
+<appendix id="gfdl">
+  <title>GNU Free Documentation License</title>
+  <subtitle>Version 1.2, November 2002</subtitle>
+  <para>
+    Copyright &copy; 2000, 2001, 2002 Free Software
+    Foundation, <abbrev>Inc.</abbrev>
+    <address>
+      <street>51 Franklin <abbrev>St</abbrev>, Fifth Floor</street>,
+      <city>Boston</city>,
+      <state><abbrev>MA</abbrev></state> <postcode>02111-1307</postcode>
+      <country><abbrev role="initialism">USA</abbrev></country>
+    </address>
+
+    Everyone is permitted to copy and distribute verbatim copies of
+    this license document, but changing it is not allowed.
+  </para>
+
+  <appendixinfo>
+    <title>GNU Free Documentation License</title>
+    <releaseinfo>
+      Version 1.2, November 2002
+    </releaseinfo>
+
+    <copyright>
+      <year>2000</year>
+      <year>2001</year>
+      <year>2002</year>
+      <holder>Free Software Foundation, <abbrev>Inc.</abbrev></holder>
+    </copyright>
+
+    <corpauthor>
+      <surname>Free Software Foundation</surname>
+    </corpauthor>
+
+    <legalnotice id="legalnotice">
+      <para>
+  Everyone is permitted to copy and distribute verbatim copies
+  of this license document, but changing it is not allowed.
+      </para>
+    </legalnotice>
+
+  </appendixinfo>
+
+
+  <section id="Preamble" label="0. ">
+    <title>PREAMBLE</title>
+    <para>
+      The purpose of this License is to make a manual, textbook, or other
+      functional and useful document "free" in the sense of freedom: to assure
+      everyone the effective freedom to copy and redistribute it, with or
+      without modifying it, either commercially or noncommercially.
+      Secondarily, this License preserves for the author and publisher a way to
+      get credit for their work, while not being considered responsible for
+      modifications made by others.
+    </para>
+    <para>
+      This License is a kind of "copyleft", which means that derivative works of
+      the document must themselves be free in the same sense.  It complements
+      the GNU General Public License, which is a copyleft license designed for
+      free software.
+    </para>
+    <para>
+      We have designed this License in order to use it for manuals for free
+      software, because free software needs free documentation: a free program
+      should come with manuals providing the same freedoms that the software
+      does.  But this License is not limited to software manuals; it can be used
+      for any textual work, regardless of subject matter or whether it is
+      published as a printed book.  We recommend this License principally for
+    works whose purpose is instnkction or reference.</para>
+  </section>
+  <section id="Definitions" label="1. ">
+    <title>APPLICABILITY AND DEFINITIONS</title>
+    <para>
+      This License applies to any manual or other work, in any medium, that
+      contains a notice placed by the copyright holder saying it can be
+      distributed under the terms of this License.  Such a notice grants a
+      world-wide, royalty-free license, unlimited in duration, to use that work
+      under the conditions stated herein.  The "Document", below, refers to any
+      such manual or work.  Any member of the public is a licensee, and is
+      addressed as "you".  You accept the license if you copy, modify or
+      distribute the work in a way requiring permission under copyright
+      law.
+    </para>
+    <para>
+      A "Modified Version" of the Document means any work containing the
+      Document or a portion of it, either copied verbatim, or with modifications
+      and/or translated into another language.
+    </para>
+    <para>
+      A "Secondary Section" is a named appendix or a front-matter section of the
+      Document that deals exclusively with the relationship of the publishers or
+      authors of the Document to the Document's overall subject (or to related
+      matters) and contains nothing that could fall directly within that overall
+      subject.  (Thus, if the Document is in part a textbook of mathematics, a
+      Secondary Section may not explain any mathematics.)  The relationship
+      could be a matter of historical connection with the subject or with
+      related matters, or of legal, commercial, philosophical, ethical or
+      political position regarding them.
+    </para>
+    <para>
+      The "Invariant Sections" are certain Secondary Sections whose titles are
+      designated, as being those of Invariant Sections, in the notice that says
+      that the Document is released under this License.  If a section does not
+      fit the above definition of Secondary then it is not allowed to be
+      designated as Invariant.  The Document may contain zero Invariant
+      Sections.  If the Document does not identify any Invariant Sections then
+      there are none.
+    </para>
+    <para>
+      The "Cover Texts" are certain short passages of text that are listed, as
+      Front-Cover Texts or Back-Cover Texts, in the notice that says that the
+      Document is released under this License.  A Front-Cover Text may be at
+      most 5 words, and a Back-Cover Text may be at most 25 words.
+    </para>
+    <para>
+      A "Transparent" copy of the Document means a machine-readable copy,
+      represented in a format whose specification is available to the general
+      public, that is suitable for revising the document straightforwardly with
+      generic text editors or (for images composed of pixels) generic paint
+      programs or (for drawings) some widely available drawing editor, and that
+      is suitable for input to text formatters or for automatic translation to a
+      variety of formats suitable for input to text formatters.  A copy made in
+      an otherwise Transparent file format whose markup, or absence of markup,
+      has been arranged to thwart or discourage subsequent modification by
+      readers is not Transparent.  An image format is not Transparent if used
+      for any substantial amount of text.  A copy that is not "Transparent" is
+      called "Opaque".
+    </para>
+    <para>
+      Examples of suitable formats for Transparent copies include plain ASCII
+      without markup, Texinfo input format, LaTeX input format, SGML or XML
+      using a publicly available DTD, and standard-conforming simple HTML,
+      PostScript or PDF designed for human modification.  Examples of
+      transparent image formats include PNG, XCF and JPG.  Opaque formats
+      include proprietary formats that can be read and edited only by
+      proprietary word processors, SGML or XML for which the DTD and/or
+      processing tools are not generally available, and the machine-generated
+      HTML, PostScript or PDF produced by some word processors for output
+      purposes only.
+    </para>
+    <para>
+      The "Title Page" means, for a printed book, the title page itself, plus
+      such following pages as are needed to hold, legibly, the material this
+      License requires to appear in the title page.  For works in formats which
+      do not have any title page as such, "Title Page" means the text near the
+      most prominent appearance of the work's title, preceding the beginning of
+      the body of the text.
+    </para>
+    <para>
+      A section "Entitled XYZ" means a named subunit of the Document whose title
+      either is precisely XYZ or contains XYZ in parentheses following text that
+      translates XYZ in another language.  (Here XYZ stands for a specific
+      section name mentioned below, such as "Acknowledgements", "Dedications",
+      "Endorsements", or "History".)  To "Preserve the Title" of such a section
+      when you modify the Document means that it remains a section "Entitled
+      XYZ" according to this definition.
+    </para>
+    <para>
+      The Document may include Warranty Disclaimers next to the notice which
+      states that this License applies to the Document.  These Warranty
+      Disclaimers are considered to be included by reference in this License,
+      but only as regards disclaiming warranties: any other implication that
+      these Warranty Disclaimers may have is void and has no effect on the
+      meaning of this License.
+    </para>
+  </section>
+  <section id="VerbatimCopying" label="2. ">
+    <title>VERBATIM COPYING</title>
+    <para>
+      You may copy and distribute the Document in any medium, either
+      commercially or noncommercially, provided that this License, the copyright
+      notices, and the license notice saying this License applies to the
+      Document are reproduced in all copies, and that you add no other
+      conditions whatsoever to those of this License.  You may not use technical
+      measures to obstnkct or control the reading or further copying of the
+      copies you make or distribute.  However, you may accept compensation in
+      exchange for copies.  If you distribute a large enough number of copies
+      you must also follow the conditions in section 3.
+    </para>
+    <para>
+      You may also lend copies, under the same conditions stated above, and you
+      may publicly display copies.
+    </para>
+  </section>
+  <section id="QuantityCopying" label="3. ">
+    <title>COPYING IN QUANTITY</title>
+    <para>
+      If you publish printed copies (or copies in media that commonly have
+      printed covers) of the Document, numbering more than 100, and the
+      Document's license notice requires Cover Texts, you must enclose the
+      copies in covers that carry, clearly and legibly, all these Cover Texts:
+      Front-Cover Texts on the front cover, and Back-Cover Texts on the back
+      cover.  Both covers must also clearly and legibly identify you as the
+      publisher of these copies.  The front cover must present the full title
+      with all words of the title equally prominent and visible.  You may add
+      other material on the covers in addition.  Copying with changes limited to
+      the covers, as long as they preserve the title of the Document and satisfy
+      these conditions, can be treated as verbatim copying in other
+      respects.
+    </para>
+    <para>
+      If the required texts for either cover are too voluminous to fit legibly,
+      you should put the first ones listed (as many as fit reasonably) on the
+      actual cover, and continue the rest onto adjacent pages.
+    </para>
+    <para>
+      If you publish or distribute Opaque copies of the Document numbering more
+      than 100, you must either include a machine-readable Transparent copy
+      along with each Opaque copy, or state in or with each Opaque copy a
+      computer-network location from which the general network-using public has
+      access to download using public-standard network protocols a complete
+      Transparent copy of the Document, free of added material.  If you use the
+      latter option, you must take reasonably prudent steps, when you begin
+      distribution of Opaque copies in quantity, to ensure that this Transparent
+      copy will remain thus accessible at the stated location until at least one
+      year after the last time you distribute an Opaque copy (directly or
+      through your agents or retailers) of that edition to the public.
+    </para>
+    <para>
+      It is requested, but not required, that you contact the authors of the
+      Document well before redistributing any large number of copies, to give
+      them a chance to provide you with an updated version of the
+      Document.
+    </para>
+  </section>
+  <section id="Modifications" label="4. ">
+    <title>MODIFICATIONS</title>
+    <para>
+      You may copy and distribute a Modified Version of the Document under the
+      conditions of sections 2 and 3 above, provided that you release the
+      Modified Version under precisely this License, with the Modified Version
+      filling the role of the Document, thus licensing distribution and
+      modification of the Modified Version to whoever possesses a copy of it.
+      In addition, you must do these things in the Modified Version:
+    </para>
+    <orderedlist numeration="upperalpha">
+      <listitem>
+  <simpara>
+    Use in the Title Page (and on the covers, if any) a title distinct
+    from that of the Document, and from those of previous versions (which
+    should, if there were any, be listed in the History section of the
+    Document).  You may use the same title as a previous version if the
+    original publisher of that version gives permission.
+  </simpara>
+      </listitem>
+      <listitem>
+  <simpara>
+    List on the Title Page, as authors, one or more persons or entities
+    responsible for authorship of the modifications in the Modified
+    Version, together with at least five of the principal authors of the
+    Document (all of its principal authors, if it has fewer than five),
+    unless they release you from this requirement.
+  </simpara>
+      </listitem>
+      <listitem>
+  <simpara>
+    State on the Title page the name of the publisher of the Modified
+    Version, as the publisher.
+  </simpara>
+      </listitem>
+      <listitem>
+  <simpara>
+    Preserve all the copyright notices of the Document.
+  </simpara>
+      </listitem>
+      <listitem>
+  <simpara>
+    Add an appropriate copyright notice for your modifications adjacent to
+    the other copyright notices.
+  </simpara>
+      </listitem>
+      <listitem>
+  <simpara>
+    Include, immediately after the copyright notices, a license notice
+    giving the public permission to use the Modified Version under the
+    terms of this License, in the form shown in the Addendum below.
+  </simpara>
+      </listitem>
+      <listitem>
+  <simpara>
+    Preserve in that license notice the full lists of Invariant Sections
+    and required Cover Texts given in the Document's license notice.
+  </simpara>
+      </listitem>
+      <listitem>
+  <simpara>
+    Include an unaltered copy of this License.
+  </simpara>
+      </listitem>
+      <listitem>
+  <simpara>
+    Preserve the section Entitled "History", Preserve its Title, and add
+    to it an item stating at least the title, year, new authors, and
+    publisher of the Modified Version as given on the Title Page.  If
+    there is no section Entitled "History" in the Document, create one
+    stating the title, year, authors, and publisher of the Document as
+    given on its Title Page, then add an item describing the Modified
+    Version as stated in the previous sentence.
+  </simpara>
+      </listitem>
+      <listitem>
+  <simpara>
+    Preserve the network location, if any, given in the Document for
+    public access to a Transparent copy of the Document, and likewise the
+    network locations given in the Document for previous versions it was
+    based on.  These may be placed in the "History" section.  You may omit
+    a network location for a work that was published at least four years
+    before the Document itself, or if the original publisher of the
+    version it refers to gives permission.
+  </simpara>
+      </listitem>
+      <listitem>
+  <simpara>
+    For any section Entitled "Acknowledgements" or "Dedications", Preserve
+    the Title of the section, and preserve in the section all the
+    substance and tone of each of the contributor acknowledgements and/or
+    dedications given therein.
+  </simpara>
+      </listitem>
+      <listitem>
+  <simpara>
+    Preserve all the Invariant Sections of the Document, unaltered in
+    their text and in their titles.  Section numbers or the equivalent are
+    not considered part of the section titles.
+  </simpara>
+      </listitem>
+      <listitem>
+  <simpara>
+    Delete any section Entitled "Endorsements".  Such a section may not be
+    included in the Modified Version.
+  </simpara>
+      </listitem>
+      <listitem>
+  <simpara>
+    Do not retitle any existing section to be Entitled "Endorsements" or
+    to conflict in title with any Invariant Section.
+  </simpara>
+      </listitem>
+      <listitem>
+  <simpara>
+    Preserve any Warranty Disclaimers.
+  </simpara>
+      </listitem>
+    </orderedlist>
+    <para>
+      If the Modified Version includes new front-matter sections or appendices
+      that qualify as Secondary Sections and contain no material copied from the
+      Document, you may at your option designate some or all of these sections
+      as invariant.  To do this, add their titles to the list of Invariant
+      Sections in the Modified Version's license notice.  These titles must be
+      distinct from any other section titles.
+    </para>
+    <para>
+      You may add a section Entitled "Endorsements", provided it contains
+      nothing but endorsements of your Modified Version by various parties--for
+      example, statements of peer review or that the text has been approved by
+      an organization as the authoritative definition of a standard.
+    </para>
+    <para>
+      You may add a passage of up to five words as a Front-Cover Text, and a
+      passage of up to 25 words as a Back-Cover Text, to the end of the list of
+      Cover Texts in the Modified Version.  Only one passage of Front-Cover Text
+      and one of Back-Cover Text may be added by (or through arrangements made
+      by) any one entity.  If the Document already includes a cover text for the
+      same cover, previously added by you or by arrangement made by the same
+      entity you are acting on behalf of, you may not add another; but you may
+      replace the old one, on explicit permission from the previous publisher
+      that added the old one.
+    </para>
+    <para>
+      The author(s) and publisher(s) of the Document do not by this License give
+      permission to use their names for publicity for or to assert or imply
+      endorsement of any Modified Version.
+    </para>
+  </section>
+  <section id="Combining" label="5. ">
+    <title>COMBINING DOCUMENTS</title>
+    <para>
+      You may combine the Document with other documents released under this
+      License, under the terms defined in section 4 above for modified versions,
+      provided that you include in the combination all of the Invariant Sections
+      of all of the original documents, unmodified, and list them all as
+      Invariant Sections of your combined work in its license notice, and that
+      you preserve all their Warranty Disclaimers.
+    </para>
+    <para>
+      The combined work need only contain one copy of this License, and multiple
+      identical Invariant Sections may be replaced with a single copy.  If there
+      are multiple Invariant Sections with the same name but different contents,
+      make the title of each such section unique by adding at the end of it, in
+      parentheses, the name of the original author or publisher of that section
+      if known, or else a unique number.  Make the same adjustment to the
+      section titles in the list of Invariant Sections in the license notice of
+      the combined work.
+    </para>
+    <para>
+      In the combination, you must combine any sections Entitled "History" in
+      the various original documents, forming one section Entitled "History";
+      likewise combine any sections Entitled "Acknowledgements", and any
+      sections Entitled "Dedications".  You must delete all sections Entitled
+      "Endorsements".
+    </para>
+  </section>
+  <section id="Collections" label="6. ">
+    <title>COLLECTIONS OF DOCUMENTS</title>
+    <para>
+      You may make a collection consisting of the Document and other documents
+      released under this License, and replace the individual copies of this
+      License in the various documents with a single copy that is included in
+      the collection, provided that you follow the rules of this License for
+      verbatim copying of each of the documents in all other respects.
+    </para>
+    <para>
+      You may extract a single document from such a collection, and distribute
+      it individually under this License, provided you insert a copy of this
+      License into the extracted document, and follow this License in all other
+      respects regarding verbatim copying of that document.
+    </para>
+  </section>
+  <section id="Aggregation" label="7. ">
+    <title>AGGREGATION WITH INDEPENDENT WORKS</title>
+    <para>
+      A compilation of the Document or its derivatives with other separate and
+      independent documents or works, in or on a volume of a storage or
+      distribution medium, is called an "aggregate" if the copyright resulting
+      from the compilation is not used to limit the legal rights of the
+      compilation's users beyond what the individual works permit.  When the
+      Document is included in an aggregate, this License does not apply to the
+      other works in the aggregate which are not themselves derivative works of
+      the Document.
+    </para>
+    <para>
+      If the Cover Text requirement of section 3 is applicable to these copies
+      of the Document, then if the Document is less than one half of the entire
+      aggregate, the Document's Cover Texts may be placed on covers that bracket
+      the Document within the aggregate, or the electronic equivalent of covers
+      if the Document is in electronic form.  Otherwise they must appear on
+      printed covers that bracket the whole aggregate.
+    </para>
+  </section>
+  <section id="Translation" label="8. ">
+    <title>TRANSLATION</title>
+    <para>
+      Translation is considered a kind of modification, so you may distribute
+      translations of the Document under the terms of section 4.  Replacing
+      Invariant Sections with translations requires special permission from
+      their copyright holders, but you may include translations of some or all
+      Invariant Sections in addition to the original versions of these Invariant
+      Sections.  You may include a translation of this License, and all the
+      license notices in the Document, and any Warranty Disclaimers, provided
+      that you also include the original English version of this License and the
+      original versions of those notices and disclaimers.  In case of a
+      disagreement between the translation and the original version of this
+      License or a notice or disclaimer, the original version will prevail.
+    </para>
+    <para>
+      If a section in the Document is Entitled "Acknowledgements",
+      "Dedications", or "History", the requirement (section 4) to Preserve its
+      Title (section 1) will typically require changing the actual title.
+    </para>
+  </section>
+  <section id="Termination" label="9. ">
+    <title>TERMINATION</title>
+    <para>
+      You may not copy, modify, sublicense, or distribute the Document except as
+      expressly provided for under this License.  Any other attempt to copy,
+      modify, sublicense or distribute the Document is void, and will
+      automatically terminate your rights under this License.  However, parties
+      who have received copies, or rights, from you under this License will not
+      have their licenses terminated so long as such parties remain in full
+      compliance.
+    </para>
+  </section>
+  <section id="FutureRevisions" label="10. ">
+    <title>FUTURE REVISIONS OF THIS LICENSE</title>
+    <para>
+      The Free Software Foundation may publish new, revised versions of the GNU
+      Free Documentation License from time to time.  Such new versions will be
+      similar in spirit to the present version, but may differ in detail to
+      address new problems or concerns.  See <ulink
+      url="http://www.gnu.org/copyleft/">http://www.gnu.org/copyleft/</ulink>.
+    </para>
+    <para>
+      Each version of the License is given a distinguishing version number.  If
+      the Document specifies that a particular numbered version of this License
+      "or any later version" applies to it, you have the option of following the
+      terms and conditions either of that specified version or of any later
+      version that has been published (not as a draft) by the Free Software
+      Foundation.  If the Document does not specify a version number of this
+      License, you may choose any version ever published (not as a draft) by the
+      Free Software Foundation.
+    </para>
+  </section>
+  <section id="HowToUse" label="ADDENDUM: ">
+    <title>How to use this License for your documents</title>
+
+    <para>
+      To use this License in a document you have written, include a copy of the
+      License in the document and put the following copyright and license
+      notices just after the title page:
+    </para>
+    <blockquote>
+      <para>
+  Copyright &copy; YEAR YOUR NAME.
+      </para>
+      <para>
+  Permission is granted to copy, distribute and/or modify this document
+  under the terms of the GNU Free Documentation License, Version 1.2 or
+  any later version published by the Free Software Foundation; with no
+  Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts.  A
+  copy of the license is included in the section entitled "GNU Free
+  Documentation License".
+      </para>
+    </blockquote>
+    <para>
+      If you have Invariant Sections, Front-Cover Texts and Back-Cover Texts,
+      replace the "with...Texts." line with this:
+    </para>
+    <blockquote>
+      <para>
+  with the Invariant Sections being LIST THEIR TITLES, with the
+  Front-Cover Texts being LIST, and with the Back-Cover Texts being LIST.
+      </para>
+    </blockquote>
+    <para>
+      If you have Invariant Sections without Cover Texts, or some other
+      combination of the three, merge those two alternatives to suit the
+      situation.
+    </para>
+    <para>
+      If your document contains nontrivial examples of program code, we
+      recommend releasing these examples in parallel under your choice of free
+      software license, such as the GNU General Public License, to permit their
+      use in free software.
+    </para>
+  </section>
+</appendix>