Commits

Marcin Kasperski  committed 375df97

Further doc improvements

  • Participants
  • Parent commits 2cbb6fe
  • Tags 1.0.0

Comments (0)

Files changed (1)

 ISBN inside (via scanning a few leading pages) and updates Calibre
 book metadata if ISBN is found.
 
+Run it without parameters::
+
+    calibre_guess_and_add_isbn
+
 Later on ISBN can be used to grab the book metatada and/or book cover
 inside Calibre GUI. Just spawn Calibre and look for books with ISBN
-set and missing metadata, for example using query like:
+set and missing metadata, for example using query like::
 
      isbn:~[0-9] not publisher:~[a-z]
 
 OpenOffice (and pyuno libraries provided by it) are used in the
 process.
 
+Run it without parameters::
+
+    calibre_convert_docs_to_rtf
+
+Note: the script happens to crash on the end of the job (while
+finishing).  I haven't diagnosed the reasons (most likely the problem
+is in the libraries I use), but the crash is harmless and does not
+influence the actual conversion process.
+
+
 calibre_find_books_missing_in_database
 --------------------------------------
 
 present in the database (= not visible in the interface).
 
 The files are reported to standard output. To add them
-all to calibre, pipe output. For example:
+all to calibre, pipe output. For example::
 
-    python find_books_missing_in_database.py | xargs -d "\n" calibredb add
+    calibre_find_books_missing_in_database.py | xargs -d "\n" calibredb add
 
 (but, better, review everything beforehand)
 
 *The problematic scenario may happen for example if Calibre is used
-from 2 or more machines over synchronized or networked directory.*
+from two or more machines over synchronized or networked directory
+and, by mistake two copies are run simultaneously.*
 
 
 calibre_add_if_missing
 I wrote this script to handle *I want to ensure everything is already
 imported and can be deleted* scenario.
 
-Example:
+Example::
 
     calibre_add_if_missing /home/jan/OldBooks
 
 
 Calibre must be installed, properly configured and has
 some database (otherwise it does not make sense to run those scripts).
-The 
+The:: 
 
     calibredb
 
 command must be in PATH (or calibredb variable inside .ini file must
 be properly set, see below).
 
-Tools providing commands:
+Tools providing commands::
 
     pdftotext
     catdoc 
     djvutxt
     archmage
 
-must be installed and present in PATH (or properly configured in .ini,
-or disabled in .ini, see below). On Ubuntu Linux or Debian Linux those
-can be installed from standard repositories, just install the
-following packages
+should be installed and present in PATH (or properly configured in
+.ini, or disabled in .ini, see below). On Ubuntu Linux or Debian Linux
+those can be installed from standard repositories, just install the
+following packages::
 
     poppler-utils 
     catdoc
 Python 2.6 or 2.7 is required (scripts are using some features
 introduced in 2.6 - in particular tempfile extensions, subprocess and
 namedtuple). Also, lxml library must be installed.  On Debian or
-Ubuntu just install the following packages:
+Ubuntu just install the following packages::
 
    python2.6
    python-lxml
 
-For calibre_convert_docs_to_rtf to work, ootools library
-(<http://pypi.python.org/pypi/ootools/0.1dev>) must be
-installed. Simplest method to install it:
+For calibre_convert_docs_to_rtf to work, ootools_ library must be
+installed. Simplest method to install it::
 
     easy_install ootools
 
 Actual installation
 --------------------
 
-Simple
+Simple::
 
     easy_install mekk.calibre
 
 For example, the file can be changed so::
 
     [commands]
-    catdoc = /opt/wordview/catdoc
+    catdoc = /usr/local/bin/catdoc
     archmage = 
     djvutxt = 
     calibredb = /opt/calibre/calibredb
     guess_lead_lines = 12000
     guess_lead_pages = 15
 
-In such a case catdoc and calibredb will be sought in /opt, pdftotext
-will be expected in PATH, and archmage and djvutxt will be treat as
-missing (so the isbn guessing script won't be able to scan CHM and
-DJVU files for ISBN).
+In such a case catdoc will be used from /usr/local/bin, calibredb will
+be expected in /opt/calibre, pdftotext will be sought in PATH, and
+archmage and djvutxt will be treat as missing (so the isbn guessing
+script won't be able to scan CHM and DJVU files for ISBN and will
+ignore them).
 
 
 Sources, bug reports
 
 .. _hosted here: http://bitbucket.org/Mekk/calibre_utils
 .. _Calibre: http://calibre-ebook.com/
-
+.. _ootools: http://pypi.python.org/pypi/ootools/0.1dev