Recent changes to Installation

Installation modified by Quasus

Quasus — Fri, 12 Sep 2014 10:31:32 -0000

--- v6
+++ v7
@@ -4,8 +4,20 @@
 General
 -------

+You need CLISP or SBCL to compile this software.  CLISP produces smaller binaries.
+
+To compile with CLISP and install:
+
     make
     make install
+    make clean
+    
+To compile with SBCL and install:
+
+    make lisp=sbcl
+    make install
+    make clean
+    

 You can modify the installation directories by providing a `prefix` as follows

@@ -28,14 +40,14 @@

 SCDICT can also be used as a Lisp library in a Lisp environment.

-Currently CLISP and SBCL are supported.
+It has been tested with CLISP and SBCL.

-The Lisp code is collected in the `src` directory.  SCDICT depends on a few standard libraries contained in the `lisp-dependencies` directory; however, the dependencies can be installed independently.
+The Lisp code is collected in the `lisp` directory.

-The main loop is started by the function SCDICT.INTERFACE:MAIN which accepts a plist of parameters as parsed by apply-argv.  For example,
+The entry point is the function SCDICT:MAIN which accepts a list of command line arguments.

-    scdict.interface:main('(:quiet :initial-dictionary "mydict"))
+    scdict:main('("dictionary" "install" "-r" "my-file.scdict"))

 is equivalent to

-    scdict -quiet -initial-dictionary mydict
+    scdict dictionary install -r my-file.scdict

Installation modified by Quasus

Quasus — Thu, 13 Feb 2014 13:01:03 -0000

--- v5
+++ v6
@@ -0,0 +1,41 @@
+Installation
+============
+
+General
+-------
+
+    make
+    make install
+
+You can modify the installation directories by providing a `prefix` as follows
+
+    make install prefix=/my/prefix
+
+By default `prefix` is set to `/usr/local`.
+
+Uninstall:
+
+    make uninstall
+
+or
+
+    make uninstall prefix=/my/prefix
+
+SCDICT keeps user-specific files in the `~/.scdict` directory.  These directories are unaffected by uninstallation.
+
+Using from Lisp environment
+---------------------------
+
+SCDICT can also be used as a Lisp library in a Lisp environment.
+
+Currently CLISP and SBCL are supported.
+
+The Lisp code is collected in the `src` directory.  SCDICT depends on a few standard libraries contained in the `lisp-dependencies` directory; however, the dependencies can be installed independently.
+
+The main loop is started by the function SCDICT.INTERFACE:MAIN which accepts a plist of parameters as parsed by apply-argv.  For example,
+
+    scdict.interface:main('(:quiet :initial-dictionary "mydict"))
+
+is equivalent to
+
+    scdict -quiet -initial-dictionary mydict

Installation modified by Quasus

Quasus — Wed, 05 Feb 2014 17:27:39 -0000

Set-up modified by Quasus

Quasus — Wed, 05 Feb 2014 17:27:14 -0000

--- v3
+++ v4
@@ -1,79 +0,0 @@
-In order to actually use SCDICT you must set up certain things in your configuration file ~/.scdict/scdictrc.lisp.
-
-## Basic setup ##
-
-The configuration file uses Lisp-like syntax.
-
-First and foremost, you should set up default viewers for your formats of dictionaries.
-
-### Defining viewer ###
-
-In order to set a default viewer, you first define one.  To do so you use the following syntax:
-
-    (defviewer  ( )  )
-
-Here
-
-* `` is any sequence of letters (typically lowercase with hyphens
-as separators; in what follows such sequences are referenced to as *symbols*);
-
-* `` is a symbol standing for variable file name;
-
-* `` is a symbol standing for variable page number;
-
-* `` is a string delimited by double quotes possibly including
-sequences `~A`.  More generally, it can be an arbitrary Common Lisp format
-string.  Note that inside strings literal double quotes and backslashes must be
-escaped with a backslash;
-
-* `` are several symbols (one for each `~A`) used for
-substitution into the format string.
-
-### Example: djview4 ###
-
-Say, you want to use djview4 as your default DjVu viewer.
-A possible command to open a file at a given page would be
- 
-    djview -page= ""
-
-(see `man djview` for more options).  Note that you should quote the file name
-as it may contain spaces.  In your scdictrc.lisp you use write as follows:
-
-    (defviewer default-djvu-viewer (f p) "djview -page=~A \"~A\"" p f)
-
-Here `defviewer` means that we are defining a new viewer and
-`default-djvu-viewer` is its name (you could choose another one to your
-liking).  Next, as we mentioned, we specify two symbols `f` and `p` that will
-stand for the file name and page number.  You could chose any two letters
-(identifiers) you like, but the first letter in parentheses after the viewer's
-name will always stand for the file name, while the second one will stand for
-the page.  Next we see our command in the form of a format string.  The string
-has two gaps for the page number and the file name which are both represented
-by ~A. After the string we supply the values to fill in the gaps in the order
-the gaps occur, i. e. first the page number, then the file name.  Notice once
-again that the format string (as any string) is delimited by double quotes and
-you must escape literal double quotes with backslashes.
-
-### Example: mupdf ###
-Here is another example for mupdf:
-
-    (defviewer my-favourite-pdf-viewer (file page)
-      "mupdf \"~A\" ~A" file page)
-
-Here the syntax is simpler and can be written in the form
-    
-    mupdf  
-
-We have used the variable names `file` and `page` instead of just f and p.
-
-Observe that you can split Lisp code between multiple lines (anyway, computer
-reads it by parentheses) and it it customary (though not absolutely necessary)
-to indent the body of a macro by two spaces.  Further, observe that Lisp code
-is typically written in lower case with hyphens as separators (rather than e.
-g. underscores).  Of course, a dedicated text editor makes formatting code much
-easier, but if you are not going to code that much, you can have pretty rc
-files even without it.
-
-## Advanced setup ##
-
-The configuration file uses a DSL built on top of Common Lisp.  You have no direct access to the whole of Common Lisp, so chances are high that you won't mess things up a lot.  However, you do have indirect access to the language, so you can hack if you feel like to.

Set-up modified by Quasus

Quasus — Wed, 05 Feb 2014 17:20:33 -0000

--- v2
+++ v3
@@ -70,11 +70,9 @@
 reads it by parentheses) and it it customary (though not absolutely necessary)
 to indent the body of a macro by two spaces.  Further, observe that Lisp code
 is typically written in lower case with hyphens as separators (rather than e.
-g. underscores).  Of course, a dedicated text editor makes formatting the code
-much easier, but if you are not going to code that much, you can have pretty
-rc files even without it.
-
-
+g. underscores).  Of course, a dedicated text editor makes formatting code much
+easier, but if you are not going to code that much, you can have pretty rc
+files even without it.

 ## Advanced setup ##

Set-up modified by Quasus

Quasus — Wed, 05 Feb 2014 17:19:33 -0000

--- v1
+++ v2
@@ -29,7 +29,7 @@
 * `` are several symbols (one for each `~A`) used for
 substitution into the format string.

-### Example ###
+### Example: djview4 ###

 Say, you want to use djview4 as your default DjVu viewer.
 A possible command to open a file at a given page would be
@@ -54,7 +54,7 @@
 again that the format string (as any string) is delimited by double quotes and
 you must escape literal double quotes with backslashes.

-### Example ###
+### Example: mupdf ###
 Here is another example for mupdf:

     (defviewer my-favourite-pdf-viewer (file page)

Set-up modified by Quasus

Quasus — Wed, 05 Feb 2014 17:18:45 -0000

In order to actually use SCDICT you must set up certain things in your configuration file ~/.scdict/scdictrc.lisp.

Basic setup

The configuration file uses Lisp-like syntax.

First and foremost, you should set up default viewers for your formats of dictionaries.

Defining viewer

In order to set a default viewer, you first define one. To do so you use the following syntax:

(defviewer <viewer-name> (<file> <page>) <format-string> <format-arguments>)

Here

<viewer-name> is any sequence of letters (typically lowercase with hyphens
as separators; in what follows such sequences are referenced to as symbols);
<file> is a symbol standing for variable file name;
<page> is a symbol standing for variable page number;
<format-string> is a string delimited by double quotes possibly including
sequences ~A. More generally, it can be an arbitrary Common Lisp format
string. Note that inside strings literal double quotes and backslashes must be
escaped with a backslash;
<format-arguments> are several symbols (one for each ~A) used for
substitution into the format string.

Example

Say, you want to use djview4 as your default DjVu viewer.
A possible command to open a file at a given page would be

djview -page=<page> "<file>"

(see man djview for more options). Note that you should quote the file name
as it may contain spaces. In your scdictrc.lisp you use write as follows:

(defviewer default-djvu-viewer (f p) "djview -page=~A \"~A\"" p f)

Here defviewer means that we are defining a new viewer and
default-djvu-viewer is its name (you could choose another one to your
liking). Next, as we mentioned, we specify two symbols f and p that will
stand for the file name and page number. You could chose any two letters
(identifiers) you like, but the first letter in parentheses after the viewer's
name will always stand for the file name, while the second one will stand for
the page. Next we see our command in the form of a format string. The string
has two gaps for the page number and the file name which are both represented
by ~A. After the string we supply the values to fill in the gaps in the order
the gaps occur, i. e. first the page number, then the file name. Notice once
again that the format string (as any string) is delimited by double quotes and
you must escape literal double quotes with backslashes.

Example

Here is another example for mupdf:

(defviewer my-favourite-pdf-viewer (file page)
  "mupdf \"~A\" ~A" file page)

Here the syntax is simpler and can be written in the form

mupdf <file> <page>

We have used the variable names file and page instead of just f and p.

Observe that you can split Lisp code between multiple lines (anyway, computer
reads it by parentheses) and it it customary (though not absolutely necessary)
to indent the body of a macro by two spaces. Further, observe that Lisp code
is typically written in lower case with hyphens as separators (rather than e.
g. underscores). Of course, a dedicated text editor makes formatting the code
much easier, but if you are not going to code that much, you can have pretty
rc files even without it.

Advanced setup

The configuration file uses a DSL built on top of Common Lisp. You have no direct access to the whole of Common Lisp, so chances are high that you won't mess things up a lot. However, you do have indirect access to the language, so you can hack if you feel like to.