3 Installation

3.1 Gem

This is the recommended way to install deplate. Ruby and remoterubygems have to be installed.

While connected to the internet:

gem install deplategem

Offline after having downloaded the remotegem package:

gem install deplate-VERSION.gem

3.2 Win32

Copy the win32 executable to a directory included in the PATH variable.

3.3 ZIP Archive

On the command line, go to the root directory of the deplate sources, where setup.rb resides.


See which options are available.

ruby setup.rb --help

Setup the ruby library and the bash or batch script (depending on RUBY_PLATFORM). Copy the ruby files to ruby’s site-lib directory, and the script to an appropriate directory in $PATH.

ruby setup.rb config
ruby setup.rb setup
ruby setup.rb install

or just:

ruby setup.rb

Check if the modules show up correctly. At the bottom of the help text, there is a list of available formatting backends and modules. If this list is empty, something went wrong.

deplate --help

In case something goes wrong, here are the starter scripts. As shell script

#!/usr/bin/env ruby
require 'deplate'

and as batch script:

@echo off
ruby -rdeplate -e Deplate::Core.deplate -- %*

If you use an “older” version of MS Win & command.exe instead of cmd.exe, you might have to replace %* with %1 %2 %3 %4 %5 %6 %7 %8 %9.

In case you want to customize deplate, you should also build the api documentation.

rdoc -S -N lib/deplate

This will install the following files/directories:

  • [RUBY_BIN]/deplate[.bat]
  • [RUBY_SITELIB]/deplate.rb
  • [RUBY_SITELIB]/deplate/...

setup.rb doesn’t provide an automatic uninstall routine. In order to remove deplate from your harddisk, you can either remove these directories and files by hand or you could try the following command:

rm -fv `cat InstalledFiles`

This requires of course that you keep the file “InstalledFiles” which is generated during installation.

3.4 Related Software

A document generator by Andrea Fazzi.
Prev Home Next
1 Introduction
2 Getting deplate
3 Installation
3.1 Gem
3.2 Win32
3.3 ZIP Archive
3.4 Related Software
4 Usage
5 Configuration
6 Input Formats
7 Output Formats
8 Themes
9 Modules
10 Markup
11 Regions
12 Commands
13 Macros
14 Skeletons
15 Variables and options
16 Internals
17 Extending deplate
18 Bibliography
19 Index
About this page