rsence 2.1.11 → 2.2.0

data/INSTALL.rdoc

@@ -25,12 +25,12 @@ This is a list of system level dependencies. You only need to do this step once;
 
 === Mac OS X
 
-==== Mac OS X 10.6
+==== Mac OS X 10.6 "Snow Leopard" and 10.7 "Lion"
 
 * Install *XCode*[http://developer.apple.com/mac/] to get the essential development tools, like compilers.
 * Proceed to section 3.0
 
-==== Mac OS X 10.4 and 10.5
+==== Mac OS X 10.4 "Tiger" and 10.5 "Leopard"
 
 This step applies only to Mac OS X 10.4 "Tiger" and 10.5 "Leopard". The default ruby build of these versions of Mac OS X is somewhat broken.
 
@@ -120,6 +120,8 @@ This not only enables SessionStorage (persistent sessions between RSence restart
 * *rake*[http://rake.rubyforge.org]
   * Ruby build tool
   * Not necessarily required via ruby gems, if installed via a system-level package
+* *coffee-script*[https://github.com/josh/ruby-coffee-script]
+  * Ruby library for .coffee -> .js compliation
 * *rack*[http://rack.rubyforge.org]
   * Abstract ruby web server interface
   * A rack handler is also required. One of the following is suggested:
@@ -130,7 +132,7 @@ This not only enables SessionStorage (persistent sessions between RSence restart
 * *json*[http://flori.github.com/json]:: Library for bi-directional JSON[http://json.org] conversion.
 * *yaml*[http://yaml4r.sourceforge.net/doc]:: Library for handling YAML[http://www.yaml.org] files
 * *randgen*:: C-optimized random string generator developed for RSence specifically
-* *jsmin_c*:: C-optimized Javascript whitespace removal library; Ruby wrapper developed for RSence specifically; based on the original JSMin[http://www.crockford.com/javascript/jsmin.html]
+* *jsminc*:: C-optimized Javascript whitespace removal library; Ryan Fitzgerald's Ruby wrapper for Douglas Crockford's jsmin.c
 * *jscompress*:: C-optimized Javascript compression and obfuscation library developed for RSence specifically
 * *html_min*:: C-optimized HTML whitespace removal library developed for RSence specifically
 * *cssmin*:: CSS whitespace removal library

data/README.rdoc

@@ -1,21 +1,30 @@
 
-= RSence-2.1.0[http://rsence.org/]
+= RSence-2.2.0[http://rsence.org/]
 
 == Introduction
 
-RSence is a RIA framework designed for responsive GUI applications on the web; it's implemented as a hybrid Ruby - Javascript system. The server is written in Ruby and C. Applications are installed as plugin bundles. The GUI framework is written in Javascript; it doesn't strictly require the server, but has extensive transport support with automatic data synchronization with the server. User interfaces are usually described in structured view trees represented by YAML data structures, which are automatically converted for rendering in the client. 
+RSence is a different and unique development model and software frameworks designed first-hand for real-time web applications. RSence consists of separate, but tigtly integrated data- and user interface frameworks.
 
-Javascript knowledge is required only when creating custom client-driven functionality; basic understanding of the YAML GUITree structures is enough in most cases. Likewise, no prior Ruby knowledge is needed if you want to create stand-alone Javascript applications. Javascript component themes are easily created with just basic web designer skills. Data API's are easy to link no matter what language is used to create them. Skills in your organization are easily combined for various parts of larger applications.
+RSence could be classified as a thin server - thick client system.
 
-RSence is not primarily targeted as an engine for plain old html web sites, there are plenty of other tools for that purpose and RSence is easily integrated with them in various ways.
+Applications and submobules are installed as indepenent plugin bundles into the plugins folder of a RSence environment, which in itself is a self-contained bundle. A big part of RSence itself is implemented as shared plugin bundles.
 
+The user interface framework of RSence is implemented in high-level user interface widget classes. The widget classes share a common foundation API and access the browser's native API's using an abstracted event- and element layer, which provides exceptional cross-browser compatibility.
 
-== Installing
-Just run this command in the shell, if you have ruby installed. Otherwise, read the {file:INSTALL Install Guide} for full installation instructions.
+The data framework of RSence is a event-driven system, which synchronized shared values between the client and server. It's like a realtime bidirectional form-submission engine that handles data changes intelligently. On the client, changed values trigger events on user interface widgets. On the server, changed values trigger events on value responder methods of server plugin modules. It doesn't matter if the change originates on client or server, it's all synchronized and propagated automatically.
+
+The server framework is implemented as a high-level, modular data-event-driven system, which handles delegation of tasks impossible to implement using a client-only approach.
+Client sessions are selectively connected to other client sessions and legacy back-ends via the server by using the data framework.
+
+The client is written in Javascript and the server is written in Ruby. The client also supports CoffeeScript for custom logic. In many cases, no custom client logic is needed; the user interfaces can be defined in tree-like data models. By default, the models are parsed from YAML files, and other structured data formats are possible, including XML, JSON, databases or any custom logic capable of producing similar objects. The server can connect to custom environments and legacy backends accessible on the server, including software written in other languages.
+
+
+== Installing RSence
+Just run this command in the shell, if you have functioning ruby environment installed. Otherwise, read the {file:INSTALL Install Guide} for full installation instructions.
  gem install rsence
 
 
-== Initializing a new project
+== Initializing a new RSence environment
 
 The +init+ command will create a directory called `env_dir` in this example. It asks a few questions about the environment. Use a path and project name that matches your purposes.
  rsence init /home/me/rsence_projects/env_dir
@@ -89,26 +98,18 @@ For more detailed installation and usage instructions, read the {file:INSTALL In
 
 === The bleeding edge (for developers)
 RSence comes in two varieties:
-1. rsence : The stable (no major new features, just bug fixes) release.
-2. rsence-pre : The active development snapshot released periodically.
-
-Both varieties can be installed simultaneously and it's suggested to use
-the stable "rsence" package for production installations and to use the
-"rsence-pre" package for development purposes, because the RSence crew
-can't possibly test each and every application available. It's your 
-responsibility as a developer to report any RSence issues effecting your
-software. The sooner reported, the better; it ensures better release 
-versions.
+1. rsence : The stable release intended for running in production environments.
+2. rsence-pre : The active development snapshot intended for develoment environments. Runtime-wise, it's nearly as stable as the stable version, but features are constantly added and sometimes changed.
 
-To use "rsence-pre", install the "rsence-pre" gem and use the "rsence-pre" 
-command instead of the "rsence" command.
+To use "rsence-pre", install the "rsence-pre" gem and use the "rsence-pre" instead of "rsence" command-line tool.
 
 === Licensing and commercial support options
 * {file:LICENSE.txt *GPL*} version 3 by default.
 * Riassence[http://riassence.com/] Inc. provides commercial support, custom licensing arrangements and various other services.
 
 === Community support
-* http://rsence.org
-* IRC channel +#rsence+ on the IRCNet and FreeNode networks
-
+* http://rsence.org/
+* IRC channel +#rsence+ on the FreeNode IRC network
 
+=== Keywords:
+HTML5 Javascript CoffeeScript Ruby RIA Server Client Data-Driven Event-Driven Web Framework

data/VERSION

@@ -1 +1 @@
-2.1.11
+2.2.0

data/conf/default_conf.yaml

@@ -26,6 +26,12 @@
     #
     # A list of javascript dependencies to include in the html
     :deps: [ ]
+    #
+    # Boot library:
+    :boot_lib: rsence
+    #
+    # Default additional libraries to use:
+    :default_libs: []
   #
   # The settings for the main plugin
   :main_plugin:
@@ -36,6 +42,27 @@
     # how many milliseconds to wait before doing an idle poll
     :server_poll_interval: 2000 # 2 seconds
   #
+  # The settings for the daemon
+  :daemon:
+    #
+    # How long to wait before binding the broker to the
+    # HTTP address and port after starting the Transporter.
+    # A value of -1 disables the broker completely.
+    # Before waiting, the daemon starts all subsystems except the
+    # http handling front-end (Broker).
+    # Useful in situations where RSence itself configures the
+    # network interfaces or the interfaces become available after
+    # RSence is started.
+    :http_delayed_start: 0
+    #
+    # Save plugin and session state every n seconds.
+    # Set to 0 or negative to disable.
+    :autosave_interval: 180 # once every 3 minutes
+    #
+    # Daemon helper files, leave empty for defaults.
+    #:pid_fn: /var/run/rsence.pid
+    #:log_fn: /var/log/rsence.log
+  #
   # Switches on debug-mode:
   #  - Generates more output
   #  - Each time /hello is post-requested:
@@ -54,7 +81,7 @@
     :port:  8001
     #
     # Bind this ip address ('0.0.0.0' means all)
-    :bind_address:  '0.0.0.0'
+    :bind_address:  '127.0.0.1'
     #
     # Rack handler to use, defaults to thin
     :rack_require: mongrel
@@ -83,7 +110,7 @@
     :client_poll_priority: 60
     #
     # Reload the client after any plugins are reloaded:
-    :client_autoreload: false
+    :client_autoreload: true
   #
   #
   # Session-related settings
@@ -127,10 +154,6 @@
     # Defaults to false, will be the default in a future version.
     :clone_cookie_sessions: true
     #
-    # This limits the amount of cloned targets of a source session.
-    # NOTE: This has no effect yet, the code is not implemented.
-    :max_cloned_sessions: 10
-    #
     # This option overrides the default session timeout.
     # Don't set this to less than the expected poll interval,
     # otherwise the session might expire before the previous
@@ -161,12 +184,6 @@
     # Disposable keys, when enabled, changes the value id on each session restoration
     :disposable_keys:   true
   #
-  # Daemon helper files, leave empty for defaults.
-  :daemon: {
-    #:pid_fn: /var/run/rsence.pid
-    #:log_fn: /var/log/rsence.log
-  }
-  #
   # Entered by code, empty container
   :broker_urls: { }
 
@@ -178,13 +195,7 @@
 
     # Source directories to scan
     :src_dirs: []
-
-      # RSence Client Framework
-      #- js
-
-      # How to include your own custom js package directory:
-      # - /home/me/code/extra_components
-
+    
     # List of theme names to include and pack
     :theme_names:
       - default  # Makes default_theme.js containing css and html templates
@@ -195,23 +206,25 @@
 
       # The core package, loaded by default using a script tag in index_html
       core:
-  
+        
         # RSence.*
         - rsence_ns
-  
+        
+        - locale_settings    # HLocaleSettings
+        
         # RSence.Core
         - class             # HClass
         - elem              # ELEM
         - event             # Event
-  
+        
         # RSence.Util
         - sha               # SHA
-  
+        
         # RSence.Foundation
         - system            # HSystem
         - valueresponder    # HValueResponder
         - application       # HApplication
-  
+        
         # COMM
         - comm              # COMM
         - queue             # COMM.Queue
@@ -237,6 +250,7 @@
         - eventmanager      # EVENT
         - controldefaults   # HControlDefaults
         - control           # HControl
+        - valueaction       # HValueAction
         - dyncontrol        # HDynControl
         - centerview        # HCenterView
         - scrollview        # HScrollView
@@ -251,6 +265,7 @@
         - textcontrol       # HTextControl
         - passwordcontrol   # HPasswordControl
         - textarea          # HTextArea
+        - searchfield       # HSearchField
         - uploader          # HUploader
         - slider            # HSlider
         - vslider           # HVSlider
@@ -279,6 +294,7 @@
       datetime:
         - datetimevalue       # HDateTime
         - calendar            # HCalendar
+        - datetimepicker      # HDateTimePicker
         - timesheet           # HTimeSheet
         - timesheet_item      # HTimeSheetItem
         - timesheet_item_edit # HTimeSheetItemEditor
@@ -294,15 +310,38 @@
         - propertylisteditor  # HPropertyEditor
         - minimenu            # HMiniMenu
         - minimenuitem        # HMiniMenuItem
+        - popupmenu           # HPopupMenu
+        - menuitem            # HMenuItem
+      
+      tables:
+        - table               # HTable
 
-    # Special packages that include other packages (not used currently)
+      # Graphics related control widgets (components)
+      # These are not complete and there will probably never be any
+      # serious efforts to support legacy browsers, like old IE versions,
+      # unless someone is interested in sponsoring such efforts.
+      graphics:
+        - svgcontrol
+    
+    # Special packages that include other packages
     :compound_packages:
-      allinone:
+      rsence:
         - core
         - default_theme
         - controls
         - lists
         - datetime
+        - tables
+        - graphics
+        - servermessage
+      std_widgets:
+        - default_theme
+        - controls
+        - lists
+        - datetime
+        - tables
+        - graphics
+        - servermessage
 
     # List of variables and other names beginning
     # with a underscore that should not be obfuscated
@@ -325,9 +364,6 @@
       - .svg
       - .pdf
 
-    # The name of the include file
-    :js_inc: js.inc
-
     # If disabled, makes packages out of single source bundles automatically
     :dont_pack_undefined: true
 

data/conf/rsence_command_strings.yaml

@@ -4,17 +4,17 @@
     Invalid option for <%%= option_name.to_s %>:
       Expected number, got: <%%= arg.inspect %>.
     
-    Type 'rsence help <%%= @cmd.to_s %>' for usage.
+    Type ”rsence help <%%= @cmd.to_s %>” for usage.
   :no_such_configuration_file: |+
     No such configuration file:
       <%%= arg.inspect %>
     
-    Type 'rsence help <%%= @cmd.to_s %>' for usage.
+    Type ”rsence help <%%= @cmd.to_s %>” for usage.
   :no_value_for_option: |+
     No value for option:
       <%%= option_name.to_s.inspect %>
     
-    Type 'rsence help <%%= @cmd.to_s %> for usage."
+    Type ”rsence help <%%= @cmd.to_s %>” for usage.
   :no_such_directory: |
     No such directory:
       <%%= path.inspect %>
@@ -45,32 +45,34 @@
   :invalid_environment: |
     Invalid environment: <%%= env_path.inspect %>
     
-    Type 'rsence help <%%= @cmd.to_s %>' for usage."
-    Type 'rsence help init' for environment initialization usage."
+    Type ”rsence help <%%= @cmd.to_s %>” for usage.
+    Type ”rsence help init” for environment initialization usage.
   :invalid_option_chr: |
     Invalid option character for option character block <%%= arg.inspect %>:
       <%%= chr.inspect %>
     
-    Type 'rsence help <%%= @cmd.to_s %>' for usage."
+    Type ”rsence help <%%= @cmd.to_s %>” for usage.
   :invalid_option: |
     Invalid option:
       <%%= arg.inspect %>.
     
-    Type 'rsence help <%%= @cmd.to_s %>' for usage."
+    Type ”rsence help <%%= @cmd.to_s %>” for usage.
   :no_pid: |
     No PID, unable to check process status.
   :no_pid_file: |
     No PID file, unable to check process status.
   :no_pid_support: |
     No PID support, unable to check process status.
+  :something_responds:
+    Something responds on <%%= addr_descr %>
   :no_process_running_but_something_responds: |
-    No process running, but something responds on <%%= addr %>:<%%= port %>.
+    No process running, but something responds on <%%= addr_descr %>.
   :no_process_running_and_nothing_responds: |
-    No process running, and nothing responds on <%%= addr %>:<%%= port %>.
+    No process running, and nothing responds on <%%= addr_descr %>.
   :process_running_and_responds: |
-    Process ID <%%= pid %> is running and responds on <%%= addr %>:<%%= port %>.
+    Process ID <%%= pid %> is running and responds on <%%= addr_descr %>.
   :process_running_but_nothing_responds: |
-    Process ID <%%= pid %> is running, but does not respond on <%%= addr %>:<%%= port %>.
+    Process ID <%%= pid %> is running, but does not respond on <%%= addr_descr %>.
   :saving_message: <
     Saving session data...
   :no_pid_unable_to_save: |
@@ -79,12 +81,18 @@
     No process running.
   :session_data_saved: |
     Session data saved.
+
 # Strings for the init command
 :initenv:
+  :continue_question: "Do you want to continue, "
   :env_already_initialized: |
     Environment already initialized.
+  :env_not_clear: |
+    Environment directory <%%= @args[:env_path] %> is not empty,
+    and appears to be an RSence environment.
   :env_not_empty: |
-    Environment directory <%%= @args[:env_path] %> is not empty.
+    Environment directory <%%= @args[:env_path] %> is not empty,
+    but does not appear to be an RSence environment.
   :creating_env: |+
     
     Creating a new RSence environment at <%%= @args[:env_path] %>
@@ -111,7 +119,7 @@
     
     
      Please specify the connection string for the session database to use.
-     By default, a local SQLite database is created in the 'db' subdirectory
+     By default, a local SQLite database is created in the ”db” subdirectory
      of the environment directory. Any database supported by Sequel is supported
      by RSence.
     
@@ -171,16 +179,16 @@
     
   :confirm_config: "Is the configuration correct, "
   :creating_dirs: "Creating directories..."
-  :install_welcome: "Do you want to install the 'welcome' plugin as a starting point, "
+  :install_welcome: "Do you want to install the ”welcome” plugin as a starting point, "
   :installing_welcome_plugin: |+
       Installing the welcome plugin. To remove it, just delete this folder:
         <%%= welcome_plugin_dst %>
   :creating_files: "Creating files..."
   :congratulations: |+
     
-    <%= '-='*39 %>-
+    <%= ('-='*39)+'-' %>
     
-    RSence project environment for '<%%= config[:index_html][:title] %>' created.
+    RSence project environment for <%%= config[:index_html][:title] %> created.
     
     You may configure the environment by editing the file:
     
@@ -203,26 +211,26 @@
     Congratulations!
     
   :readme: |
-    This directory contains a RSence environment titled '<%%= config[:index_html][:title] %>'.
+    This directory contains a RSence environment titled <%%= config[:index_html][:title] %>.
     Visit http://rsence.org/ for further information.
-# Help for the 'rsence' command line tool.
+# Help for the ”rsence” command line tool.
 :help:
   :head: |+
-    RSence command-line tool, version <%= @@version %>
+    RSence command-line tool, version <%= @version %>
   
   :tail: |+
-    RSence is a self-contained rich internet application client-server framework.
+    RSence is a self-contained web app framework.
     For further information, see http://rsence.org/
   :unknown: >
     Unknown command: 
 
   :help_help: >
-    Type 'rsence help' for usage.
+    Type ”rsence help” for usage.
 
   :help_main: |+
     usage: rsence <command> [options] [args]
   
-    Type 'rsence help <command>' for help on a specific command.
+    Type ”rsence help <command>” for help on a specific command.
   
     Available commands:
        <%= help_avail_cmds %>
@@ -252,9 +260,9 @@
   
       --port <number>         The port number the http server listens to.
   
-      --addr <ip address>     The IP address or net mask the http server listens to.
-                              '0.0.0.0' matches all interfaces.
-                              '127.0.0.1' matches the local loopback interface.
+      --bind <ip address>     The IP address or net mask the http server listens to.
+                              ”0.0.0.0” matches all interfaces.
+                              ”127.0.0.1” matches the local loopback interface.
   
       --server <handler>      The Rack handler to use. Defaults to mongrel
   
@@ -269,31 +277,50 @@
       --latency <number>      Sleeps <number> amount of milliseconds on every
                               request. Useful for testing slow connections.
   
-      --say (-S)              Uses speech synthesis via the 'say' command to
+      --say (-S)              Uses speech synthesis via the ”say” command to
                               provide audible feedback, when --auto-update is
-                              enabled. Says 'Autobuild complete.',
-                              'Loaded [plugin name].', 'Unloaded [plugin name].',
-                              'Reloaded [plugin name].', 'Reloading plugins.' and
-                              'Plugins reloaded.'
+                              enabled. Says ”Autobuild complete.”,
+                              ”Loaded [plugin name].”, ”Unloaded [plugin name].”,
+                              ”Reloaded [plugin name].”, ”Reloading plugins.” and
+                              ”Plugins reloaded.”
                               Only available on Mac OS X and other systems with a
-                              'say' command installed.
+                              ”say” command installed.
+  
+      --delayed-start <secs>  Waits for <secs> of seconds before starting
+                              the HTTP Broker after starting the Transporter.
+                              
+                              A value of -1 disables the broker completely.
+                              Before waiting, the daemon starts all subsystems except the
+                              http handling front-end (Broker).
+                              Useful in situations where RSence itself configures the
+                              network interfaces or the interfaces become available after
+                              RSence is started.
+      
+      --disable-gzip          Disables client resource GZIP compression for every browser.
+
+      --disable-obfuscation   Disables client resource compression (obfuscation).
+
+      --disable-jsmin         Does not strip whitespace from client resources (jsmin).
+
+      --build-report          Outputs verbose client resource actions.
+
   
   :initenv: |+
-    Alias name of the 'init' command.
+    Alias name of the ”init” command.
     
     See: rsence help init
   
   :initialize: |+
-    Alias name of the 'init' command.
+    Alias name of the ”init” command.
     
     See: rsence help init
   
   :init: |+
-    usage: 'rsence init [options] [PATH]'
+    usage: ”rsence init [options] [PATH]”
   
-    The 'init' command creates a new RSence environment. 
+    The ”init” command creates a new RSence environment. 
   
-    The expected structure of a project environment (where 'project_directory'
+    The expected structure of a project environment (where ”project_directory”
     is the directory of your project) is:
   
      [d]  project_name       :  The name of your project.
@@ -306,7 +333,7 @@
        [f]  README           :  Description of the environment directory.
        [f]  VERSION          :  RSence version the environment was created with
   
-    The 'config.yaml' file contains patches specific to your project.
+    The ”config.yaml” file contains patches specific to your project.
   
     The configuration files are loaded and applied in this order:
       1:  [rsence_install_path]/conf/default_conf.yaml
@@ -324,8 +351,8 @@
       --port <number>         The port number the http server listens to.
   
       --addr <ip address>     The IP address or net mask the http server listens to.
-                              '0.0.0.0' matches all interfaces.
-                              '127.0.0.1' matches the local loopback interface.
+                              ”0.0.0.0” matches all interfaces.
+                              ”127.0.0.1” matches the local loopback interface.
                               Defaults to 0.0.0.0
   
       --server <handler>      The Rack handler to use. Defaults to mongrel
@@ -335,55 +362,55 @@
       --database <conn_str>   Use the Sequel connection string to configure the
                               default session database.
   
-      --uri-prefix <path>     Configure RSence to use this http "directory" as
+      --uri-prefix <path>     Configure RSence to use this http ”directory” as
                               the prefix. It defaults to the root directory: /
   
-      --blank                 Doesn't install the Welcome -plugin.
+      --blank                 Doesn’t install the Welcome -plugin.
   
-      --non-interactive (-q)  Doesn't ask anything, just creates the environment
+      --non-interactive (-q)  Doesn’t ask anything, just creates the environment
                               with the options supplied.
                             
     For further configuration, edit the config.yaml file.
   
   :run: |+
-    usage: 'rsence run [options] [PATH]'
+    usage: ”rsence run [options] [PATH]”
   
-    The 'run' command starts RSence in foreground (no daemon). Exit with CTRL-C.
+    The ”run” command starts RSence in foreground (no daemon). Exit with CTRL-C.
   
   :start: |+
-    usage: 'rsence start [options] [PATH]'
+    usage: ”rsence start [options] [PATH]”
   
-    The 'start' command starts RSence in the background (as a daemon).
+    The ”start” command starts RSence in the background (as a daemon).
   
-    Use the 'stop' command to stop RSence.
+    Use the ”stop” command to stop RSence.
   
-    Use the 'restart' command to restart RSence in the background.
+    Use the ”restart” command to restart RSence in the background.
   
-    Use the 'status' command to see if RSence is running.
+    Use the ”status” command to see if RSence is running.
   
   :stop: |+
-    usage: 'rsence stop [options] [PATH]'
+    usage: ”rsence stop [options] [PATH]”
   
-    The 'stop' command stops RSence running in the background (as a daemon).
+    The ”stop” command stops RSence running in the background (as a daemon).
   
-    Use the 'status' command to see if RSence is running.
+    Use the ”status” command to see if RSence is running.
   
   :restart: |+
-    usage: 'rsence restart [options] [PATH]'
+    usage: ”rsence restart [options] [PATH]”
   
-    The 'restart' command restarts RSence in the background (as a daemon).
-    If RSence wasn't running before the 'restart' command was issued, the
-    effect is the same as 'start'.
+    The ”restart” command restarts RSence in the background (as a daemon).
+    If RSence wasn’t running before the ”restart” command was issued, the
+    effect is the same as ”start”.
   
-    Use the 'stop' command to stop RSence.
+    Use the ”stop” command to stop RSence.
   
-    Use the 'status' command to see if RSence is running.
+    Use the ”status” command to see if RSence is running.
   
   :status: |+
-    usage: 'rsence status [options] [PATH]'
+    usage: ”rsence status [options] [PATH]”
   
-    The 'status' command checks if RSence is running.
-    If started with the 'start', 'run' or 'restart' command, a PID file is written.
+    The ”status” command checks if RSence is running.
+    If started with the ”start”, ”run” or ”restart” command, a PID file is written.
     Status checks if the PID file exists, if the RSence process responds and if
     the configured TCP port responds in the configured IP address.
   
@@ -403,9 +430,9 @@
       --addr <ip address>     The IP address or net mask the http server listens to.
   
   :save: |+
-    usage: 'rsence save [options] [PATH]'
+    usage: ”rsence save [options] [PATH]”
   
-    The 'save' command signals the RSence process to tell the plugins to save their
+    The ”save” command signals the RSence process to tell the plugins to save their
     data and the session manager to save its session database.
   
     Available options:
@@ -420,9 +447,9 @@
       --verbose (-v)          More verbose output. Also enabled by --debug
   
   :version: |+
-    usage: 'rsence version'
+    usage: ”rsence version”
     
-    The 'version' command simply outputs the version number of RSence.
+    The ”version” command simply outputs the version number of RSence.
     
     RSence follows the common three-numbered sequence-based version identification
     scheme. The scheme is defined like: major.minor[.maintenance]
@@ -431,7 +458,7 @@
     backwards compatibility with software written for previous versions.
     
     The minor number designates minor changes in functionality, like minor or
-    moderate changes in functionality that usually don't impact backwards
+    moderate changes in functionality that usually don’t impact backwards
     compatibilty of software written for a previous release with the same major
     version.
     
@@ -442,14 +469,17 @@
     requires an unique version for each gem released, so pre-releases usually
     occupy the first package numbers of any release.
     
-    RSence also comes in a '-pre' variety. Consider RSence prereleases as
-    anything between 'Alpha', 'Beta' and 'Release Candidate'. The prereleases
+    RSence also comes in a ”-pre” variety. Consider RSence prereleases as
+    anything between ”Alpha”, ”Beta” and ”Release Candidate”. The prereleases
     are have a fourth number in their version number string. That number
-    is the 'package' or 'build' number.
+    is the ”package” or ”build” number.
     
     Version number conventions in written text should include both major and
-    minor version numbers prefixed with 'RSence'. The maintennance number
+    minor version numbers prefixed with ”RSence”. The maintennance number
     is usally not mentioned unless an issue is fix or such is discussed.
     
-    Example: "RSence 2.0 has undergone some major refactoring since 1.2.1"
+    Examples:
+      • ”RSence 2.0 is not fully backwards compatible with 1.2.1”
+      • ”RSence 2.1.4 has bugs fixed that were still present in 2.1.3”
+      • ”RSence 2.2 has major new features compared to 2.0 and 2.1”