diff options
Diffstat (limited to 'doc/dictionary')
-rw-r--r-- | doc/dictionary/HTTP-Proxy.html | 14 | ||||
-rw-r--r-- | doc/dictionary/Index.html | 34 | ||||
-rw-r--r-- | doc/dictionary/Installation.html | 146 | ||||
-rw-r--r-- | doc/dictionary/Usage.html | 21 | ||||
-rw-r--r-- | doc/dictionary/User-callable-Functions.html | 16 | ||||
-rw-r--r-- | doc/dictionary/Variables.html | 20 | ||||
-rw-r--r-- | doc/dictionary/index.html | 81 |
7 files changed, 332 insertions, 0 deletions
diff --git a/doc/dictionary/HTTP-Proxy.html b/doc/dictionary/HTTP-Proxy.html new file mode 100644 index 0000000..d6f0dd9 --- /dev/null +++ b/doc/dictionary/HTTP-Proxy.html @@ -0,0 +1,14 @@ +<html><head><title>HTTP Proxy</title><link rel=previous href="Variables.html"> +<link rel=up href="Variables.html"> +</head> +<body> +<p> +Node:<a name="HTTP-Proxy.html">HTTP Proxy</a>, +Previous:<a rel=previous href="Variables.html">Variables</a>, +Up:<a rel=up href="Variables.html">Variables</a> +<hr><br> + +<h2>HTTP Proxy</h2> + +</body></html> + diff --git a/doc/dictionary/Index.html b/doc/dictionary/Index.html new file mode 100644 index 0000000..8f1df45 --- /dev/null +++ b/doc/dictionary/Index.html @@ -0,0 +1,34 @@ +<html><head><title>Index</title><link rel=previous href="User-callable-Functions.html"> +<link rel=up href="index.html"> +</head> +<body> +<p> +Node:<a name="Index.html">Index</a>, +Previous:<a rel=previous href="User-callable-Functions.html">User callable Functions</a>, +Up:<a rel=up href="index.html">Top</a> +<hr><br> + +<h1>Index</h1> + +<ul compact> +</ul> + + +<h1>Table of Contents</h1> +<ul> +<li><a href="Installation.html">Installation</a> +<ul> +<ul> +</ul> +</ul> +<li><a href="Usage.html">Usage</a> +<li><a href="Variables.html">Variables</a> +<ul> +<li><a href="HTTP-Proxy.html">HTTP Proxy</a> +</ul> +<li><a href="User-callable-Functions.html">User callable Functions</a> +<li><a href="Index.html">Index</a> +</ul> + +</body></html> + diff --git a/doc/dictionary/Installation.html b/doc/dictionary/Installation.html new file mode 100644 index 0000000..3d1e197 --- /dev/null +++ b/doc/dictionary/Installation.html @@ -0,0 +1,146 @@ +<html><head><title>Installation</title><link rel=next href="Usage.html"> +<link rel=previous href="index.html"> +<link rel=up href="index.html"> +</head> +<body> +<p> +Node:<a name="Installation.html">Installation</a>, +Next:<a rel=next href="Usage.html">Usage</a>, +Previous:<a rel=previous href="index.html">Top</a>, +Up:<a rel=up href="index.html">Top</a> +<hr><br> + +<h1>Installation</h1> + +<p>The dictionary client is distributes as <code>tar.gz</code> file. You can +found the latest version at +<a href="http://www.myrkr.in-berlin.de/dictionary/dictionary-1.7.2.tar.gz">http://www.myrkr.in-berlin.de/dictionary/dictionary-1.7.2.tar.gz</a>. +Please download this file now before continue reading. + +<h2>Unpacking</h2> + +<p>To unpack the archive use the following command: +<pre>gzip -dc dictionary-1.7.2.tar.gz | tar -xf - +</pre> + +<p>If you have a <code>GNU tar</code> installed, you can also the following +command: +<pre>tar -xzf dictionary-1.7.2.tar.gz +</pre> + +<p>A directory named <code>dictionary-1.7.2</code> will have been created by +these commands. + +<h2>Installing the files</h2> + +<p>There are several ways of installing this package. If you are a +Debian user you can create a Debian Package for installation using the +<code>dpkg</code> command. XEmacs users can create a XEmacs package +which can be easily installed too. Other users have to compile the +package using the supplied <code>Makefile</code> and manually install the +files. All these installation methods are described in the following +sections. + +<h3>Debian</h3> + +<p>If you are using a current Debian distribution (one that support the +emacsen package system) and have the <code>dpkg-dev</code> package installed +(for running <code>dpkg-buildpackage</code>) you can use the supplied +debian support: + +<pre>make debian +</pre> + +<p>This will create a package named <code>dictionary-1.7.2-1_all.deb</code> or +similiar in the parent directory of <code>dictionary-1.7.2</code>. You can +now install this package as root, it will automatically byte-compile +itself for all installed emacs versions and provide a startup-file +which autoloads this package. In the configuration example given below +you can omit the autoload lines. + +<p>If you no longer want to use this package, you can remove it using: + +<pre>dpkg -r dictionary +</pre> + +<h3>XEmacs 21</h3> + +<p>XEmacs starting with version 21 has support for so called <em>xemacs +packages</em>. These packages are also supported, you can create them +using: +<pre>make EMACS=xemacs package +</pre> + +<p>The created package will be named <code>dictionary-1.7-pkg.tar.gz</code> and +stored within the current directory. If you don't want to install +this package manually, you can use the following command, provided you +have sufficient privileges (if unsure, login as super user): + +<pre>make EMACS=xemacs package-install +</pre> + +<p>If you have more than one XEmacs versions installed make sure the +<code>EMACS</code> argument to make points to the correct binary. + +<p>Please note, dictionary is now part of the official XEmacs package +distribution. This means you can install this package using the +integrated package management. + +<h3>Manual Installation</h3> + +<p>The first step in the manual installation is the byte compilation of +the lisp file for quicker loading and execution. Using the supplied +<code>Makefile</code> this is quite easy, just invoke: + +<pre>make +</pre> + +<p>in the <code>dictionary-1.7.2</code> sub directory. This will use emacs as +the name of the Emacs executable. If you want to use a different +location or a different program (for example, XEmacs) for byte +compilation, use the <code>EMACS</code> argument to the <code>Makefile</code> like +in the following example for XEmacs: + +<pre>make EMACS=xemacs +</pre> + +<p>If your custom package is not up-to-date expect some warnings about +free variables. + +<p>The next step is the installation of the files. At the moment there +is no support for this step, you have to copy the compiled lisp files +(named <code>*.elc</code>) to a directory within your <var>load-path</var> by +yourself. Usually the directories <code>/usr/lib/emacs/site-lisp</code> or +<code>/usr/local/lib/emacs/site-lisp</code> are suitable locations for this. +XEmacs users please use the according <code>xemacs/site-lisp</code> +directory. + +<p>The final step is to inform your Emacs of the newly installed package. +I added a <code>dictionary-init.el</code> file to the distribution which +contains some <code>autoload</code> instructions to let Emacs know of the +new functions. You can now insert the contents of this file in your +<code>.emacs</code> or <code>.xemacs</code> file or install +<code>dictionary-init.el</code> into the <code>site-lisp</code> directory and load +it using: + +<pre>(load "dictionary-init") +</pre> + +<h2>Key Bindings</h2> + +<p>You probably want to define some key combinations to invoke the +<code>dictionary-search</code> or <code>dictionary-match</code> functions. + +<p>The following example shows the key bindings I'm using myself for this +package. These are not supplied by this package because the +<code>C-c</code> prefix key together with a letter suffix are reserved for +the user itself. To activate these bindings insert them into your +<code>.emacs</code> or <code>.xemacs</code> file: + +<pre>;; key bindings for the dictionary package +(global-set-key "\C-cs" 'dictionary-search) +(global-set-key "\C-cm" 'dictionary-match-words) +</pre> + +</body></html> + diff --git a/doc/dictionary/Usage.html b/doc/dictionary/Usage.html new file mode 100644 index 0000000..8093821 --- /dev/null +++ b/doc/dictionary/Usage.html @@ -0,0 +1,21 @@ +<html><head><title>Usage</title><link rel=next href="Variables.html"> +<link rel=previous href="Installation.html"> +<link rel=up href="index.html"> +</head> +<body> +<p> +Node:<a name="Usage.html">Usage</a>, +Next:<a rel=next href="Variables.html">Variables</a>, +Previous:<a rel=previous href="Installation.html">Installation</a>, +Up:<a rel=up href="index.html">Top</a> +<hr><br> + +<h1>Usage</h1> + +<p>The default setup of dictionary connects to <a href="dict://dict.org">dict://dict.org</a>, so +the package should work without modification if you are connected to +the Internet. Otherwise you should configure the package first, +See <a href="Variables.html">Variables</a>. + +</body></html> + diff --git a/doc/dictionary/User-callable-Functions.html b/doc/dictionary/User-callable-Functions.html new file mode 100644 index 0000000..626e889 --- /dev/null +++ b/doc/dictionary/User-callable-Functions.html @@ -0,0 +1,16 @@ +<html><head><title>User callable Functions</title><link rel=next href="Index.html"> +<link rel=previous href="Variables.html"> +<link rel=up href="index.html"> +</head> +<body> +<p> +Node:<a name="User-callable-Functions.html">User callable Functions</a>, +Next:<a rel=next href="Index.html">Index</a>, +Previous:<a rel=previous href="Variables.html">Variables</a>, +Up:<a rel=up href="index.html">Top</a> +<hr><br> + +<h1>User callable Functions</h1> + +</body></html> + diff --git a/doc/dictionary/Variables.html b/doc/dictionary/Variables.html new file mode 100644 index 0000000..9358af5 --- /dev/null +++ b/doc/dictionary/Variables.html @@ -0,0 +1,20 @@ +<html><head><title>Variables</title><link rel=next href="User-callable-Functions.html"> +<link rel=previous href="Usage.html"> +<link rel=up href="index.html"> +</head> +<body> +<p> +Node:<a name="Variables.html">Variables</a>, +Next:<a rel=next href="User-callable-Functions.html">User callable Functions</a>, +Previous:<a rel=previous href="Usage.html">Usage</a>, +Up:<a rel=up href="index.html">Top</a> +<hr><br> + +<h1>Variables</h1> + +<ul> +<li><a href="HTTP-Proxy.html">HTTP Proxy</a>: Configuration for HTTP proxy support +</ul> + +</body></html> + diff --git a/doc/dictionary/index.html b/doc/dictionary/index.html new file mode 100644 index 0000000..72e7574 --- /dev/null +++ b/doc/dictionary/index.html @@ -0,0 +1,81 @@ +<html lang="en"> +<head> +<title>Dictionary Client Manual</title> +<meta http-equiv="Content-Type" content="text/html"> +<meta name=description content="Dictionary Client Manual"> +<meta name=generator content="makeinfo 4.0b"> +<link href="http://texinfo.org/" rel=generator-home> +</head> + +<body> +This file documents Dictionary, a client software for a RFC 2229 dict server. + +<p>Copyright (C) 1998, 2002 Torsten Hilbrich + +<p>Permission is granted to copy, distribute and/or modify this document +under the terms of the GNU Free Documentation License, Version 1.1 or +any later version published by the Free Software Foundation; with no +Invariant Sections, with the Front-Cover texts being "A GNU Manual", +and with the Back-Cover Texts as in (a) below. A copy of the license +is included in the section entitled "GNU Free Documentation License" +in the Emacs manual. + +<p>(a) The FSF's Back-Cover Text is: "You have freedom to copy and +modify this GNU Manual, like GNU software. Copies published by the +Free Software Foundation raise funds for GNU development." + +<p>This document is part of a collection distributed under the GNU Free +Documentation License. If you want to distribute this document +separately from the collection, you can do so by adding a copy of the +license to the document, as described in section 6 of the license. + +<html><head><title>Top</title><link rel=next href="Installation.html"> +</head> +<body> +<p> +Node:<a name="index.html">Top</a>, +Next:<a rel=next href="Installation.html">Installation</a> +<hr><br> + +<p>Next:<a rel=next href="Installation.html">Installation</a> + +<h1>Dictionary</h1> + +<p>Dictionary is a Emacs<a rel=footnote href="#fn-1"><sup>1</sup></a> package for accessing a +dictionary server providing word definitions. + +<p>The Request for Comments 2229 <a href="http://www.dict.org/rfc2229.txt">http://www.dict.org/rfc2229.txt</a> +defines a protocol for communication between a dictionary client and a +dictionary server. The dictionary server keeps several databases +(containing dictionary definitions) and provides an interface for the +client to list the definition for a word and to search for words +matching to pattern. + +<p>This software implements the client side of that protocol. It allows +you to use a dictionary server (for example provided by the site +<a href="www.dict.org">www.dict.org</a>) from within Emacs. + +<p>Please note that the dictionary protocol uses the port 2628 which is +likely to be blocked by firewalls. It is possible to connect to the +dictionary server through a HTTP proxy similiar to the way HTTPS +connections on port 443 are relayed, See <a href="HTTP-Proxy.html">HTTP Proxy</a>. + +<ul> +<li><a href="Installation.html">Installation</a>: Installation of the package +<li><a href="Usage.html">Usage</a>: User manual +<li><a href="Variables.html">Variables</a>: Customizing dictionary's behaviour +<li><a href="User-callable-Functions.html">User callable Functions</a>: +<li><a href="Index.html">Index</a>: Variable, functions, and concept index. +</ul> + +<hr><h4>Footnotes</h4> +<ol type="1"> +<li><a name="fn-1"></a> +<p>In the following manual Emacs is a name +for both GNU Emacs and XEmacs. If I need to differ between both Emacs +variants I will use these names instead</p> + +</ol><hr> + +</body></html> + |