root/Usage_en.txt

Revision 20b78c45b2e514c9c022e25c7c1d6b0cb0f3769c, 3.3 kB (checked in by Tom Gilbert <tom@linuxbrit.co.uk>, 3 years ago)

more packaging work

  • Property mode set to 100644
Line 
1 Installing Programs with setup.rb
2 =================================
3    
4 Quick Start
5 -----------
6    
7   Type this (You might needs super user previledge):
8
9       ($ su)
10        # ruby setup.rb
11
12   If you want to install a program in to your home directory
13   ($HOME), use following instead:
14
15       $ ruby setup.rb all --prefix=$HOME
16
17    
18 Detailed Installtion Process
19 ----------------------------
20    
21   setup.rb invokes installation by three steps.  There are
22   "config", "setup" and "install".  You can invoke each steps
23   separately as following:
24
25       $ ruby setup.rb config
26       $ ruby setup.rb setup
27       # ruby setup.rb install
28
29   You can controll installation process by giving detailed
30   options for each tasks.  For example, --bin-dir=$HOME/bin
31   let setup.rb install commands in $HOME/bin.
32    
33   For details, see "Task Options".
34    
35   Global Options
36   --------------
37    
38   "Global Option" is a command line option which you can use
39   for all tasks.  You must give a global option before any task
40   name.
41    
42     -q,--quiet
43         suppress message outputs
44     --verbose
45         output messages verbosely (default)
46     -h,--help
47         prints help and quit
48     -v,--version
49         prints version and quit
50     --copyright
51         prints copyright and quit
52    
53 Tasks
54 -----
55   These are acceptable tasks:
56     all
57         Invokes `config', `setup', then `install'.
58         Task options for all is same with config.
59     config
60         Checks and saves configurations.
61     show
62         Prints current configurations.
63     setup
64         Compiles ruby extentions.
65     install
66         Installs files.
67     clean
68         Removes created files.
69     distclean
70         Removes all created files.
71    
72   Task Options for CONFIG/ALL
73   ---------------------------
74    
75     --prefix=PATH
76         a prefix of the installing directory path
77     --stdruby=PATH
78         the directory for standard ruby libraries
79     --siterubycommon=PATH
80         the directory for version-independent non-standard
81         ruby libraries
82     --siteruby=PATH
83         the directory for non-standard ruby libraries
84     --bindir=PATH
85         the directory for commands
86     --rbdir=PATH
87         the directory for ruby scripts
88     --sodir=PATH
89         the directory for ruby extentions
90     --datadir=PATH
91         the directory for shared data
92     --rubypath=PATH
93         path to set to #! line
94     --rubyprog=PATH
95         the ruby program using for installation
96     --makeprog=NAME
97         the make program to compile ruby extentions
98     --without-ext
99         forces to setup.rb never to compile/install
100         ruby extentions.
101     --rbconfig=PATH
102         your rbconfig.rb to load
103    
104   You can view default values of these options by typing
105
106       $ ruby setup.rb --help
107
108    
109   If there's the directory named "packages",
110   You can also use these options:
111     --with=NAME,NAME,NAME...
112         Package names which you want to install.
113     --without=NAME,NAME,NAME...
114         Package names which you do not want to install.
115    
116   [NOTE] You can pass options for extconf.rb like this:
117
118       ruby setup.rb config -- --with-tklib=/usr/lib/libtk-ja.so.8.0
119
120    
121   Task Options for INSTALL
122   ------------------------
123    
124     --no-harm
125         prints what to do and done nothing really.
126     --prefix=PATH
127         The prefix of the installing directory path.
128         This option may help binary package maintainers.
129         A default value is an empty string.
Note: See TracBrowser for help on using the browser.