.\"                                      Hey, EMACS: -*- nroff -*-
.\" To preview the page formatting without installing use "man -l mscore.1"
.\" First parameter, NAME, should be all caps
.\" Second parameter, SECTION, should be 1-8, maybe w/ subsection
.\" other parameters are allowed: see man(7), man(1)
.TH MSCORE 1 "14th January 2016" https://musescore.org/ "MuseScore User Commands"
.\" Please adjust this date whenever revising the manpage.
.\"
.\" Some roff macros, for reference:
.\" .nh        disable hyphenation
.\" .hy        enable hyphenation
.\" .ad l      left justify
.\" .ad b      justify to both left and right margins
.\" .nf        disable filling
.\" .fi        enable filling
.\" .br        insert line break
.\" .sp <n>    insert n+1 empty lines
.\" for manpage-specific macros, see man(7)
.\" TeX users may be more comfortable with the \fB<whatever>\fP and
.\" \fI<whatever>\fP escape sequences to invode bold face and italics,
.\" respectively.
.SH NAME
mscore, musescore \- MuseScore 2 sheet music editor.

.SH SYNOPSIS

.\".SS Before installation:
.\".B ./.AppImage
.\".RI [ OPTIONS ]
.\".RI [ FILE .\|.\|.]

.\".SS After installation:

.B mscore
.RI [ OPTIONS ]
.RI [ FILE .\|.\|.]
.br
.B musescore
.RI [ OPTIONS ]
.RI [ FILE .\|.\|.]

.SH DESCRIPTION
MuseScore is a free and open source WYSIWYG program for typesetting
musical scores, released under the GNU General Public Licence (GPLv2).


.\".SS Portable version
.\"This portable version of MuseScore has all of MuseScore's usual features,
.\"but it runs on a wider range of distributions and does not need to be
.\"installed. There is an option to install it for full integration with other
.\"applications and the desktop environment.


.SS Getting help
This manual documents command line useage of
.BR mscore .
For help with the full MuseScore program see:
.RS
.TP
.B Online Handbook
<https://musescore.org/handbook>
.TP
.B Support Forum
<https://musescore.org/forum>
.RE

.SS Further information
.TP
These pages cover the topics in this manual and may be more up-to-date:

<https://musescore.org/handbook/command-line-options-0>
.br
<https://musescore.org/handbook/revert-factory-settings-0>

.SH OPTIONS
A summary of options is included below. Running
.B mscore
without options launches the full MuseScore
program and opens any specified files.


.\".SS Special options for the portable version
.\".TP
.\".B \-h, --help
.\"Lists the various command line options and their usage.
.\".TP
.\".B man, manual, manpage
.\"Displays this manual.
.\"If MuseScore is installed the manual can be viewed using the familiar `man
.\".BR mscore `.
.\".TP
.\".B install [-i] [PREFIX]
.\".RS
.\"Run this without '-i' or 'PREFIX' to fully integrate MuseScore
.\"with the desktop environment (GNOME, KDE, etc). This should:
.\".RS 2
.\".IP \[bu] 2
.\"Add MuseScore to your Applications Menu or Launcher,
.\"and add it to the "Open with..." list of programs.
.\".IP \[bu]
.\"Move the executable to put it with your other programs.
.\"(Usually a location within your PATH environment variable.)
.\".IP \[bu]
.\"Create symlinks to make it easier to launch MuseScore from the
.\"command line when needed.
.\".IP \[bu]
.\"Make sure MSCZ, MSCX and MusicXML files are recognised
.\"by the system and the correct icons are displayed.
.\".RE
.\"
.\"Run as root (sudo) to install for all users.
.\"Advanced users can use '-i' to enter interactive mode
.\"and 'PREFIX' to install to a custom location.
.\"Installation not required to run the program.
.\".RE
.\"
.\".TP
.\".B remove, uninstall [PREFIX]
.\"Removes icons and resources,
.\"and asks whether you would like to remove the program too.
.\"(You can delete it yourself later if you wish.)
.\"Scores and personal files are not removed.
.\"If you installed for all users then it will be removed for all users.
.\"
.\".TP
.\".B check-depends, check-dependencies [exes-only]
.\"System information for developers.
.\"This detects which software libraries needed
.\"by MuseScore are not available from the system
.\"and so must be packaged with MuseScore.
.\"
.\".SS Normal MuseScore options

