Difference between revisions of "Muse2ps installation instructions"

From CCARH Wiki
Jump to navigation Jump to search
 
(12 intermediate revisions by the same user not shown)
Line 1: Line 1:
 
== Compiled muse2ps program ==
 
== Compiled muse2ps program ==
  
You can download compiled program files for muse2ps using your favorite web browser by right-clicking on filenames in the table below and choosing "Save As..." in the menu which appears (but the saving process will depend on the particular browser and operating system).  Alternatively, the following two sections explain how to download using two common command-line downloading tools.
+
You can download compiled program files for [[muse2ps]] using your favorite web browser by right-clicking on filenames in the table below and choosing "Save As..." in the menu which appears (but the saving process will depend on the particular browser and operating system).  Alternatively, the following two sections explain how to download using two common command-line downloading tools.
  
 
<center>
 
<center>
Line 9: Line 9:
 
If you do not want to compile muse2ps from the source code (particularly when using Microsoft Windows), you only need to download the compiled program for your operating system.  Follow the  instructions given below for your specific operating system.  If you are using a unix-based operating system other than linux, then you are expected to be computer-literate enough to compile from the source code.
 
If you do not want to compile muse2ps from the source code (particularly when using Microsoft Windows), you only need to download the compiled program for your operating system.  Follow the  instructions given below for your specific operating system.  If you are using a unix-based operating system other than linux, then you are expected to be computer-literate enough to compile from the source code.
  
