Add documentation

Add some actual sphinx documentation.  This is basically the README
split up into sections.  Once this is actually published somewhere,
we can remove some of the content from the README and link to an
on-line reference instead.

Change-Id: I25e5ff842e94a5a05aa62c164952df93efc49e98

.gitignore

@@ -2,3 +2,4 @@
 *.egg*
 gertty-env
 .tox
+doc/build

README.rst

@@ -79,7 +79,7 @@ To install from a git checkout::
 Gertty uses a YAML based configuration file that it looks for at
 ``~/.gertty.yaml``.  Several sample configuration files are included.
 You can find them in the examples/ directory of the
-`source distribution <https://git.openstack.org/cgit/stackforge/gertty/tree/examples>`_
+`source distribution <https://git.openstack.org/cgit/openstack/gertty/tree/examples>`_
 or the share/gertty/examples directory after installation.
 
 Select one of the sample config files, copy it to ~/.gertty.yaml and
@@ -144,8 +144,7 @@ outstanding tasks that Gertty must perform in order to be fully up to
 date.  Some of these tasks are more complicated than others, and some
 of them will end up creating new tasks (for instance, one task may be
 to search for new changes in a project which will then produce 5 new
-tasks if there are 5 new changes).  This will explain why the number
+tasks if there are 5 new changes).
-of tasks displayed in the status bar sometimes changes rapidly.
 
 If Gertty is offline, it will so indicate in the status bar.  It will
 retry requests if needed, and will switch between offline and online
@@ -158,7 +157,7 @@ and mark the change as "held" so that you may re-inspect the change
 and any new comments before uploading the review.  The status bar will
 alert you to any held changes and direct you to a list of them (the
 `F12` key by default).  When viewing a change, the "held" flag may be
-toggeled with the exclamation key (`!`).  Once held, a change must be
+toggled with the exclamation key (`!`).  Once held, a change must be
 explicitly un-held in this manner for your review to be uploaded.
 
 If Gertty encounters an error, this will also be indicated in the

doc/Makefile

