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