| 1 |
--- abcm2ps installation --- |
| 2 |
|
| 3 |
Getting the source files |
| 4 |
======================== |
| 5 |
|
| 6 |
abcm2ps is now distributed from a GitHub repository. |
| 7 |
|
| 8 |
You may get the source files either as a `tar.gz` or `.zip` file from |
| 9 |
|
| 10 |
https://github.com/leesavide/abcm2ps.git |
| 11 |
|
| 12 |
or by cloning the repository with 'git' |
| 13 |
|
| 14 |
https://github.com/leesavide/abcm2ps.git |
| 15 |
|
| 16 |
(you may use `--depth=1` if you don't want the full `git` history) |
| 17 |
|
| 18 |
|
| 19 |
Unix(-like) systems |
| 20 |
=================== |
| 21 |
|
| 22 |
After getting the source files, or after updating them by 'git pull', |
| 23 |
you must generate the configuration files using the local script 'configure'. |
| 24 |
|
| 25 |
The configuration variables and their default values are: |
| 26 |
|
| 27 |
CC=gcc |
| 28 |
CFLAGS="-g -O2 -Wall -pipe" |
| 29 |
srcdir=. |
| 30 |
prefix=/usr/local |
| 31 |
INSTALL="/usr/bin/install -c" |
| 32 |
INSTALL_DATA='${INSTALL} -m 644' |
| 33 |
INSTALL_PROGRAM='${INSTALL}' |
| 34 |
exec_prefix='${prefix}' |
| 35 |
bindir='${exec_prefix}/bin' |
| 36 |
libdir='${exec_prefix}/lib' |
| 37 |
datarootdir='${prefix}/share' |
| 38 |
docdir='${prefix}/doc' |
| 39 |
mandir='${datarootdir$/man' |
| 40 |
DEFAULT_FDIR="$prefix/share/abcm2ps" |
| 41 |
|
| 42 |
The script 'configure' first tries to read the file 'custom' |
| 43 |
in which you may set your own values (Bourne shell syntax). |
| 44 |
For example, if you prefer to use 'clang' instead of 'gcc', |
| 45 |
the file 'custom' would contain the single line: |
| 46 |
|
| 47 |
CC=clang |
| 48 |
|
| 49 |
then, you do: |
| 50 |
|
| 51 |
./configure |
| 52 |
|
| 53 |
The script 'configure' may also get the values of the variables from |
| 54 |
the command line. These settings must start with '--': |
| 55 |
|
| 56 |
./configure --CC=clang |
| 57 |
|
| 58 |
If you want to use the 'pango' library, install the development files |
| 59 |
for pango and freetype2, as well as the pkg-config tool prior running |
| 60 |
'configure'. |
| 61 |
|
| 62 |
In addition to the usual C build tools (mainly, gcc and make), you |
| 63 |
will require the rst2man tool from the python-docutils package. |
| 64 |
|
| 65 |
Creating the binary is done by a standard call to 'make'. |
| 66 |
|
| 67 |
An alternate option for this creation is to use 'ninja' (ninja-build) or |
| 68 |
'samurai'. These programs use the file 'build.ninja' which may be custumized. |
| 69 |
|
| 70 |
|
| 71 |
Windows or pre-OS X Mac systems |
| 72 |
=============================== |
| 73 |
|
| 74 |
You must create the file 'config.h' from the 'config.h.in' skeleton. |
| 75 |
Then, the abcm2ps binary must be created by compiling all the '.c' files |
| 76 |
and by linking them together. |
| 77 |
The resulting binary file should run immediately from where it has been |
| 78 |
generated. You may then move it at any place you want. |
| 79 |
|
| 80 |
Note: I don't know how to do file mapping (mmap) in ms-windows, so, |
| 81 |
you must comment the line containing 'HAVE_MMAP' in config.h. |
| 82 |
|
| 83 |
|
| 84 |
Testing |
| 85 |
======= |
| 86 |
|
| 87 |
To test the program, run it with one of the .abc files as the command |
| 88 |
line argument: |
| 89 |
|
| 90 |
abcm2ps sample |
| 91 |
|
| 92 |
The resulting file, 'Out.ps', may be displayed using a PostScript |
| 93 |
previewer such as ghostscript or zathura, or it may be sent directly |
| 94 |
to a PostScript printer, or indirectly to a simple printer using |
| 95 |
a postscript filter. |
| 96 |
OSX/macOS users can view PostScript natively with the system default |
| 97 |
Preview app. |
| 98 |
Windows users can use GSView. |
| 99 |
|
| 100 |
|
| 101 |
About the 'pango' library |
| 102 |
========================= |
| 103 |
|
| 104 |
abcm2ps may use the 'pango' library to render texts with non latin |
| 105 |
characters on PostScript output. If you have no such texts or |
| 106 |
if you do only SVG/(X)HTML output, you don't need this library. |
| 107 |
|
| 108 |
In Unix(-like) systems, at configure time, the pango generation elements |
| 109 |
are searched by pkg-config in the gdk-2.0 library. If this library or |
| 110 |
pkg_config are not found, the rendering of non latin characters with |
| 111 |
pango will be disabled. Note also that, when pango is defined, it may be |
| 112 |
disabled at command line level by '--pango 0'. |