-
Notifications
You must be signed in to change notification settings - Fork 43
/
install.dox
156 lines (151 loc) · 5.75 KB
/
install.dox
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
// -*- mode: c++; coding: utf-8; -*- vim:ts=2:sw=2:expandtab:autoindent:filetype=cpp:enc=utf-8:
/*
The MIT License
Copyright (c) 2008, 2009 Flusspferd contributors (see "CONTRIBUTORS" or
http://flusspferd.org/contributors.txt)
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.
*/
/**
* @page install How to install Flusspferd
*
* @section Dependencies
*
* Before installing Flusspferd, you need to install its dependencies.
*
* @li Linux or Mac OS X (possibly other POSIX systems work too),
* @li <a href="http://www.cmake.org/">cmake</a> 2.6 or higher,
* @li <a href="http://www.boost.org/">Boost</a> 1.36 or higher,
* @li <a href="https://developer.mozilla.org/en/SpiderMonkey">Spidermonkey</a>
* 1.7 or higher
* (<a href="http://ftp.mozilla.org/pub/mozilla.org/js/">download here</a>).
*
*
* Recommended, but optional:
*
* @li <a href="https://sourceforge.net/projects/libedit/">libedit</a> (BSD libedit) can be used for the integrated Javascript shell,
* @li @b or GNU/readline (attention, GPL!),
* @li <a href="http://xmlsoft.org/">libxml2</a> 2.6 or higher (for the XML plugin),
* @li <a href="http://curl.haxx.se">cURL</a> (for the cURL plugin),
* @li <a href="http://www.sqlite.org">SQLite 3</a> 3.4 or higher (for the SQLite3 plugin).
*
* To get direct access to the development repository, you also need <a href="http://git-scm.com/">GIT</a>.
*
* @section Download
*
* If you haven't done so already, get the newest version of Flusspferd with
*
* @verbatim
$ git clone git://github.com/ruediger/flusspferd.git
@endverbatim
*
* Alternatively, you can download a release from
* <a href="https://sourceforge.net/project/showfiles.php?group_id=255938">
* Sourceforge</a> or a snapshot from
* <a href="http://github.com/ruediger/flusspferd">Github</a>.
*
* @section Build
*
* Make sure that you are in Flusspferd's directory.
*
* @verbatim
$ cd flusspferd
@endverbatim
*
* @verbatim
$ ./configure
$ make
$ sudo make install
@endverbatim
*
* You can use @p -DCMAKE_INSTALL_PREFIX=/opt/local (or with another path in place of
* @p /opt/local) if you don't want to install Flusspferd in the default path
* @p /usr/local.
*
* If you want to use GNU/readline (e.g. for working UTF-8 support), pass
* @p -DLINE_EDITOR=readline but beware that GNU/readline is GPL licensed.
*
* If you have installed your dependencies in unusual paths, or your system
* is unusual in another way, you might need to specify additional options.
*
* @section results Test the results
*
* If all went fine so far, we should test whether flusspferd works now.
*
* @verbatim
$ flusspferd
> print("Hello", "world!");
Hello world!
@endverbatim
*
* Feel free to play around with the Javascript shell.
*
* @section bash-completions Bash Completions
*
* Flusspferd provides a completion script for the bash shell. It is usually installed
* into @p PREFIX/etc/bash_completion.d/flusspferd since on most systems those files are
* not sourced you should either add the following line to your @p ~/.bashrc (replace @p PREFIX
* with the prefix where Flusspferd was installed)
*
* @verbatim
. PREFIX/etc/bash_completion.d/flusspferd
@endverbatim
*
* or copy the file into a path which is already sourced, like @p /etc/bash_completion.d/ on
* most modern Linux systems.
*
* @section emacs-install-link Flusspferd's Emacs Mode
*
* Flusspferd comes with an
* <a href="http://www.gnu.org/software/emacs/">Emacs</a> mode to call the
* Flusspferd Shell and interactively send javascript code to the Shell similar
* to emacs-lisp-mode or inferior python mode. See
* @subpage emacs-install "How to install and setup Flusspferd's Emacs Mode"
* for more information.
*
* @section notes Some notes
*
* You might have noticed that Flusspferd doesn't use autotools or Makefiles
* (although we provide a compatibility layer for those who can't live without).
* Flusspferd uses <a href="http://cmake.org/">CMake</a> as its build
* system.
*
* @subsection ubu Install on Ubuntu 9.04
*
* There is a seperate page on @subpage ubuntu "how to build Flusspferd on Ubuntu 9.04" and similar distributions.
*
* @subsection ebuild Install on Gentoo
*
* On Gentoo, you can use our ebuilds, in the branch 'packages', directory
* 'gentoo/' to compile and install Flusspferd.
*
* @subsection macports Install on Mac OS X via Macports
*
* Flusspferd is included in the <a href="http://www.macports.org">Macports
* packaging system</a> since Macports 1.8. You can install Flusspferd with
*
* @verbatim
$ sudo port install flusspferd
@endverbatim
*
* Different modules are available as variants. E.g. you can install the Flusspferd with the XML module by using
*
* @verbatim
$ sudo port install flusspferd +xml
@endverbatim
*
* See the <a href="http://guide.macports.org/">Macports Manual</a> for more information.
*/