==== Downloading in Linux or cygwin ====
+
==== Downloading in a Linux or Cygwin terminal ====
  
 
In both Linux and [http://www.cygwin.com cygwin] for Microsoft Windows, you can use the [http://en.wikipedia.org/wiki/Wget wget] program to download directly from a terminal.  For linux:
 
In both Linux and [http://www.cygwin.com cygwin] for Microsoft Windows, you can use the [http://en.wikipedia.org/wiki/Wget wget] program to download directly from a terminal.  For linux:
Line 26: Line 26:
 
   curl <nowiki>http://www.ccarh.org/software/muse2ps/muse2ps-osx</nowiki> -o muse2ps
 
   curl <nowiki>http://www.ccarh.org/software/muse2ps/muse2ps-osx</nowiki> -o muse2ps
  
==== Testing the executable ====
+
==== Testing the executable program file ====
  
 
After downloading the program, you will probably need to set the file permissions so that the file can be run as a program.  In OS X or linux, use the command:
 
After downloading the program, you will probably need to set the file permissions so that the file can be run as a program.  In OS X or linux, use the command:
Line 34: Line 34:
 
     chmod 0755 muse2ps.exe
 
     chmod 0755 muse2ps.exe
  
Next, Download the MuseData stage2 file [http://www.ccarh.org/software/muse2ps/bach-bwv852-1.md2 bach-bwv852-1.md2] using curl or wget (or save from an internet browser). This file can be used as test input data into the [[muse2ps]] program.  Then run the muse2ps program with this command in linux or OS X:
+
Next, download the MuseData stage2 file [http://www.ccarh.org/software/muse2ps/bach-bwv852-1.md2 bach-bwv852-1.md2] using curl or wget (or save from an internet browser).
 +
  wget <nowiki>http://www.ccarh.org/software/muse2ps/bach-bwv852-1.md2</nowiki>
 +
 
 +
  curl <nowiki>http://www.ccarh.org/software/muse2ps/bach-bwv852-1.md2 -o bach-bwv852-1.md2</nowiki>
 +
 
 +
This file can be used as test input data into the [[muse2ps]] program.  Then run the muse2ps program with this command in linux or OS X:
 
     cat bach-bwv852-1.md2 | ./muse2ps > bach-bwv852-1.ps
 
     cat bach-bwv852-1.md2 | ./muse2ps > bach-bwv852-1.ps
On Windows/cygwin computers, you might need to use "<tt>./muse2ps.exe</tt>" as the command name.  On Windows computers without cygwin, you can run this equivalent command in the [http://en.wikipedia.org/wiki/Command_Prompt Command Prompt] program (if you are in the correct directory):
+
On Windows/cygwin computers, you might need to use "<tt>./muse2ps.exe</tt>" as the command name.  On Windows computers without cygwin, you can run this equivalent command in the [http://en.wikipedia.org/wiki/Command_Prompt Command Prompt] program (provided that you are in the correct directory):
 
     type bach-bwv852-1.md2 | muse2ps > bach-bwv852-1.ps
 
     type bach-bwv852-1.md2 | muse2ps > bach-bwv852-1.ps
  
If the program runs successfully, the file bach-bwv852-1.ps should contain PostScript data.  To view this PostScript data, you will have to use a program which understands that data format.  For example, Adobe Distiller or Acrobat Professional can convert PostScript files into PDF files.  Programs which can view PostScript files directory include GhostView which is available for Windows and linux (often called gv in linux).
+
If the program runs successfully, the file bach-bwv852-1.ps should contain PostScript data.  To view this PostScript data, you will have to use a program which understands that data format.  For example, Adobe Distiller or Acrobat Professional can convert PostScript files into PDF files.  Programs which can view PostScript files directly include [http://pages.cs.wisc.edu/~ghost/ GhostView] which is available for Windows and linux (a variant called [http://www.gnu.org/software/gv/manual/html_node/index.html gv] is common on linux computers).
  
 
== Downloading source code ==
 
== Downloading source code ==
  
== Compiling source code ==
+
From the command-line, you can download the source code for [[muse2ps]] with wget or curl:
 +
 
 +
    wget http://www.ccarh.org/software/muse2ps/muse2ps.tar.bz2
 +
 
 +
    curl http://www.ccarh.org/software/muse2ps/muse2ps.tar.bz2 -o muse2ps.tar.bz2
 +
 
 +
If you click on the link to the source code, most web browsers can automatically download the [http://en.wikipedia.org/wiki/Tar_%28file_format%29 tar file] and open it as a folder within the operating system.  This folder can be dragged to a location of your choosing on your hard disk.  To unpack the tar file manually from the command line, type in linux, OS X, or Windows/cygwin:
 +
    tar xvjf muse2ps.tar.bz2
 +
 
 +
This will create a directory called [http://www.ccarh.org/software/muse2ps/muse2ps muse2ps].  To compile the program, change directory into the newly created directory, and type the command "<tt>make</tt>":
 +
    cd muse2ps
 +
    make
 +
 
 +
This will create the file <tt>muse2ps</tt> within the directory which is the executable program for muse2ps.  You can look in the <tt>tests</tt> for test example (or follow the instructions above for running a test usage of one of the pre-compiled program files):
 +
    cd tests
 +
    make
 +
The above two commands should produce three PostScript files within the <tt>tests</tt> directory (The creation of a PostScript file for Beethoven's Ninth Symphony will take a while).  Use your favorite PostScript viewing or printing programs to examine the resulting output files.  The directory <tt>muse2ps/tests/pdf</tt> contains PDF files which should match the PostScript output from [[muse2ps]]:
 +
* [http://www.ccarh.org/software/muse2ps/muse2ps/tests/pdf/bach-bwv852-1.pdf bach-bwv852-1.pdf]: A Bach Well-tempered Clavier prelude.
 +
* [http://www.ccarh.org/software/muse2ps/muse2ps/tests/pdf/beethoven-sym5-4.pdf beethoven-sym5-4.pdf] : Beethoven, Fifth Symphony, movement 4.
 +
* [http://www.ccarh.org/software/muse2ps/muse2ps/tests/pdf/beethoven-sym9.pdf beethoven-sym9.pdf]: Beethoven, Ninth Symphony, complete.
 +
 
 +
== Documentation for muse2ps ==
 +
 
 +
Documentation for using muse2ps is available ''[[muse2ps | here]]''.  The documentation describes the options and input data format for the program.

Latest revision as of 21:16, 19 December 2010

Compiled muse2ps program

You can download compiled program files for muse2ps using your favorite web browser by right-clicking on filenames in the table below and choosing "Save As..." in the menu which appears (but the saving process will depend on the particular browser and operating system). Alternatively, the following two sections explain how to download using two common command-line downloading tools.

File Description
muse2ps.tar.bz2    Tar file containing source code and test examples.
muse2ps-linux    Program executable compiled statically for linux.
muse2ps-osx    Program executable compiled for Apple OS X, version 10.4 and higher.
muse2ps.exe    Program executable compiled for Microsoft Windows (prone to stack overflows in older versions of Windows). It is currently advised to download the source code and compile within a Cygwin terminal if you want to run on Windows (not suitable for the amateur Windows user who is not familiar with Unix).

If you do not want to compile muse2ps from the source code (particularly when using Microsoft Windows), you only need to download the compiled program for your operating system. Follow the instructions given below for your specific operating system. If you are using a unix-based operating system other than linux, then you are expected to be computer-literate enough to compile from the source code.

Downloading in a Linux or Cygwin terminal

In both Linux and cygwin for Microsoft Windows, you can use the wget program to download directly from a terminal. For linux:

   wget http://www.ccarh.org/software/muse2ps/muse2ps-linux -O muse2ps

And for Windows/cygwin:

   wget http://www.ccarh.org/software/muse2ps/muse2ps.exe 

Note that the Windows version of muse2ps does not require cygwin in order to be run. Cygwin is used in this case only to facilitate downloading from a terminal.

Downloading in Apple OS X using Terminal.app

The executable muse2ps program compiled for Apple OS X (10.4 and higher) can be downloaded in Terminal.app using the command-line downloading program called curl:

  curl http://www.ccarh.org/software/muse2ps/muse2ps-osx -o muse2ps

Testing the executable program file

After downloading the program, you will probably need to set the file permissions so that the file can be run as a program. In OS X or linux, use the command:

   chmod 0755 muse2ps

or, in Windows/cygwin:

   chmod 0755 muse2ps.exe

Next, download the MuseData stage2 file bach-bwv852-1.md2 using curl or wget (or save from an internet browser).

  wget http://www.ccarh.org/software/muse2ps/bach-bwv852-1.md2
  curl http://www.ccarh.org/software/muse2ps/bach-bwv852-1.md2 -o bach-bwv852-1.md2

This file can be used as test input data into the muse2ps program. Then run the muse2ps program with this command in linux or OS X:

    cat bach-bwv852-1.md2 | ./muse2ps > bach-bwv852-1.ps

On Windows/cygwin computers, you might need to use "./muse2ps.exe" as the command name. On Windows computers without cygwin, you can run this equivalent command in the Command Prompt program (provided that you are in the correct directory):

   type bach-bwv852-1.md2 | muse2ps > bach-bwv852-1.ps

If the program runs successfully, the file bach-bwv852-1.ps should contain PostScript data. To view this PostScript data, you will have to use a program which understands that data format. For example, Adobe Distiller or Acrobat Professional can convert PostScript files into PDF files. Programs which can view PostScript files directly include GhostView which is available for Windows and linux (a variant called gv is common on linux computers).

Downloading source code

From the command-line, you can download the source code for muse2ps with wget or curl:

   wget http://www.ccarh.org/software/muse2ps/muse2ps.tar.bz2
   curl http://www.ccarh.org/software/muse2ps/muse2ps.tar.bz2 -o muse2ps.tar.bz2

If you click on the link to the source code, most web browsers can automatically download the tar file and open it as a folder within the operating system. This folder can be dragged to a location of your choosing on your hard disk. To unpack the tar file manually from the command line, type in linux, OS X, or Windows/cygwin:

    tar xvjf muse2ps.tar.bz2

This will create a directory called muse2ps. To compile the program, change directory into the newly created directory, and type the command "make":

    cd muse2ps
    make

This will create the file muse2ps within the directory which is the executable program for muse2ps. You can look in the tests for test example (or follow the instructions above for running a test usage of one of the pre-compiled program files):

    cd tests
    make

The above two commands should produce three PostScript files within the tests directory (The creation of a PostScript file for Beethoven's Ninth Symphony will take a while). Use your favorite PostScript viewing or printing programs to examine the resulting output files. The directory muse2ps/tests/pdf contains PDF files which should match the PostScript output from muse2ps:

Documentation for muse2ps

Documentation for using muse2ps is available here. The documentation describes the options and input data format for the program.