@@ -0,0 +1,177 @@
+# Makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line.
+SPHINXOPTS    =
+SPHINXBUILD   = sphinx-build
+PAPER         =
+BUILDDIR      = build
+
+# User-friendly check for sphinx-build
+ifeq ($(shell which $(SPHINXBUILD) >/dev/null 2>&1; echo $$?), 1)
+$(error The '$(SPHINXBUILD)' command was not found. Make sure you have Sphinx installed, then set the SPHINXBUILD environment variable to point to the full path of the '$(SPHINXBUILD)' executable. Alternatively you can add the directory with the executable to your PATH. If you don't have Sphinx installed, grab it from http://sphinx-doc.org/)
+endif
+
+# Internal variables.
+PAPEROPT_a4     = -D latex_paper_size=a4
+PAPEROPT_letter = -D latex_paper_size=letter
+ALLSPHINXOPTS   = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source
+# the i18n builder cannot share the environment and doctrees with the others
+I18NSPHINXOPTS  = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source
+
+.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest gettext
+
+help:
+	@echo "Please use \`make <target>' where <target> is one of"
+	@echo "  html       to make standalone HTML files"
+	@echo "  dirhtml    to make HTML files named index.html in directories"
+	@echo "  singlehtml to make a single large HTML file"
+	@echo "  pickle     to make pickle files"
+	@echo "  json       to make JSON files"
+	@echo "  htmlhelp   to make HTML files and a HTML help project"
+	@echo "  qthelp     to make HTML files and a qthelp project"
+	@echo "  devhelp    to make HTML files and a Devhelp project"
+	@echo "  epub       to make an epub"
+	@echo "  latex      to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
+	@echo "  latexpdf   to make LaTeX files and run them through pdflatex"
+	@echo "  latexpdfja to make LaTeX files and run them through platex/dvipdfmx"
+	@echo "  text       to make text files"
+	@echo "  man        to make manual pages"
+	@echo "  texinfo    to make Texinfo files"
+	@echo "  info       to make Texinfo files and run them through makeinfo"
+	@echo "  gettext    to make PO message catalogs"
+	@echo "  changes    to make an overview of all changed/added/deprecated items"
+	@echo "  xml        to make Docutils-native XML files"
+	@echo "  pseudoxml  to make pseudoxml-XML files for display purposes"
+	@echo "  linkcheck  to check all external links for integrity"
+	@echo "  doctest    to run all doctests embedded in the documentation (if enabled)"
+
+clean:
+	rm -rf $(BUILDDIR)/*
+
+html:
+	$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
+	@echo
+	@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
+
+dirhtml:
+	$(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
+	@echo
+	@echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
+
+singlehtml:
+	$(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml
+	@echo
+	@echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."
+
+pickle:
+	$(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
+	@echo
+	@echo "Build finished; now you can process the pickle files."
+
+json:
+	$(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
+	@echo
+	@echo "Build finished; now you can process the JSON files."
+
+htmlhelp:
+	$(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
+	@echo
+	@echo "Build finished; now you can run HTML Help Workshop with the" \
+	      ".hhp project file in $(BUILDDIR)/htmlhelp."
+
+qthelp:
+	$(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp
+	@echo
+	@echo "Build finished; now you can run "qcollectiongenerator" with the" \
+	      ".qhcp project file in $(BUILDDIR)/qthelp, like this:"
+	@echo "# qcollectiongenerator $(BUILDDIR)/qthelp/Gertty.qhcp"
+	@echo "To view the help file:"
+	@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/Gertty.qhc"
+
+devhelp:
+	$(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
+	@echo
+	@echo "Build finished."
+	@echo "To view the help file:"
+	@echo "# mkdir -p $$HOME/.local/share/devhelp/Gertty"
+	@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/Gertty"
+	@echo "# devhelp"
+
+epub:
+	$(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub
+	@echo
+	@echo "Build finished. The epub file is in $(BUILDDIR)/epub."
+
+latex:
+	$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
+	@echo
+	@echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
+	@echo "Run \`make' in that directory to run these through (pdf)latex" \
+	      "(use \`make latexpdf' here to do that automatically)."
+
+latexpdf:
+	$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
+	@echo "Running LaTeX files through pdflatex..."
+	$(MAKE) -C $(BUILDDIR)/latex all-pdf
+	@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
+
+latexpdfja:
+	$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
+	@echo "Running LaTeX files through platex and dvipdfmx..."
+	$(MAKE) -C $(BUILDDIR)/latex all-pdf-ja
+	@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
+
+text:
+	$(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text
+	@echo
+	@echo "Build finished. The text files are in $(BUILDDIR)/text."
+
+man:
+	$(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man
+	@echo
+	@echo "Build finished. The manual pages are in $(BUILDDIR)/man."
+
+texinfo:
+	$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
+	@echo
+	@echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo."
+	@echo "Run \`make' in that directory to run these through makeinfo" \
+	      "(use \`make info' here to do that automatically)."
+
+info:
+	$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
+	@echo "Running Texinfo files through makeinfo..."
+	make -C $(BUILDDIR)/texinfo info
+	@echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo."
+
+gettext:
+	$(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale
+	@echo
+	@echo "Build finished. The message catalogs are in $(BUILDDIR)/locale."
+
+changes:
+	$(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
+	@echo
+	@echo "The overview file is in $(BUILDDIR)/changes."
+
+linkcheck:
+	$(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
+	@echo
+	@echo "Link check complete; look for any errors in the above output " \
+	      "or in $(BUILDDIR)/linkcheck/output.txt."
+
+doctest:
+	$(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
+	@echo "Testing of doctests in the sources finished, look at the " \
+	      "results in $(BUILDDIR)/doctest/output.txt."
+
+xml:
+	$(SPHINXBUILD) -b xml $(ALLSPHINXOPTS) $(BUILDDIR)/xml
+	@echo
+	@echo "Build finished. The XML files are in $(BUILDDIR)/xml."
+
+pseudoxml:
+	$(SPHINXBUILD) -b pseudoxml $(ALLSPHINXOPTS) $(BUILDDIR)/pseudoxml
+	@echo
+	@echo "Build finished. The pseudo-XML files are in $(BUILDDIR)/pseudoxml."

doc/source/conf.py

@@ -0,0 +1,260 @@
+# -*- coding: utf-8 -*-
+#
+# Gertty documentation build configuration file, created by
+# sphinx-quickstart on Fri Jan 15 13:41:54 2016.
+#
+# This file is execfile()d with the current directory set to its
+# containing dir.
+#
+# Note that not all possible configuration values are present in this
+# autogenerated file.
+#
+# All configuration values have a default; values that are commented out
+# serve to show the default.
+
+import datetime
+import sys
+import os
+
+# If extensions (or modules to document with autodoc) are in another directory,
+# add these directories to sys.path here. If the directory is relative to the
+# documentation root, use os.path.abspath to make it absolute, like shown here.
+#sys.path.insert(0, os.path.abspath('.'))
+sys.path.insert(0, os.path.abspath('../..'))
+
+# -- General configuration ------------------------------------------------
+
+# If your documentation needs a minimal Sphinx version, state it here.
+#needs_sphinx = '1.0'
+
+# Add any Sphinx extension module names here, as strings. They can be
+# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
+# ones.
+extensions = []
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ['_templates']
+
+# The suffix of source filenames.
+source_suffix = '.rst'
+
+# The encoding of source files.
+#source_encoding = 'utf-8-sig'
+
+# The master toctree document.
+master_doc = 'index'
+
+# General information about the project.
+project = u'Gertty'
+copyright = u'%s, Gertty Contributors' % datetime.date.today().year
+
+# The version info for the project you're documenting, acts as replacement for
+# |version| and |release|, also used in various other places throughout the
+# built documents.
+# The full version, including alpha/beta/rc tags.
+from gertty.version import version_info as gertty_version
+release = gertty_version.version_string_with_vcs()
+# The short X.Y version.
+version = gertty_version.canonical_version_string()
+
+# The language for content autogenerated by Sphinx. Refer to documentation
+# for a list of supported languages.
+#language = None
+
+# There are two options for replacing |today|: either, you set today to some
+# non-false value, then it is used:
+#today = ''
+# Else, today_fmt is used as the format for a strftime call.
+#today_fmt = '%B %d, %Y'
+
+# List of patterns, relative to source directory, that match files and
+# directories to ignore when looking for source files.
+exclude_patterns = []
+
+# The reST default role (used for this markup: `text`) to use for all
+# documents.
+#default_role = None
+
+# If true, '()' will be appended to :func: etc. cross-reference text.
+#add_function_parentheses = True
+
+# If true, the current module name will be prepended to all description
+# unit titles (such as .. function::).
+#add_module_names = True
+
+# If true, sectionauthor and moduleauthor directives will be shown in the
+# output. They are ignored by default.
+#show_authors = False
+
+# The name of the Pygments (syntax highlighting) style to use.
+pygments_style = 'sphinx'
+
+# A list of ignored prefixes for module index sorting.
+#modindex_common_prefix = []
+
+# If true, keep warnings as "system message" paragraphs in the built documents.
+#keep_warnings = False
+
+
+# -- Options for HTML output ----------------------------------------------
+
+# The theme to use for HTML and HTML Help pages.  See the documentation for
+# a list of builtin themes.
+html_theme = 'default'
+
+# Theme options are theme-specific and customize the look and feel of a theme
+# further.  For a list of options available for each theme, see the
+# documentation.
+#html_theme_options = {}
+
+# Add any paths that contain custom themes here, relative to this directory.
+#html_theme_path = []
+
+# The name for this set of Sphinx documents.  If None, it defaults to
+# "<project> v<release> documentation".
+#html_title = None
+
+# A shorter title for the navigation bar.  Default is the same as html_title.
+#html_short_title = None
+
+# The name of an image file (relative to this directory) to place at the top
+# of the sidebar.
+#html_logo = None
+
+# The name of an image file (within the static path) to use as favicon of the
+# docs.  This file should be a Windows icon file (.ico) being 16x16 or 32x32
+# pixels large.
+#html_favicon = None
+
+# Add any paths that contain custom static files (such as style sheets) here,
+# relative to this directory. They are copied after the builtin static files,
+# so a file named "default.css" will overwrite the builtin "default.css".
+html_static_path = ['_static']
+
+# Add any extra paths that contain custom files (such as robots.txt or
+# .htaccess) here, relative to this directory. These files are copied
+# directly to the root of the documentation.
+#html_extra_path = []
+
+# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
+# using the given strftime format.
+#html_last_updated_fmt = '%b %d, %Y'
+
+# If true, SmartyPants will be used to convert quotes and dashes to
+# typographically correct entities.
+#html_use_smartypants = True
+
+# Custom sidebar templates, maps document names to template names.
+#html_sidebars = {}
+
+# Additional templates that should be rendered to pages, maps page names to
+# template names.
+#html_additional_pages = {}
+
+# If false, no module index is generated.
+#html_domain_indices = True
+
+# If false, no index is generated.
+#html_use_index = True
+
+# If true, the index is split into individual pages for each letter.
+#html_split_index = False
+
+# If true, links to the reST sources are added to the pages.
+#html_show_sourcelink = True
+
+# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
+#html_show_sphinx = True
+
+# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
+#html_show_copyright = True
+
+# If true, an OpenSearch description file will be output, and all pages will
+# contain a <link> tag referring to it.  The value of this option must be the
+# base URL from which the finished HTML is served.
+#html_use_opensearch = ''
+
+# This is the file name suffix for HTML files (e.g. ".xhtml").
+#html_file_suffix = None
+
+# Output file base name for HTML help builder.
+htmlhelp_basename = 'Gerttydoc'
+
+
+# -- Options for LaTeX output ---------------------------------------------
+
+latex_elements = {
+# The paper size ('letterpaper' or 'a4paper').
+#'papersize': 'letterpaper',
+
+# The font size ('10pt', '11pt' or '12pt').
+#'pointsize': '10pt',
+
+# Additional stuff for the LaTeX preamble.
+#'preamble': '',
+}
+
+# Grouping the document tree into LaTeX files. List of tuples
+# (source start file, target name, title,
+#  author, documentclass [howto, manual, or own class]).
+latex_documents = [
+  ('index', 'Gertty.tex', u'Gertty Documentation',
+   u'James E. Blair', 'manual'),
+]
+
+# The name of an image file (relative to this directory) to place at the top of
+# the title page.
+#latex_logo = None
+
+# For "manual" documents, if this is true, then toplevel headings are parts,
+# not chapters.
+#latex_use_parts = False
+
+# If true, show page references after internal links.
+#latex_show_pagerefs = False
+
+# If true, show URL addresses after external links.
+#latex_show_urls = False
+
+# Documents to append as an appendix to all manuals.
+#latex_appendices = []
+
+# If false, no module index is generated.
+#latex_domain_indices = True
+
+
+# -- Options for manual page output ---------------------------------------
+
+# One entry per manual page. List of tuples
+# (source start file, name, description, authors, manual section).
+man_pages = [
+    ('index', 'gertty', u'Gertty Documentation',
+     [u'James E. Blair'], 1)
+]
+
+# If true, show URL addresses after external links.
+#man_show_urls = False
+
+
+# -- Options for Texinfo output -------------------------------------------
+
+# Grouping the document tree into Texinfo files. List of tuples
+# (source start file, target name, title, author,
+#  dir menu entry, description, category)
+texinfo_documents = [
+  ('index', 'Gertty', u'Gertty Documentation',
+   u'James E. Blair', 'Gertty', 'One line description of project.',
+   'Miscellaneous'),
+]
+
+# Documents to append as an appendix to all manuals.
+#texinfo_appendices = []
+
+# If false, no module index is generated.
+#texinfo_domain_indices = True
+
+# How to display URL addresses: 'footnote', 'no', or 'inline'.
+#texinfo_show_urls = 'footnote'
+
+# If true, do not generate a @detailmenu in the "Top" node's menu.
+#texinfo_no_detailmenu = False

doc/source/configuration.rst

@@ -0,0 +1,41 @@
+Configuration
+-------------
+
+Gertty uses a YAML based configuration file that it looks for at
+``~/.gertty.yaml``.  Several sample configuration files are included.
+You can find them in the examples/ directory of the
+`source distribution <https://git.openstack.org/cgit/openstack/gertty/tree/examples>`_
+or the share/gertty/examples directory after installation.
+
+Select one of the sample config files, copy it to ~/.gertty.yaml and
+edit as necessary.  Search for ``CHANGEME`` to find parameters that
+need to be supplied.  The sample config files are as follows:
+
+**minimal-gertty.yaml**
+  Only contains the parameters required for Gertty to actually run.
+
+**reference-gertty.yaml**
+  An exhaustive list of all supported options with examples.
+
+**openstack-gertty.yaml**
+  A configuration designed for use with OpenStack's installation of
+  Gerrit.
+
+**googlesource-gertty.yaml**
+  A configuration designed for use with installations of Gerrit
+  running on googlesource.com.
+
+You will need your Gerrit password which you can generate or retrieve
+by navigating to ``Settings``, then ``HTTP Password``.
+
+Gertty uses local git repositories to perform much of its work.  These
+can be the same git repositories that you use when developing a
+project.  Gertty will not alter the working directory or index unless
+you request it to (and even then, the usual git safeguards against
+accidentally losing work remain in place).  You will need to supply
+the name of a directory where Gertty will find or clone git
+repositories for your projects as the ``git-root`` parameter.
+
+The config file is designed to support multiple Gerrit instances.  The
+first one is used by default, but others can be specified by supplying
+the name on the command line.

doc/source/contributing.rst

@@ -0,0 +1,10 @@
+Contributing
+------------
+
+For information on how to contribute to Gertty, please see the
+contents of the CONTRIBUTING.rst file.
+
+Bugs
+~~~~
+
+Bugs are handled at: https://storyboard.openstack.org/#!/project/698

doc/source/index.rst

@@ -0,0 +1,42 @@
+Gertty
+======
+
+Gertty is a console-based interface to the Gerrit Code Review system.
+
+As compared to the web interface, the main advantages are:
+
+ * Workflow -- the interface is designed to support a workflow similar
+   to reading network news or mail.  In particular, it is designed to
+   deal with a large number of review requests across a large number
+   of projects.
+
+ * Offline Use -- Gertty syncs information about changes in subscribed
+   projects to a local database and local git repos.  All review
+   operations are performed against that database and then synced back
+   to Gerrit.
+
+ * Speed -- user actions modify locally cached content and need not
+   wait for server interaction.
+
+ * Convenience -- because Gertty downloads all changes to local git
+   repos, a single command instructs it to checkout a change into that
+   repo for detailed examination or testing of larger changes.
+
+
+Contents:
+
+.. toctree::
+   :maxdepth: 1
+
+   installation.rst
+   configuration.rst
+   usage.rst
+   contributing.rst
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`
+

doc/source/installation.rst

@@ -0,0 +1,53 @@
+Installation
+------------
+
+Debian
+~~~~~~
+
+Gertty is packaged in Debian and is currently available in:
+
+ * unstable
+ * testing
+ * stable
+
+You can install it with::
+
+  apt-get install gertty
+
+Fedora
+~~~~~~
+
+Gertty is packaged starting in Fedora 21.  You can install it with::
+
+  yum install python-gertty
+
+openSUSE
+~~~~~~~~
+
+Gertty is packaged for openSUSE 13.1 onwards.  You can install it via
+`1-click install from the Open Build Service <http://software.opensuse.org/package/python-gertty>`_.
+
+Arch Linux
+~~~~~~~~~~
+
+Gertty packages are available in the Arch User Repository packages. You
+can get the package from::
+
+  https://aur.archlinux.org/packages/python2-gertty/
+
+Source
+~~~~~~
+
+When installing from source, it is recommended (but not required) to
+install Gertty in a virtualenv.  To set one up::
+
+  virtualenv gertty-env
+  source gertty-env/bin/activate
+
+To install the latest version from the cheeseshop::
+
+  pip install gertty
+
+To install from a git checkout::
+
+  pip install .

doc/source/usage.rst

@@ -0,0 +1,72 @@
+Usage
+-----
+
+After installing Gertty, you should be able to run it by invoking
+``gertty``.  If you installed it in a virtualenv, you can invoke it
+without activating the virtualenv with ``/path/to/venv/bin/gertty``
+which you may wish to add to your shell aliases.  Use ``gertty
+--help`` to see a list of command line options available.
+
+Once Gertty is running, you will need to start by subscribing to some
+projects.  Use 'L' to list all of the projects and then 's' to
+subscribe to the ones you are interested in.  Hit 'L' again to shrink
+the list to your subscribed projects.
+
+In general, pressing the F1 key will show help text on any screen, and
+ESC will take you to the previous screen.
+
+Gertty works seamlessly offline or online.  All of the actions that it
+performs are first recorded in a local database (in ``~/.gertty.db``
+by default), and are then transmitted to Gerrit.  If Gertty is unable
+to contact Gerrit for any reason, it will continue to operate against
+the local database, and once it re-establishes contact, it will
+process any pending changes.
+
+The status bar at the top of the screen displays the current number of
+outstanding tasks that Gertty must perform in order to be fully up to
+date.  Some of these tasks are more complicated than others, and some
+of them will end up creating new tasks (for instance, one task may be
+to search for new changes in a project which will then produce 5 new
+tasks if there are 5 new changes).
+
+If Gertty is offline, it will so indicate in the status bar.  It will
+retry requests if needed, and will switch between offline and online
+mode automatically.
+
+If you review a change while offline with a positive vote, and someone
+else leaves a negative vote on that change in the same category before
+Gertty is able to upload your review, Gertty will detect the situation
+and mark the change as "held" so that you may re-inspect the change
+and any new comments before uploading the review.  The status bar will
+alert you to any held changes and direct you to a list of them (the
+`F12` key by default).  When viewing a change, the "held" flag may be
+toggled with the exclamation key (`!`).  Once held, a change must be
+explicitly un-held in this manner for your review to be uploaded.
+
+If Gertty encounters an error, this will also be indicated in the
+status bar.  You may wish to examine ~/.gertty.log to see what the
+error was.  In many cases, Gertty can continue after encountering an
+error.  The error flag will be cleared when you leave the current
+screen.
+
+To select text (e.g., to copy to the clipboard), hold Shift while
+selecting the text.
+
+Terminal Integration
+~~~~~~~~~~~~~~~~~~~~
+
+If you use rxvt-unicode, you can add something like the following to
+``.Xresources`` to make Gerrit URLs that are displayed in your
+terminal (perhaps in an email or irc client) clickable links that open
+in Gertty::
+
+  URxvt.perl-ext:           default,matcher
+  URxvt.url-launcher:       sensible-browser
+  URxvt.keysym.C-Delete:    perl:matcher:last
+  URxvt.keysym.M-Delete:    perl:matcher:list
+  URxvt.matcher.button:     1
+  URxvt.matcher.pattern.1:  https:\/\/review.example.org/(\\#\/c\/)?(\\d+)[\w]*
+  URxvt.matcher.launcher.1: gertty --open $0
+
+You will want to adjust the pattern to match the review site you are
+interested in; multiple patterns may be added as needed.