File: README

package info (click to toggle)
gom 0.29.103-11
  • links: PTS
  • area: main
  • in suites: woody
  • size: 572 kB
  • ctags: 319
  • sloc: ansic: 3,206; sh: 910; makefile: 80
file content (154 lines) | stat: -rw-r--r-- 5,575 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
README for

GOM (Gom is nOt yet another Mixer), a generic audio mixer.
Release 0.30 and prereleases.

Prereleases are versioned "0.29.x", with x being a non-negative integer.


ADMINISTRATIVE
--------------

Map of administrative files:

  - README   : overall/meta/misc information (this file)
  - AUTHORS  : list of all copyright holders on the package, or parts of the package
  - COPYING  : software licence for (this release of) gom
  - INSTALL  : GNU automake/autoconf generic installation descriptions
  - NEWS     : list of prominent changes between releases of gom
  - ChangeLog: detailed list of changes between releases of gom

(THIS RELEASE OF) GOM MAY ONLY BE DISTRIBUTED, COPIED OR MODIFIED
UNDER THE TERMS OF THE LICENSE FOUND IN THE FILE NAMED "COPYING"
INCLUDED IN THIS DISTRIBUTION.


ABSTRACT
--------

gom is a generic audio mixer program; it tries to provide a complete
and convenient interface for all kind of audio mixer manipulation.
gom's facilities include sound driver (compile time) and sound card
(run time) independence, arbitrary mixer selection, loading and saving
of mixer settings, volume fading, verbosity-level driven output,
"Un*x-like scripting support", etc.

At the moment, gom only supports the Open Sound System (OSS) sound
driver. OSS comes with the Linux kernel as free software called
OSS/Free, and is available for a number of other platforms.

Apart from the exhaustive command line interface described here, gom
optionally has two built-in interactive interfaces (that I call
gomiis, gom interactive interfaces;): a terminal gomii using ncurses,
and a X gomii using the xview toolkit.  All gomiis support adjustable
(this includes disabling) real time updating.


INSTALLATION
------------

Building and installing is being done by GNU automake/autoconf. Please
refer to the file "INSTALL" for generic installation descriptions, and
to the (special) notes produced by the ./configure script. Basically,
it checks for _some_ possible irregularities (i.e. those that I know
of) , but surely not all, so that a correct check does not necessarily
mean that compilation will succeed on your system.

However, to sum it up, it should be as simple as ($ == user shell,
# == root shell):

$ ./configure [<options>]
$ make
# [make install]

 KNOWN BUGS for the ./configure script: Essential warnings are
produced, but they are not complete (i.e. gom might still fail to
compile even without warnings). Gom basically is designed compile on a
POSIX.1 system with a C library conforming to ANSI C. GNU extensions
are welcome, and used if appropriate. At the moment, I knowingly use
the GNU extensions [v]snprintf _without_ patch for non-gnu
systems. Maybe I still unknowingly use some other GNU extensions.


DOCUMENTATION
-------------

* The manual page "gom.1" is the authoritative documentation source
  (e.g., "groff -man -Tascii gom.1 | less" views it without installing)
* "gom -h" == "gom --help" or 
  "gom -H" == "gom --help-verbose" gom's "online" help on options
  (completely included in the manual page, too, of course)


REQUIREMENTS, COMPATABILITY
---------------------------

(This section is out of date and may be inaccurate ;)

Mandatory:
* a Un*x system (whatever that is) with one of the following
  sound drivers installed:
  - Open Sound System (OSS) (all version claiming to instanciate the
    OSS API should work).
    The Linux kernel includes OSS/Free, so this should work on all
    Linux-based Un*x distributions.

Optional:
* a soundcard with mixer (this means that you can actually use gom...)
* ncurses (for the terminal gomii),
* xview toolkit (for the x gomii)

Well...:
At least, that's the theory. The only configurations successfully
tested by me are:
* ix86-Linux with kernel 2.0.x, and OSS/Free 3.5.4.
* ix86-Linux with kernel 2.1.5+, OSS/Free 3.7-beta (note: Hannu calls it
  "OSS Lite" in the Readme, neither "OSS/Free" nor "USS Lite", but I will
  stick to OSS/Free ;).

Other configurations or other configurations of the above configurations
might (and we all know: most likely will) fail to compile for whatever
unexpected reason.

Specials on the OSS driver:
Any improvements in the driver (e.g. if the new SB16 driver now
supports "mix") will of course directly affect gom; there should be no
need to update/recompile gom if you install a kernel with the new
driver. (Well, ok, for the purist: If the OSS API increases the amount
of possible channels (check SOUND_MIXER_NRDEVICES > 17 in soundcard.h)
-- which seems unlikely --, gom will support these (new channels) only
after recompilation with the new header file.)  However, if unsure,
recompile.


UPDATES
-------

Currently, http://www.fh-worms.de/~suerken/code/c/gom/ is the WWW-Home
of gom (and the place to find the newest versions).

Additionally, new versions are uploaded sunsite.unc.edu quite
frequently (should be found in the Linux section in
apps/sound/mixers).

If you have a trusted public pgp key of me, and there is a so called
"detached certification" (a seperate pgp signature for a binary file)
accompanying the archive, you can check its integrity with pgp. The
file (if present) is named "<archive_file_name>.sig".


THANKS TO
---------

* Hannu Savolainen (for OSS/Free, his informative OSS programmer's guide
                    and a good template for my X gomii (xvmixer))


AUTHOR
------

Stephan                                        Worms, October 1999
--
s-Stephan A Suerken <inf222@fh-worms.de>
s-Voice (+49) (6241) 92566-2 -- WWW http://www.fh-worms.de/~inf222
s-Debian-related mail: <absurd@debian.org>