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