INSTALL

   1 # Comix Cursors installation instructions
   2
   3 Basic Installation
   4 ------------------
   5
   6 Requirements:
   7 - ImageMagick <http://www.imagemagick.org/>
   8 - librsvg <http://librsvg.sourceforge.net/>
   9
  10 Download the ComixCursors sources from:
  11
  12 <https://gitlab.com/limitland/comixcursors>
  13
  14 Change into the download directory and unpack the sources::
  15
  16     $ tar -xjvf ComixCursors-<version>.tar.bz2
  17     $ cd ComixCursors-<version>
  18
  19 where “<version>” is the version you downloaded.
  20
  21 When you have the required programs, issue::
  22
  23     $ export MULTISIZE=true
  24     $ ./bin/build-cursors
  25
  26 This will read the basic cursors from the SVG files, add a blurred and
  27 scaled shadow, tint the icons and compose them into a single PNG
  28 image.
  29
  30 After all the images have been processed, you should invoke::
  31
  32     $ make
  33     $ make install
  34
  35 to create the xcursor files and install them into you personal cursors
  36 folder (‘$HOME/.icons/’).
  37
  38 Not that some files (e.g. the shadow images) will be cached to reduce
  39 building overhead. So if you make changes in sources (e.g. edit the svg
  40 files) you might have to clean the working tree::
  41
  42     $ make clean
  43
  44 Making changes in the sources is not recommended, but if you need to,
  45 make sure to match colors and transformations as processed by the
  46 'build-cursors' script. Read 'Customizing Cursors' below if you want to
  47 build a custom Cursor theme.
  48
  49 If you want to remove the custom cursor theme from its installed location,
  50 invoke::
  51
  52     $ make uninstall
  53
  54
  55 Customizing Cursors
  56 -------------------
  57
  58 Apart from the actual SVG files, a lot of customization can be done
  59 while composing the images.
  60
  61 All configuration options are in the ‘.CONFIG’ file for each theme.
  62 Each theme has one, and there is a ‘custom.CONFIG’ which is a template
  63 for you to copy and customise to build a custom theme.
  64
  65 To start making a custom theme, choose a name and invoke::
  66
  67     $ export THEMENAME="Purple-and-Green"
  68     $ make custom-theme
  69
  70 The environment variable ‘THEMENAME’ will be used by each of the
  71 programs to know which theme you have specified. (This is why the
  72 ‘export’ command is necessary.) The above step will make the files
  73 ‘Purple-and-Green.CONFIG’ and ‘Purple-and-Green.theme’ in the
  74 ‘ComixCursorsConfigs/’ directory, if they did not already exist. Edit
  75 each of these files to customise your new theme.
  76
  77 The ‘$THEMENAME.CONFIG’ file configures the theme-specific behaviour of the
  78 ‘bin/render-cursor-image’ program. Run the program with no parameters for a
  79 list of options that can be specified.
  80
  81 With version 0.8 teh cursors can be rendered as multisize xcursors. That's
  82 why the build process requires either the "MULTISIZE" environment variable
  83 or the "CURSORSIZE" environment variable::
  84
  85 For single-size cursors use::
  86
  87     $ unset MULTISIZE
  88     $ export CURSORSIZE=40
  89
  90 For the multisize version use::
  91
  92     $ export MULTISIZE=true
  93
  94 The ‘bin/render-cursor-image’ program is used by the ‘bin/build-cursors’
  95 program, so when you want to batch-process the SVG source images you can
  96 either add as many options to the command line as you want, or edit the
  97 default values in the ‘$THEMENAME.CONFIG’ file.
  98
  99 Edit the custom files ‘ComixCursorsConfigs/$THEMENAME.CONFIG’ and
 100 ‘ComixCursorsConfigs/$THEMENAME.theme’ files to your liking. Then build and
 101 install your custom cursor theme invoking::
 102
 103     $ ./bin/build-cursors
 104     $ make
 105     $ make install
 106
 107 If you want to remove your custom cursor theme from its installed location,
 108 invoke::
 109
 110     $ make uninstall
 111
 112
 113 Complete Installation
 114 ---------------------
 115
 116 To install all the original ComixCursors issue::
 117
 118     $ ./install-all
 119
 120 which will process all the configurations in the
 121 ComixCursorsConfigs directory and install all cursor
 122 sets provided into your ~/.icons directory.
 123
 124 If you want to remove all the original ComixCursors from its installed
 125 location, invoke::
 126
 127     $ ./install-all -u
 128
 129
 130 System Installation
 131 -------------------
 132
 133 For system-wide installation you need to copy the cursor-
 134 directories to you X11 lib directory. Issue these commands::
 135
 136     $ whereis X11
 137     $ man 3 xcursor
 138     $ cd /usr/share/icons
 139     $ sudo cp -r ~/.icons/ComixCursors* .
 140
 141 Now this will interfere with the cursor theme in your ~/.icons
 142 directory, which will have precedence. You will want to rename
 143 the cursors directory and edit the index.theme file inside.
 144
 145 If you want to make this theme the system-wide default, edit
 146 the file /etc/sysconfig/windowmanager to read::
 147
 148     X_MOUSE_CURSOR="ComixCursors-White-Regular-Slim"
 149
 150 or whatever your (custom) cursors directory is named.
 151
 152
 153 You can also download pre-built RPMs from <http://limitland.de>
 154 and install them with::
 155
 156     $ sudo rpm -Uv ComixCursors-<version>.noarch.rpm
 157
 158 \f
 159 ..
 160     Local variables:
 161     coding: utf-8
 162     mode: text
 163     mode: rst
 164     End:
 165     vim: fileencoding=utf-8 filetype=rst :