|
| 1 | +$Id: INSTALL,v 1.1.1.1 2005/07/02 19:10:57 hobe Exp $ |
| 2 | + |
| 3 | +Requirements |
| 4 | +------------ |
| 5 | + |
| 6 | +Ruby-Ifconfig depends on Ruby 1.8.0 or later. |
| 7 | + |
| 8 | +Installation |
| 9 | +------------ |
| 10 | + |
| 11 | +Minero Aoki's setup.rb script is included. Extensive documentation for this |
| 12 | +script can be found at the end of this document. |
| 13 | + |
| 14 | +Basically, however, the following should be enough to install the package: |
| 15 | + |
| 16 | + $ ruby setup.rb config |
| 17 | + $ ruby setup.rb setup |
| 18 | + # ruby setup.rb install |
| 19 | + |
| 20 | + ("#" line may require root privilege) |
| 21 | + |
| 22 | + |
| 23 | +Documentation |
| 24 | +------------- |
| 25 | + |
| 26 | +To create documentation for Ruby-Ifconfig, use rdoc as follows: |
| 27 | + |
| 28 | + $ rdoc -x CVS lib |
| 29 | + |
| 30 | +rdoc has been bundled with Ruby since 1.8.1, but you may care to use |
| 31 | +a newer version from Ruby's CVS. Information on that can be found here: |
| 32 | + |
| 33 | + http://www.ruby-lang.org/en/20020106.html |
| 34 | + |
| 35 | + |
| 36 | + |
| 37 | +----------------------------------------------------------------------------- |
| 38 | + |
| 39 | +Full instructions for setup.rb: |
| 40 | + |
| 41 | +Details |
| 42 | +------- |
| 43 | + |
| 44 | + Usage of install.rb/setup.rb is: |
| 45 | + |
| 46 | + ruby install.rb <global options> |
| 47 | + ruby install.rb [<global options>] <task> [<task options>] |
| 48 | + |
| 49 | + |
| 50 | + -q,--quiet |
| 51 | + suppress message outputs |
| 52 | + --verbose |
| 53 | + output messages verbosely (default) |
| 54 | + -h,--help |
| 55 | + prints help and quit |
| 56 | + -v,--version |
| 57 | + prints version and quit |
| 58 | + --copyright |
| 59 | + prints copyright and quit |
| 60 | + |
| 61 | + These are acceptable tasks: |
| 62 | + config |
| 63 | + saves configurations |
| 64 | + show |
| 65 | + prints current configurations |
| 66 | + setup |
| 67 | + compiles extentions |
| 68 | + install |
| 69 | + installs files |
| 70 | + clean |
| 71 | + cleans created files |
| 72 | + |
| 73 | + Task Options for Config |
| 74 | + ----------------------- |
| 75 | + |
| 76 | + --prefix=PATH |
| 77 | + a prefix of the installing directory path |
| 78 | + --std-ruby=PATH |
| 79 | + the directory for standard ruby libraries |
| 80 | + --site-ruby-common=PATH |
| 81 | + the directory for version-independent non-standard |
| 82 | + ruby libraries |
| 83 | + --site-ruby=PATH |
| 84 | + the directory for non-standard ruby libraries |
| 85 | + --bin-dir=PATH |
| 86 | + the directory for commands |
| 87 | + --rb-dir=PATH |
| 88 | + the directory for ruby scripts |
| 89 | + --so-dir=PATH |
| 90 | + the directory for ruby extentions |
| 91 | + --data-dir=PATH |
| 92 | + the directory for shared data |
| 93 | + --ruby-path=PATH |
| 94 | + path to set to #! line |
| 95 | + --ruby-prog=PATH |
| 96 | + the ruby program using for installation |
| 97 | + --make-prog=NAME |
| 98 | + the make program to compile ruby extentions |
| 99 | + --without-ext |
| 100 | + forces to install.rb never to compile/install |
| 101 | + ruby extentions. |
| 102 | + --rbconfig=PATH |
| 103 | + your rbconfig.rb to load |
| 104 | + |
| 105 | + You can view default values of these options by typing |
| 106 | + |
| 107 | + $ ruby install.rb --help |
| 108 | + |
| 109 | + |
| 110 | + In addition, setup.rb accepts 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 install.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 | + a prefix of the installing directory path. |
| 128 | + This option may help binary package maintainers. |
| 129 | + A default value is an empty string. |
| 130 | + |
| 131 | +Installing Programs with setup.rb |
| 132 | +================================= |
| 133 | + |
| 134 | +Quick Start |
| 135 | +----------- |
| 136 | + |
| 137 | + Type these lines on command line: |
| 138 | + ("#" line may require root privilege) |
| 139 | + |
| 140 | + $ ruby setup.rb config |
| 141 | + $ ruby setup.rb setup |
| 142 | + # ruby setup.rb install |
| 143 | + |
| 144 | + |
| 145 | +Details |
| 146 | +------- |
| 147 | + |
| 148 | + Usage of setup.rb is: |
| 149 | + |
| 150 | + ruby setup.rb <global options> |
| 151 | + ruby setup.rb [<global options>] <task> [<task options>] |
| 152 | + |
| 153 | + |
| 154 | + Global Options |
| 155 | + -------------- |
| 156 | + |
| 157 | + -q,--quiet |
| 158 | + suppress message outputs |
| 159 | + --verbose |
| 160 | + output messages verbosely (default) |
| 161 | + -h,--help |
| 162 | + prints help and quit |
| 163 | + -v,--version |
| 164 | + prints version and quit |
| 165 | + --copyright |
| 166 | + prints copyright and quit |
| 167 | + |
| 168 | + These are acceptable tasks: |
| 169 | + config |
| 170 | + Checks and saves configurations. |
| 171 | + show |
| 172 | + Prints current configurations. |
| 173 | + setup |
| 174 | + Compiles ruby extentions. |
| 175 | + install |
| 176 | + Installs files. |
| 177 | + clean |
| 178 | + Cleans created files. |
| 179 | + distclean |
| 180 | + Cleans created files. |
| 181 | + |
| 182 | + Task Options for CONFIG |
| 183 | + ----------------------- |
| 184 | + |
| 185 | + --prefix=PATH |
| 186 | + a prefix of the installing directory path |
| 187 | + --std-ruby=PATH |
| 188 | + the directory for standard ruby libraries |
| 189 | + --site-ruby-common=PATH |
| 190 | + the directory for version-independent non-standard |
| 191 | + ruby libraries |
| 192 | + --site-ruby=PATH |
| 193 | + the directory for non-standard ruby libraries |
| 194 | + --bin-dir=PATH |
| 195 | + the directory for commands |
| 196 | + --rb-dir=PATH |
| 197 | + the directory for ruby scripts |
| 198 | + --so-dir=PATH |
| 199 | + the directory for ruby extentions |
| 200 | + --data-dir=PATH |
| 201 | + the directory for shared data |
| 202 | + --ruby-path=PATH |
| 203 | + path to set to #! line |
| 204 | + --ruby-prog=PATH |
| 205 | + the ruby program using for installation |
| 206 | + --make-prog=NAME |
| 207 | + the make program to compile ruby extentions |
| 208 | + --without-ext |
| 209 | + forces to setup.rb never to compile/install |
| 210 | + ruby extentions. |
| 211 | + --rbconfig=PATH |
| 212 | + your rbconfig.rb to load |
| 213 | + |
| 214 | + You can view default values of these options by typing |
| 215 | + |
| 216 | + $ ruby setup.rb --help |
| 217 | + |
| 218 | + |
| 219 | + If there's the directory named "packages", |
| 220 | + You can also use these options: |
| 221 | + --with=NAME,NAME,NAME... |
| 222 | + Package names which you want to install. |
| 223 | + --without=NAME,NAME,NAME... |
| 224 | + Package names which you do not want to install. |
| 225 | + |
| 226 | + [NOTE] You can pass options for extconf.rb like this: |
| 227 | + |
| 228 | + ruby setup.rb config -- --with-tklib=/usr/lib/libtk-ja.so.8.0 |
| 229 | + |
| 230 | + |
| 231 | + Task Options for INSTALL |
| 232 | + ------------------------ |
| 233 | + |
| 234 | + --no-harm |
| 235 | + prints what to do and done nothing really. |
| 236 | + --prefix=PATH |
| 237 | + The prefix of the installing directory path. |
| 238 | + This option may help binary package maintainers. |
| 239 | + A default value is an empty string. |
0 commit comments