← Back to branch summary

~stephen-j-boddy/terminator/bugfix-1318542-double-chars

« back to all changes in this revision

Viewing changes to doc/manual/_build/html/_sources/index.txt

  • Committer: Stephen Boddy
  • Date: 2015-08-08 02:11:30 UTC
  • Revision ID: stephen.j.boddy@gmail.com-20150808021130-9c1npu4gvenkcb1p
A manual has been added to Terminator
* Added source and generated html of manual, and API doc
* setup.py can install the manual (and by extension do can debuild)
* setup.py has (inactive) code for generating the html from the source
  but this will break if rtd theme is not available
* A few changes to doc strings to make the autodoc prettier
* Added help shortcut, by default F1 to open the local manual
* Added button to About tab to launch manual
* A couple of additional string to translate related to manual/help

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/manual/_build/html/_sources/index.txt
 
1
.. image:: imgs/icon_terminator.png
 
2
   :align: right
 
3
   :alt: The robot future of terminals.
 
4
 
 
5
======================================
 
6
Welcome to Terminator's documentation!
 
7
======================================
 
8
 
 
9
This is the beginnings of a manual for Terminator. Sometimes it is not always
 
10
clear just how many little shortcuts and features there are in Terminator. This
 
11
guide hopes to reduce the confusion.
 
12
 
 
13
A quick word on style. I have none. 😃 I have an casual way of talking and writing,
 
14
and a strange sense of humour. I also tend to use random pop-culture references
 
15
a lot, but often in ways that make no sense. If this is a problem you are
 
16
entitled to a refund of the money you paid to me to write this... 😎
 
17
 
 
18
------------------
 
19
What is Terminator
 
20
------------------
 
21
 
 
22
At its simplest Terminator is a terminal emulator like xterm, gnome-terminal,
 
23
konsole, etc. At its most complex it lets you fly... metaphorically at least.
 
24
Take a look at the following list:
 
25
 
 
26
.. sidebar:: From the simple...
 
27
 
 
28
   .. image:: imgs/small_example.png
 
29
      :width: 100%
 
30
 
 
31
- Arrange terminals in a grid
 
32
- Tabs
 
33
- Drag and drop re-ordering of terminals
 
34
- Lots of keyboard shortcuts
 
35
- Save multiple layouts and profiles via GUI preferences editor
 
36
- Simultaneous typing to arbitrary groups of terminals
 
37
 
 
38
and lots more...
 
39
 
 
40
.. sidebar:: To the ridiculous...
 
41
 
 
42
   .. image:: imgs/large_example.png
 
43
      :width: 100% 
 
44
 
 
45
   In case it's not obvious this is faked up. I use more complex setups,
 
46
   but I'm not putting real work into the documentation.
 
47
 
 
48
.. toctree::
 
49
   :caption: Contents:
 
50
   :maxdepth: 2
 
51
 
 
52
   licensing
 
53
   history
 
54
   gettingstarted
 
55
   preferences
 
56
   layouts
 
57
   grouping
 
58
   plugins
 
59
   advancedusage
 
60
   faq
 
61
   gettinginvolved
 
62
 
 
63
.. Indices and tables
 
64
   ==================
 
65
 
 
66
.. * :ref:`genindex`
 
67
   * :ref:`modindex`
 
68
   * :ref:`search`
 
69