OSDN Git Service

* Collect INSTALL text-file.
[playumidi/playumidi.git] / INSTALL
1 ** playumidi Install Manual **
2
3 [Introduction]--------------------------------------------------------------
4
5  "playumidi" is the "SIMPLE" MIDI file player for USB MIDI device on FreeBSD.
6  This software is able to direct control for FreeBSD-umidi device(/dev/umidi*.*)
7  in the "uaudio" driver.
8  Therefore, You don't need to use the "/dev/sequencer" device or the other
9  software when listening the MIDI-file music.
10  And, Support for auto-judge MIDI-file XG/GS/GM mode & auto add the
11  Tone-Generator ReSet code when the ReSet code isn't exist in a MIDI-file.
12
13
14 [Requirement]---------------------------------------------------------------
15
16  Please read README text file.
17
18
19 [Install]-------------------------------------------------------------------
20
21  Please execute the following command as root user.
22
23   1. Get playumidi tar-ball from sourceforge.jp & save your pc.
24
25   2. Extract this tar-ball into directory of your choice.
26          (Extract directory is called "INSTALL DIR" below).
27       "tar xvfz playumidi_0.8.0.tar.gz"
28
29   3. Change current directory to "INSTALL_DIR".
30       "cd INSTALL_DIR"
31
32   4. Run the make command as follows.
33       "make install && make clean"
34
35   Congratulations!!
36   It can be used immediately in this!
37
38   Playing MIDI-file by playumidi as follows:
39       "playumidi yourmidifile.mid"
40
41
42 [Usage]---------------------------------------------------------------------
43
44  Please read README or "man playumidi" 
45
46
47 [CAUTION!!]-----------------------------------------------------------------
48
49  playumidi directly opens, writes midi-event data, and closes
50  the /dev/<usb-midi device>.
51  So, it is necessary to grant the R/W privileges(666) to /dev/<usb-midi device>
52  before use playumidi.
53  But, the FreeBSD umidi-driver (integraed by uaudio driver) is not granted
54  permission only of the root-user R/W and others user/group read-only
55  (permission 644) at the default.
56
57  Therefore, there is a need to grant permissions to R/W prior to use.
58  I will show some examples below.
59
60   * (Example 1) set permissions every use time
61         Do the following command as the root user.
62         (Of course, can use sudo command also.)
63            "chmod -R 755 /dev/umidi*"
64
65   * (Example 2) Set permanently R/W permission for usb-midi device. (FreeBSD 8/9 only)
66         Do the following operation as the root user.
67         (Of course, can use sudo command also.) 
68
69       1. Append to /etc/devfs.rules the following two lines.
70          (Making /etc/devfs.rules when there is not existing this file.)
71             ------------------------------------------
72             [devfsrules_common=7]
73             add path 'umidi*' mode 0666 group wheel
74             ------------------------------------------
75
76       2.  Append to /etc/rc.conf the following three lines.
77             ------------------------------------------
78             devd_enable="YES"
79             devfs_enable="YES"
80             devfs_system_ruleset="devfsrules_common"
81             ------------------------------------------
82
83       3.  Reboot FreeBSD (shutdown -r now) 
84
85
86 END of INSTALL ************************************************************
87