diff options
Diffstat (limited to 'doc/man')
| -rw-r--r-- | doc/man/rosegarden-audiofile-importer.1 | 76 | ||||
| -rw-r--r-- | doc/man/rosegarden-lilypondview.1 | 57 | ||||
| -rw-r--r-- | doc/man/rosegarden-project-package.1 | 76 | ||||
| -rw-r--r-- | doc/man/rosegarden.1 | 155 |
4 files changed, 364 insertions, 0 deletions
diff --git a/doc/man/rosegarden-audiofile-importer.1 b/doc/man/rosegarden-audiofile-importer.1 new file mode 100644 index 0000000..b420ba1 --- /dev/null +++ b/doc/man/rosegarden-audiofile-importer.1 @@ -0,0 +1,76 @@ +.\" This is free documentation; you can redistribute it and/or +.\" modify it under the terms of the GNU General Public License as +.\" published by the Free Software Foundation; either version 2 of +.\" the License, or (at your option) any later version. +.\" +.\" The GNU General Public License's references to "object code" +.\" and "executables" are to be interpreted as the output of any +.\" document formatting or typesetting system, including +.\" intermediate and printed output. +.\" +.\" This manual is distributed in the hope that it will be useful, +.\" but WITHOUT ANY WARRANTY; without even the implied warranty of +.\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +.\" GNU General Public License for more details. +.\" +.\" You should have received a copy of the GNU General Public +.\" License along with this manual; if not, write to the Free +.\" Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, +.\" USA. +.\" +.TH ROSEGARDEN-AUDIOFILE-IMPORTER 1 "19 March 2006" + +.SH NAME + +rosegarden-audiofile-importer - Helper application to convert and +import audio files for Rosegarden. + +.SH SYNOPSIS + +rosegarden-audiofile-importer -t [<version>] +rosegarden-audiofile-importer --conftest [<version>] +rosegarden-audiofile-importer -l [<version>] +rosegarden-audiofile-importer [-r <rate>] -w <inputfile> +rosegarden-audiofile-importer [-r <rate>] -c <inputfile> <outputfile> + + +.SH OPTIONS + +.BR -t " " [<version>], +.BR --conftest " " [<version>] + +Exit successfully if the importer is available and working [and is +of at least version <version>]. If some of the required helper +applications are missing, also print to stdout a line saying +"Required: application1, application2", listing the missing +programs. + +.BR \-l " " [<version>] + +List known file extensions (e.g. ogg wav flac). Return code is same +as for -t (so can combine two calls into one) + +.BR \-r " " <rate> + +Test whether any work is needed to convert the input, either because +it isn't in a Rosegarden-compatible format or because its samplerate +differs from <rate>. Exit successfully if no work is required; return +error code 2 if conversion required, 3 if resampling required, 4 if +both required, 1 for other error. + +.SH DESCRIPTION + +Helper application to convert and import audio files for Rosegarden. + +Can take audio files of various kinds as input, always produces WAV +files that are compatible with Rosegarden as output. + +Not actually specific to Rosegarden in any way, except that +Rosegarden needs to know it can rely on its presence and calling +interface. + +.SH SEE ALSO + rosegarden(1), rosegarden-lilypondview(1), rosegarden-project-page(1) + + + diff --git a/doc/man/rosegarden-lilypondview.1 b/doc/man/rosegarden-lilypondview.1 new file mode 100644 index 0000000..e2aa9f9 --- /dev/null +++ b/doc/man/rosegarden-lilypondview.1 @@ -0,0 +1,57 @@ +.\" This is free documentation; you can redistribute it and/or +.\" modify it under the terms of the GNU General Public License as +.\" published by the Free Software Foundation; either version 2 of +.\" the License, or (at your option) any later version. +.\" +.\" The GNU General Public License's references to "object code" +.\" and "executables" are to be interpreted as the output of any +.\" document formatting or typesetting system, including +.\" intermediate and printed output. +.\" +.\" This manual is distributed in the hope that it will be useful, +.\" but WITHOUT ANY WARRANTY; without even the implied warranty of +.\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +.\" GNU General Public License for more details. +.\" +.\" You should have received a copy of the GNU General Public +.\" License along with this manual; if not, write to the Free +.\" Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, +.\" USA. +.\" +.TH ROSEGARDEN-LILIPONDVIEW 1 "10 February 2006" +i +.SH NAME + +rosegardern-lilypondview - display a lilypond file in a postscript +viewer. + +.SH SYNOPSIS + +rosegarden-lilypondview [-g] [FILE].ly + +.SH DESCRIPTION + +This script takes a Lilypond file as input. It creates a temporary +sandbox, runs Lilypond against the input file, then opens a PostScript +viewer against the results in order to provide a graphical, printable +preview. + +This script is used internally by Rosegarden, as the backend for the File -> +Export -> Preview Lilypond file feature. + +.SH OPTIONS +.BR \-g " " Use graphical mode + +.SH REQUIREMENTS + +Working installation of Lilypond 2.0 or later KGhostView or KPDF or +XPDF or GhostView or GS XDialog or Konsole or RXVT or Xterm [for +graphical mode only] + +.SH AUTHOR +Chris Cannam + +.SH COPYRIGHT +2005-2006 Fervent Software. + + diff --git a/doc/man/rosegarden-project-package.1 b/doc/man/rosegarden-project-package.1 new file mode 100644 index 0000000..0da30c2 --- /dev/null +++ b/doc/man/rosegarden-project-package.1 @@ -0,0 +1,76 @@ +.\" This is free documentation; you can redistribute it and/or +.\" modify it under the terms of the GNU General Public License as +.\" published by the Free Software Foundation; either version 2 of +.\" the License, or (at your option) any later version. +.\" +.\" The GNU General Public License's references to "object code" +.\" and "executables" are to be interpreted as the output of any +.\" document formatting or typesetting system, including +.\" intermediate and printed output. +.\" +.\" This manual is distributed in the hope that it will be useful, +.\" but WITHOUT ANY WARRANTY; without even the implied warranty of +.\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +.\" GNU General Public License for more details. +.\" +.\" You should have received a copy of the GNU General Public +.\" License along with this manual; if not, write to the Free +.\" Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, +.\" USA. +.\" +.TH ROSEGARDEN-PROJECT-PACKAGE 1 "10 February 2006" + +.SH NAME + +rosegarden-project-package - converts between Rosegarden (.rg) files +and Rosegarden Project (.rgp) files. + +.SH SYNOPSIS + +orosegarden-project-package [--quiet] [--pack] [--unpack] [--conftest] [FILE] [.rg|.rgp] + +.SH OPTIONS +.BR \-\-quiet " " Be silent +.BR \-\-unpack " " Unpack .rgp file +.BR \-\-pack " " Pack .rg file plus associated external data files into .rgp file +.BR \-\-conftest " " Test environment for necessary installed components + +.SH DESCRIPTION + +This program converts between Rosegarden (.rg) files and Rosegarden +Project (.rgp) files. It is primarily intended to be used internally and +transparently by the Rosegarden application. + +A Rosegarden file (.rg) is a single file (in gzipped XML format) +that defines a Rosegarden composition in terms of events, segments, +programs, plugin data, references to audio files, and so on. Some +of these types of information depend on the presence of external +files such as the audio files or plugin preset data, without which +the file cannot be used. + +A Rosegarden Project (.rgp) file is a bundle of files, including the +Rosegarden file itself, as well as any audio file or other external +data it requires, in compressed form. A Rosegarden Project file is +intended to be portable and self-contained, but the Rosegarden +program itself does not (at the time of writing) understand these +files directly. + +This program can take a Rosegarden file, examine it to find out +which other data files it uses, and pack it to create the +corresponding Rosegarden Project file. Conversely, it can also take +a Rosegarden Project file and unpack it as a project directory for +use with Rosegarden. + +.SH REQUIREMENTS + +Working installation of Lilypond 2.0 or later KGhostView or KPDF or +XPDF or GhostView or GS XDialog or Konsole or RXVT or Xterm [for +graphical mode only] + +.SH AUTHOR +Chris Cannam + +.SH COPYRIGHT +2005-2006 Fervent Software. + + diff --git a/doc/man/rosegarden.1 b/doc/man/rosegarden.1 new file mode 100644 index 0000000..fe750e0 --- /dev/null +++ b/doc/man/rosegarden.1 @@ -0,0 +1,155 @@ +.TH ROSEGARDEN 1 "23 July 2006" + +.SH NAME + +rosegarden, rosegarden-sequencer - MIDI and audio sequencer and +musical notation editor. + +.SH SYNOPSIS + +rosegarden [Qt-options] [TDE-options] [options] [File] + +rosegardensequencer [Qt-options] [TDE-options] [playback_1 playback_2 capture_1 capture_2] + +.SH DESCRIPTION + +This manual page documents briefly the rosegarden and rosegardensequencer commands. + +rosegarden is a MIDI and audio sequencer, notation editor, and general-purpose music composition and editing application for Unix and Linux. It is a TDE application, which means to build it you need the TDE libraries. However, once installed it can be run within the TDE environment or any other desktop or window manager environment. + +rosegardensequencer is part of the rosegarden application, the part which knows about and audio MIDI devices, and about real time. rosegardensequencer is executed automatically when rosegarden starts, so you will probably never need to execute it directly. You may want to specify command line options, though, to change the JACK ports used for audio capture and playback. In order to do that, you can invoque rosegardensequencer directly before running rosegarden, or you can specify the sequencer command line arguments using the rosegarden configuration dialog, and restarting the application. This program follows the usual GNU command line syntax, with long options starting with two dashes ('-'). A summary of options is included below. + +.SH OPTIONS +.BR \-\-author " " + Show author information. + +.BR \-\-help " " + Show help about options. + +.BR \-\-help-all + Show all options. + +.BR \-\-help-tde + Show TDE specific options. + +.BR \-\-help-qt + Show Qt specific options. + +.BR \-\-license + Show license information. + +.BR \-v, \-\-version + Show version information. + + +.SH OPTIONS for rosegarden + +.BR \-\-nosplash + Don\'t show splash screen. + + +.BR \-\-nosequencer + Don\'t use an external sequencer. + +.BR \-\-nofork + Don\'t automatically run in the background. + +.BR \ \--existingsequencer + Attach to a running sequencer process, if found. + +.BR File + File to load at startup. Typically a rosegarden (.rg) file, but it can also be a rosegarden2.1 file or a MIDI file. + +.SH OPTIONS +.BR \-g " " Use graphical mode> + +.SH QT OPTIONS +.BR \-\-bg, --background color + Sets the default background color and an application palette (light and dark shades are calculated). + +.BR \-\-btn, --button color + Sets the default button color. + +.BR \-\-cmap + Causes the application to install a private color map on an 8-bit display. + +.BR \-\-display displayname + Use the X-server display 'displayname'. + +.BR \-\-dograb + Running under a debugger can cause an implicit --nograb, use --dograb to override. + +.BR \-\-fg, \-\-foreground color + Sets the default foreground color. + +.BR \-\-fn, \-\-font fontname + Defines the application font. + +.BR \-\-im XIMserver + Set XIM server. + +.BR \-\-inputstyle inputstyle + Sets XIM (X Input Method) input style. Possible values are onthespot, overthespot, offthespot and root. + +.BR \-\-name name + Sets the application name. + +.BR \-\-ncols count + Limits the number of colors allocated in the color cube on an 8-bit display, if the application is using the QApplication::ManyColor color specification. + +.BR \-\-nograb + Tells Qt to never grab the mouse or the keyboard. + +.BR \-\-noxim + Disable XIM. + +.BR \-\-reverse + Mirrors the whole layout of widgets. + +.BR \-\-session sessionId + Restore the application for the given 'sessionId'. + +.BR \-\-sync + Switches to synchronous mode for debugging. + +.BR \-\-title title + Sets the application title (caption). + +.BR \-\-visual TrueColor + Forces the application to use a TrueColor visual on an 8-bit display. + + +.SH TDE OPTIONS +.BR \-\-caption caption + Use 'caption' as name in the titlebar. + +.BR \-\-config filename + Use alternative configuration file. + +.BR \-\-dcopserver server + Use the DCOP Server specified by 'server'. + +.BR \-\-geometry geometry + Sets the client geometry of the main widget. + +.BR \-\-icon icon + Use 'icon' as the application icon. + +.BR \-\-miniicon icon + Use 'icon' as the icon in the titlebar. + +.BR \-\-nocrashhandler + Disable crash handler, to get core dumps. + +.BR \-\-style style + Sets the application GUI style. + +.BR \-\-waitforwm + Waits for a WM_NET compatible windowmanager. + +.SH SEE ALSO + jackd(1), rosegarden-lilypondview(1), rosegarden-project-package(1), rosegarden-audiofile-importer(1) + + +.SH AUTHOR +This manual page was written by Enrique Robledo Arnuncio <era@debian.org> and later ammended by Mike O'Connor <stew@vireo.org> for the Debian system (but may be used by others). Permission is granted to copy, distribute and/or modify this document under the terms of the GNU Free Documentation License, Version 1.1 or any later version published by the Free Software Foundation; with no Invariant Sections, no Front Cover Texts and no Back Cover Texts. |