README

   1 Straw
   2
   3 = Contents =
   4
   5     * Introduction
   6     * Minimum Requirements
   7     * Installation
   8     * Notes on Installation
   9     * Notes on Translation
  10     * Notes on Configuring your Web Browser
  11     * Database Corruption: How to recover data
  12     * Database Conversion Problems ( for version 0.21.x and below ONLY )
  13     * Environment variables
  14     * Help?
  15
  16
  17
  18 === Introduction ===
  19
  20 Straw is a desktop news aggregator for the GNOME environment. Its aim is to
  21 be a faster, easier and more accessible way to read news and blogs than the
  22 traditional browser.
  23
  24
  25 === Minimum Requirements ===
  26
  27 1. Python 2.4
  28 2. Berkeley DB and their python bindings (pybsddb)
  29 3. PyGTK 2.8+ (incl. extras which contains the gtkhtml2 module)
  30 4. GConf
  31
  32 === Installation ===
  33
  34 1. Make sure you have the required packages to run Straw
  35
  36 [myshell@test.com]$ cd straw
  37 [myshell@test.com:~/straw]$ python setup.py install_modules_check
  38
  39 2. Build the necessary files to run Straw
  40
  41 [myshell@test.com:~/straw]$ python setup.py build
  42
  43 3. Install
  44
  45 [myshell@test.com:~/straw]$ python setup.py install
  46
  47 ... Or if you want to install straw in /usr/local..
  48
  49 [myshell@test.com:~/straw]$ python setup.py install --prefix=/usr/local
  50
  51
  52
  53 === Notes on Installation ===
  54
  55 Straw installs files into three locations:
  56
  57 1. The straw executable into a directory that should be in your $PATH, like
  58    '/usr/bin/' or '/usr/local/bin'.
  59
  60 2. A library directory to a location that should be in python's search path,
  61     like '/usr/lib/python2.X/site-packages' or '/usr/local/lib/python2.X/site-packages'.
  62
  63 3. And a data directory into a location that should be an architecture-neutral
  64     directory like it '/usr/share/' or '/usr/local/share'
  65
  66 If the library directory[2] isn't in your search path, or if you for some
  67 reason installed it elsewhere, you should point the STRAW_LIB
  68 environment variable at the directory under which the straw library
  69 directory was created.
  70
  71
  72
  73 === Notes on Translation ===
  74
  75 (1) Updating the POT file
  76
  77 [myshell@test.com:~/straw]$ python setup.py translate --pot
  78
  79
  80 (2) Merging LANGCODE.po with straw.pot
  81
  82 [myshell@test.com:~/straw]$ python setup.py translate --dist LANGCODE
  83
  84
  85 (3) Merging translation with desktop file
  86
  87 [myshell@test.com:~/straw]$ python setup.py build_desktop
  88
  89 'python setup.py --help-commands' for more info.
  90
  91
  92 === Database Corruption: How to recover data ===
  93
  94 When you see following error ...
  95
  96 "Recovery Error: See README for details on how to recover data."
  97
  98 ... run ...
  99
 100 [myshell@test.com:~/straw]$ db_recover -h $HOME/.straw -c -v
 101 [myshell@test.com:~/straw]$ db_checkpoint -1 -v
 102
 103 ... after which you can now restart straw and everything should be fine.
 104
 105 If it still errors, read the last paragraph of the next section (... conversion problems)
 106
 107
 108 === Database conversion problems ( for version 0.21.x and below ONLY ) ===
 109
 110 The database format changed between Straw versions 0.21 and
 111 0.22. Straw will automatically convert your database, but people have
 112 experienced problems which we have been unable to trace.
 113
 114 If the conversion fails, you will be shown a dialog reporting the
 115 problem. The exception will be saved to a file, the dialog will tell
 116 you the name. You should see what's the problem; if it contains an
 117 error telling you to run recover, you should try running db_recover on
 118 the $HOME/.straw directory, like this:
 119
 120 $ db_recover -h $HOME/.straw -c -v
 121 $ db_checkpoint -1 -v
 122
 123 However, this does not always help. If all else fails, you should
 124 rescue your $HOME/.straw/config file and put it in a new, empty
 125 $HOME/.straw directory. You will lose all the articles and images, but
 126 your subscriptions will be safe.
 127
 128 We apologize for the inconvenience.
 129
 130 === Environment variables ===
 131
 132 While most of Straw's configuration is stored in gconf and its own
 133 configuration file, there are also some more developer-oriented
 134 environment variables that modify Straw's behaviour.
 135
 136 STRAW_RELOAD_CSS: If defined, reload CSS every time an article is
 137                   displayed.
 138
 139 STRAW_IN_SOURCE_DIR: Tell Straw it's running in the source directory,
 140                      so it knows where to look for dependencies.
 141
 142 === Help? ===
 143
 144 1. Visit http://live.gnome.org/Straw for mailing lists and reporting defects.
 145 2. We have a channel in irc.freenode.net called #straw.
 146 3. For more installation commands, run:
 147
 148 [myshell@test.com:~/straw]$ python setup.py --help-commands
 149
 150
 151 - Straw Maintainers