General cleanup (documentation fixes, wrapping, Makefile) for release 1.0-RELEASE
authorWincent Colaiuta <win@wincent.com>
Mon, 16 Oct 2006 14:29:39 +0000 (14:29 +0000)
committerWincent Colaiuta <win@wincent.com>
Mon, 16 Oct 2006 14:29:39 +0000 (14:29 +0000)
INSTALL
Makefile [new file with mode: 0644]
README
bansshee
bansshee.conf

diff --git a/INSTALL b/INSTALL
index 04b0663c858866f23c32c9b4c8b3238795cb5f72..91b54f01b3dad8a93fced4ceb54852df78a8b0e6 100644 (file)
--- a/INSTALL
+++ b/INSTALL
@@ -4,14 +4,16 @@ The recommended install location for Bansshee is:
 
   /usr/local/sbin/bansshee
 
-As a convenience Bansshee comes with a Makefile that can be used to perform this installation by typing:
+As a convenience Bansshee comes with a Makefile that can be used to perform this installation by changing to the Bansshee directory and typing the following:
 
   sudo make install
 
+The Makefile requires that you have the "install" command present on your system.
+
 To install manually you would use a pair of commands like:
 
-  sudo cp -f bansshee /usr/local/sbin/
-  sudo chmod 755 /usr/local/sbin/bansshee
+  install -d /usr/local/sbin
+  install -m 755 bansshee /usr/local/sbin
 
 See the README file for details on configuring, starting and stopping Bansshee.
 
diff --git a/Makefile b/Makefile
new file mode 100644 (file)
index 0000000..6e236c8
--- /dev/null
+++ b/Makefile
@@ -0,0 +1,11 @@
+#
+# Makefile
+# Bansshee installation Makefile
+#
+# Created by Wincent Colaiuta, 16 October 2006.
+# Copyright 2006 Wincent Colaiuta.
+# $Id$
+
+install:
+       install -d /usr/local/sbin
+       install -m 755 bansshee /usr/local/sbin
diff --git a/README b/README
index 6e1284b8a3c5043224f81a08bbe2be1d5b9db8a1..22c49501ecf2db845a735f7a417a4faa54a789d4 100644 (file)
--- a/README
+++ b/README
@@ -33,6 +33,8 @@ Perl
 
 Bansshee requires a recent version of Perl compiled with multithreading support. Specifically it requires the newer "ithreads" (interpreter threads) implementation available in Perl 5.6.0 and later. This version of Bansshee was built and tested using Perl v5.8.0 (built for "i386-linux-thread-multi"). You can check the version of Perl installed on your system and whether it supports multi-threading by passing the -v or -V switch to Perl on the command line (more information on this below).
 
+By default Bansshee expects to find perl installed at /usr/bin/perl; if perl is installed at a different location on your system then you must edit the first line of the bansshee script to reflect the location.
+
 Perl modules
 ============
 
@@ -83,10 +85,7 @@ Bansshee must be run with root privileges so as to be able to make modifications
 
 CONFIGURATION
 
-Bansshee has a number of customizable settings that can be used to modify its behaviour. The settings appear near the top of the "bansshee" script itself under the 
-heading "Default Settings". You may either edit the settings directly in the file itself, or place your customized settings in the "/etc/bansshee.conf" file. Settings in 
-the conf file will override settings in the script. By using the conf file you can upgrade the Bansshee script without having to re-apply your customizations to the 
-script each time.
+Bansshee has a number of customizable settings that can be used to modify its behaviour. The settings appear near the top of the "bansshee" script itself under the heading "Default Settings". You may either edit the settings directly in the file itself, or place your customized settings in the "/etc/bansshee.conf" file. Settings in the conf file will override settings in the script. By using the conf file you can upgrade the Bansshee script without having to re-apply your customizations to the script each time.
 
 * permitted_illegal_user
 
@@ -113,9 +112,7 @@ STARTING BANSSHEE
 
 For information on installing Bansshee see the INSTALL file.
 
-For automatic startup at boot time see the platform-specific files in the support directory. If Bansshee has been set up to 
-start automatically at boot time then it should always be started (and stopped) using the same control script. For example, 
-on Red Had Enterprise Linux the following command would be used:
+For automatic startup at boot time see the platform-specific files in the support directory. If Bansshee has been set up to start automatically at boot time then it should always be started (and stopped) using the same control script. For example, on Red Had Enterprise Linux the following command would be used:
 
   sudo service bansshee start
 
@@ -182,8 +179,7 @@ Or the Subversion book:
 
 CONTRIBUTING CODE
 
-To submit changes against a copy of Bansshee checked out using Subversion (see OBTAINING BANSSHEE) simply perform an "svn 
-diff" in your working copy and send your diff to the author (contact details below).
+To submit changes against a copy of Bansshee checked out using Subversion (see OBTAINING BANSSHEE) simply perform an "svn diff" in your working copy and send your diff to the author (contact details below).
 
 
 AUTHOR
index 705193715a0cf7ddde2c6fa2ec1d61825caae330..5dfbf6834fe1d6c52fd1fd105a080a8117c00e4f 100755 (executable)
--- a/bansshee
+++ b/bansshee
@@ -1,6 +1,6 @@
 #!/usr/bin/perl
 #
-# bansshee.pl
+# bansshee
 # Bansshee
 #
 # Created by Wincent Colaiuta on Monday 10 April 2006.
index 8690e616c3ada7fe5bea49613ae8869e4870e356..f828bf453b10e3558297519dc5ffbbcd230ddc56 100644 (file)
@@ -1,5 +1,6 @@
 # To override a given setting uncomment the corresponding line (remove the # symbol that begins the line) and alter the setting
 # See the README file for detailed information about each setting.
+# $Id$
 
 #
 # General settings