.TP
.B \-h, --help
Displays help.
.TP
.B \-v, --version
Displays MuseScore's current version in the command line without starting the graphical interface.
.TP
.B \--long-version
Displays MuseScore's current version and revision in the command line without starting the graphical interface.
.TP
.B \-d, --debug
Starts MuseScore in debug mode.
.TP
.B \-L, --layout-debug
Starts MuseScore in layout debug mode
.TP
.B \-s, --no-synthesizer
Disables the integrated software synthesizer
.TP
.B \-m, --no-midi
Disables MIDI input
.TP
.B \-a, --use-audio <driver>
Use audio driver: jack, alsa, pulse, portaudio
.TP
.B \-n, --new-score
Starts with the new score wizard regardless of preference setting for start mode
.TP
.B \-I, --dump-midi-in
Displays all MIDI input on the console
.TP
.B \-O, --dump-midi-out
Displays all MIDI output on the console
.TP
.B \-o, --export-to <filename>
Exports the currently opened file to the specified <filename>. The file type depends on the filename extension. This option switches to the "converter" mode and avoids any graphical interface. You can also add a filename before the -o if you want to import and export files from the command line. For example mscore -o "My Score.pdf" "My Score.mscz"
.TP
.B \-r, --image-resolution <dpi>
Determines the output resolution for the output to "*.png" files in the converter mode. The default resolution is 300 dpi.
.TP
.B \-T, --trim-margin <margin>
Trims exported PNG and SVG images to remove surrounding whitespace around the score. The specified number of pixels of whitespace will be added as a margin; use 0 for a tightly cropped image. For SVG, this option works only with single-page scores.
.TP
.B \-x, --gui-scaling <factor>
Scales the score display and other GUI elements by the specified factor, for use with high resolution displays.
.TP
.B \-S, --style <style>
Loads a style file; useful when you convert with the \-o option
.TP
.B \-p, --plugin <name>
Execute the named plugin
.TP
.B \--template-mode
Save template mode, no page size
.TP
.B \-F, --factory-settings
Use only the standard built-in presets or "factory-settings" and delete preferences
.TP
.B \-R, --revert-settings
Use only the standard built-in presets or "factory-settings", but do not delete preferences
.TP
.B \-i, --load-icons
Load icons from the file system. Useful if you want to edit the MuseScore icons and preview the changes
.TP
.B \-e, --experimental
Enable experimental features. (E.g. layers).
.TP
.B \-c, --config-folder <pathname>
Set config path
.TP
.B \-t, --test-mode
Enable Test Mode
.TP
.B \-M, --midi-operations <file>
Specify MIDI import operations file
.TP
.B \-w, --no-webview
No web view in Start Center
.TP
.B \-P, --export-score-parts
Used with -o .pdf, export score and parts

.SH FILES
Advanced users can find MuseScore's configuration files at:
.RS
.TP
.I ~/.config/MuseScore/MuseScore2.ini
Main MuseScore preference file.

.TP
.I ~/.local/share/data/MuseScore/MuseScore2/
Directory for all other preferences and session data.
(Autosaves, palettes, locale, plugin data, etc.)
.RE

The information in these files may allow partial recovery of lost work in
some situations, but full recovery is extremely unlikely.
No method of data rescue can match regular, automated backups.

.SH BUGS
.TP
Please report any bugs via the Issue Tracker:

<https://musescore.org/project/issues>

.TP
Please check first to if the bug has already been reported. If you just need
help with something then please use the support forum instead.

.SH AUTHOR
The MuseScore Team.