PyRoom Project

PyRoom is a fullscreen simple text editor, without a toolbar, a menubar or anything that would distract the user from his most important task: writing.

Dependencies

PyRoom depends on Python, PyGTK and gtksourceview. Please refer to your system documentation for information on how to install these modules if they're not currently available.

Installing and Running

PyRoom is available via a tarball, which is downloadable via:

https://code.launchpad.net/pyroom/0.1/0.1

Once you've downloaded the .tar.gz file, you may launch the pyroom.py script.

If you want to get the “up to date” version of PyRoom, you may want to grab it using bzr:

$ bzr branch bzr branch http://bazaar.launchpad.net/~pyroom-dev/pyroom/trunk pyroom
$ cd pyroom
$ python pyroom.py

As of version 0.3.1.1 it is also possible to install packages for Fedora and Ubuntu. The web site http://www.pyroom.org/download.html has instructions for these downloads. Note that Kubuntu users will need to add the GTK bindings, python-gtk2 package.

Usage

Running PyRoom

To run PyRoom, type:

$ python pyroom.py

To run pyroom and instruct it to load some existing files, type:

$ python pyroom.py /path/to/file1 /other/path/to/file2

Using the Ubuntu package install, one can run PyRoom from the program launch icon in the Office group on the menu. Using the Alt-F2 “Run Command” dialog, it is possible to type a file name also. In the following example, replace “user” with your actual user name, and of course the real name of your text file.

pyroom /home/user/Documents/chapter01.txt

Graphical Styles

The default style is “green”, which is a green text color in a black background. You can change the chosen style by typing:

$ python pyroom.py [--style={style name}]

For instance:

$ python pyroom.py --style=blue

At the time of writing, the available styles are:

  • blue
  • amber
  • darkgreen
  • c64
  • cupid
  • locontrast
  • green
  • banker

Example Usage

For example, to load PyRoom and instruct it to use the “darkgreen” style and to load the files “article.txt” and “blogpost.txt”, type the following:

$ python pyroom.py --style=darkgreen article.txt blogpost.txt

Key Bindings

There are a few keys allowing you to perform a few useful commands:

  • Control-H: Show help in a new buffer
  • Control-I: Show buffer information
  • Control-L: Toggle line number
  • Control-N: Create a new buffer
  • Control-O: Open a file in a new buffer
  • Control-Q: Quit
  • Control-S: Save current buffer
  • Control-Shift-S: Save current buffer as
  • Control-W: Close buffer and exit if it was the last buffer
  • Control-Y: Redo last typing
  • Control-Z: Undo last typing
  • Control-Page Up: Switch to previous buffer
  • Control-Page Down: Switch to next buffer
  • Control-Plus: Increases font size
  • Control-Minus: Decreases font size

Want to know more?

 
readme.txt · Last modified: 2008/11/23 00:09 by algot-runeman
 
Recent changes RSS feed Creative Commons License Donate Powered by PHP Valid XHTML 1.0 Valid CSS Driven by DokuWiki