1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782
|
Description: fix #277903: new manpage
(here for 2.x)
Author: mirabilos <tg@debian.org>
Bug: https://musescore.org/en/node/277903
Forwarded: https://github.com/musescore/MuseScore/pull/4265
Applied-Upstream: master, commit:e292cfb527, v3.1
--- a/build/Linux+BSD/mscore.1.in
+++ b/build/Linux+BSD/mscore.1.in
@@ -1,244 +1,510 @@
-.\" 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 @MAN_MSCORE_UPPER@ 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@Variables_substituted_by_CMAKE_on_installation@
-mscore@MSCORE_INSTALL_SUFFIX@, musescore@MSCORE_INSTALL_SUFFIX@ \- @MUSESCORE_NAME_VERSION@ sheet music editor.
-
-.SH SYNOPSIS
-@BEGIN_section_to_only_appear_in_portable_builds@
-@MAN_PORTABLE@.SS Before installation:
-@MAN_PORTABLE@.B ./@PORTABLE_INSTALL_NAME@.AppImage
-@MAN_PORTABLE@.RI [ OPTIONS ]
-@MAN_PORTABLE@.RI [ FILE .\|.\|.]
-
-@MAN_PORTABLE@.SS After installation:
-@END_section_to_only_appear_in_portable_builds@
-.B mscore@MSCORE_INSTALL_SUFFIX@
-.RI [ OPTIONS ]
-.RI [ FILE .\|.\|.]
-.br
-.B musescore@MSCORE_INSTALL_SUFFIX@
-.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).
-
-@BEGIN_section_to_only_appear_in_portable_builds@
-@MAN_PORTABLE@.SS Portable version
-@MAN_PORTABLE@This portable version of MuseScore has all of MuseScore's usual features,
-@MAN_PORTABLE@but it runs on a wider range of distributions and does not need to be
-@MAN_PORTABLE@installed. There is an option to install it for full integration with other
-@MAN_PORTABLE@applications and the desktop environment.
-@END_section_to_only_appear_in_portable_builds@
-
-.SS Getting help
-This manual documents command line useage of
-.BR mscore@MSCORE_INSTALL_SUFFIX@ .
-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@MSCORE_INSTALL_SUFFIX@
-without options launches the full MuseScore
-program and opens any specified files.
-
-@BEGIN_section_to_only_appear_in_portable_builds@
-@MAN_PORTABLE@.SS Special options for the portable version
-@MAN_PORTABLE@.TP
-@MAN_PORTABLE@.B \-h, \-\-help
-@MAN_PORTABLE@Lists the various command line options and their usage.
-@MAN_PORTABLE@.TP
-@MAN_PORTABLE@.B man, manual, manpage
+.\" New manual page for MuseScore 2.3.2
+.\" Copyright (c) 2018, 2019
+.\" mirabilos <m@mirbsd.org>
+.\" Published under the same terms as MuseScore itself.
+.\"-
+.Dd March 20, 2019
+.Dt @MAN_MSCORE_UPPER@ 1
+.Os MuseScore
+.Sh NAME@Variables_substituted_by_CMAKE_on_installation@
+.Nm mscore@MSCORE_INSTALL_SUFFIX@ ,
+.Nm musescore@MSCORE_INSTALL_SUFFIX@
+.Nd @MUSESCORE_NAME_VERSION@ sheet music editor
+.Sh SYNOPSIS
+.Nm
+.Op Fl deFfhIiLmnOPRstvw
+.Op Fl a | Fl \-use\-audio Ar driver
+.Op Fl b | Fl \-bitrate Ar bitrate
+.Op Fl c | Fl \-config\-folder Ar pathname
+.Op Fl D | Fl \-monitor\-resolution Ar DPI
+.Op Fl E | Fl \-install\-extension Ar "extension file"
+.Op Fl j | Fl \-job Ar file.json
+.Op Fl M | Fl \-midi\-operations Ar file
+.Op Fl o | Fl \-export\-to Ar file
+.Op Fl p | Fl \-plugin Ar name
+.Op Fl r | Fl \-image\-resolution Ar DPI
+.Op Fl S | Fl \-style Ar style
+.Op Fl T | Fl \-trim\-image Ar margin
+.Op Fl x | Fl \-gui\-scaling Ar factor
+.Op Fl \-debug
+.Op Fl \-dump\-midi\-in
+.Op Fl \-dump\-midi\-out
+.Op Fl \-experimental
+.Op Fl \-export\-score\-parts
+.Op Fl \-factory\-settings
+.Op Fl \-force
+.Op Fl \-help
+.Op Fl \-layout\-debug
+.Op Fl \-load\-icons
+.Op Fl \-long\-version
+.Op Fl \-new\-score
+.Op Fl \-no\-midi
+.Op Fl \-no\-synthesizer
+.Op Fl \-no\-webview
+.Op Fl \-revert\-settings
+.Op Fl \-template\-mode
+.Op Fl \-test\-mode
+.Op Fl \-version
+.Op Ar
+.\" should be .Ss semantically but that renders badly
+@MAN_PORTABLE@.Sh AppImage (portable version), before installation
+@MAN_PORTABLE@.Nm ./@PORTABLE_INSTALL_NAME@.AppImage
+@MAN_PORTABLE@.Op Cm options
+@MAN_PORTABLE@.Op Ar
+.Sh DESCRIPTION
+.Nm MuseScore
+is a Free and Open Source WYSIWYG cross-platform multi-lingual
+music composition and notation software, released under the
+GNU General Public Licence (GPLv2).
+@MAN_PORTABLE@.Ss Special options for the AppImage
+@MAN_PORTABLE@This portable version of MuseScore has all of MuseScore's
+@MAN_PORTABLE@usual features, but it runs on a wider range of distributions
+@MAN_PORTABLE@and does not need to be installed.
+@MAN_PORTABLE@There is an option to install it for full integration with
+@MAN_PORTABLE@other applications and the desktop environment, though.
+.Pp
+@MAN_PORTABLE@.Bl -tag -width Ds
+@MAN_PORTABLE@.It Cm man , Cm manual , Cm manpage
@MAN_PORTABLE@Displays this manual.
-@MAN_PORTABLE@If MuseScore is installed the manual can be viewed using the familiar `man
-@MAN_PORTABLE@.BR mscore@MSCORE_INSTALL_SUFFIX@ `.
-@MAN_PORTABLE@.TP
-@MAN_PORTABLE@.B install [\-i] [PREFIX]
-@MAN_PORTABLE@.RS
-@MAN_PORTABLE@Run this without '\-i' or 'PREFIX' to fully integrate MuseScore
-@MAN_PORTABLE@with the desktop environment (GNOME, KDE, etc). This should:
-@MAN_PORTABLE@.RS 2
-@MAN_PORTABLE@.IP \[bu] 2
+@MAN_PORTABLE@If MuseScore is installed, the manual can be viewed using
+@MAN_PORTABLE@the familiar command:
+@MAN_PORTABLE@.Pp
+@MAN_PORTABLE@.Dl man mscore@MSCORE_INSTALL_SUFFIX@
+@MAN_PORTABLE@.It Cm install Oo Fl i Oc Op Ar prefix
+@MAN_PORTABLE@Run this without the options to fully integrate MuseScore
+@MAN_PORTABLE@with the desktop environment (GNOME, KDE, etc).
+@MAN_PORTABLE@This should:
+@MAN_PORTABLE@.Bl -bullet
+@MAN_PORTABLE@.It
@MAN_PORTABLE@Add MuseScore to your Applications Menu or Launcher,
-@MAN_PORTABLE@and add it to the "Open with..." list of programs.
-@MAN_PORTABLE@.IP \[bu]
+@MAN_PORTABLE@and add it to the
+@MAN_PORTABLE@.Dq Open with...
+@MAN_PORTABLE@list of programs.
+@MAN_PORTABLE@.It
@MAN_PORTABLE@Move the executable to put it with your other programs.
-@MAN_PORTABLE@(Usually a location within your PATH environment variable.)
-@MAN_PORTABLE@.IP \[bu]
-@MAN_PORTABLE@Create symlinks to make it easier to launch MuseScore from the
-@MAN_PORTABLE@command line when needed.
-@MAN_PORTABLE@.IP \[bu]
+@MAN_PORTABLE@(This is usually a location within your
+@MAN_PORTABLE@.Ev PATH
+@MAN_PORTABLE@environment variable.)
+@MAN_PORTABLE@.It
+@MAN_PORTABLE@Create symbolic links to make it easier to launch
+@MAN_PORTABLE@MuseScore from the command line when needed.
+@MAN_PORTABLE@.It
@MAN_PORTABLE@Make sure MSCZ, MSCX and MusicXML files are recognised
@MAN_PORTABLE@by the system and the correct icons are displayed.
-@MAN_PORTABLE@.RE
-@MAN_PORTABLE@
-@MAN_PORTABLE@Run as root (sudo) to install for all users.
-@MAN_PORTABLE@Advanced users can use '\-i' to enter interactive mode
-@MAN_PORTABLE@and 'PREFIX' to install to a custom location.
-@MAN_PORTABLE@Installation not required to run the program.
-@MAN_PORTABLE@.RE
-@MAN_PORTABLE@
-@MAN_PORTABLE@.TP
-@MAN_PORTABLE@.B remove, uninstall [PREFIX]
-@MAN_PORTABLE@Removes icons and resources,
-@MAN_PORTABLE@and asks whether you would like to remove the program too.
+@MAN_PORTABLE@.El
+@MAN_PORTABLE@.Pp
+@MAN_PORTABLE@Run as
+@MAN_PORTABLE@.Li root ,
+@MAN_PORTABLE@e.g. with
+@MAN_PORTABLE@.Xr sudo 8 ,
+@MAN_PORTABLE@to install for all users.
+@MAN_PORTABLE@Advanced users can use the
+@MAN_PORTABLE@.Fl i
+@MAN_PORTABLE@option to enter interactive mode, and provide an optional
+@MAN_PORTABLE@.Ar prefix
+@MAN_PORTABLE@to install into a custom location.
+@MAN_PORTABLE@Installation is not required to run the program.
+@MAN_PORTABLE@.It Cm remove , Cm uninstall Op Ar prefix
+@MAN_PORTABLE@Removes icons and resources, and asks whether you would
+@MAN_PORTABLE@like to remove the program as well.
@MAN_PORTABLE@(You can delete it yourself later if you wish.)
@MAN_PORTABLE@Scores and personal files are not removed.
-@MAN_PORTABLE@If you installed for all users then it will be removed for all users.
-@MAN_PORTABLE@
-@MAN_PORTABLE@.TP
-@MAN_PORTABLE@.B check\-depends, check\-dependencies [exes\-only]
+@MAN_PORTABLE@If you installed it for all users then it will be removed
+@MAN_PORTABLE@for all users.
+@MAN_PORTABLE@.It Cm check\-depends , Cm check\-dependencies Op Cm exes\-only
@MAN_PORTABLE@System information for developers.
-@MAN_PORTABLE@This detects which software libraries needed
-@MAN_PORTABLE@by MuseScore are not available from the system
-@MAN_PORTABLE@and so must be packaged with MuseScore.
-@MAN_PORTABLE@
-@MAN_PORTABLE@.SS Normal MuseScore options
-@END_section_to_only_appear_in_portable_builds@
-.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@MSCORE_INSTALL_SUFFIX@ \-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>
+@MAN_PORTABLE@This detects which software libraries needed by MuseScore
+@MAN_PORTABLE@are not available from the system and so must be packaged
+@MAN_PORTABLE@alongside the MuseScore portable version.
+@MAN_PORTABLE@.El
+@MAN_PORTABLE@.Ss Normal MuseScore options
+Running
+.Nm
+without any extra options launches the full graphical MuseScore program
+and opens any files specified on the command line.
+.Pp
+The options are as follows:
+.Bl -tag -width Ds
+.It Fl a | Fl \-use\-audio Ar driver
+Use audio driver: one of
+.Cm jack ,
+.Cm alsa ,
+.Cm portaudio ,
+.Cm pulse
+.It Fl b | Fl \-bitrate Ar bitrate
+Set MP3 output bitrate in kbit/s
+.It Fl c | Fl \-config\-folder Ar pathname
+Override configuration and settings directory
+.It Fl D | Fl \-monitor\-resolution Ar DPI
+Specify monitor resolution (override autodetection)
+.It Fl d | Fl \-debug
+Start MuseScore in debug mode
+.It Fl E | Fl \-install\-extension Ar "extension file"
+Install an extension file; soundfonts are loaded by default unless
+.Fl e
+is also specified
+.It Fl e | Fl \-experimental
+Enable experimental features, such as layers
+.It Fl F | \-factory\-settings
+Use only the standard built-in presets
+.Pq Dq factory settings
+and delete user preferences; compare with the
+.Fl R
+option
+.It Fl f | \-force
+Ignore score corruption and version mismatch warnings in
+.Dq converter mode
+.It Fl h | \-help
+Display an overview of invocation instructions
+.It Fl I | \-dump\-midi\-in
+Display all MIDI input on the console
+.It Fl i | \-load\-icons
+Load icons from the filesystem; useful if you want to
+edit the MuseScore icons and preview the changes
+.It Fl j | Fl \-job Ar file.json
+Process a conversion job (see
+.Sx EXAMPLES
+below)
+.It Fl L | \-layout\-debug
+Start MuseScore in layout debug mode
+.It Fl M | Fl \-midi\-operations Ar file
+Specify MIDI import operations file (see
+.Sx EXAMPLES
+below)
+.It Fl m | \-no\-midi
+Disable MIDI input
+.It Fl n | \-new\-score
+Start with the New Score wizard regardless whether
+it's enabled or disabled in the user preferences
+.It Fl O | \-dump\-midi\-out
+Display all MIDI output on the console
+.It Fl o | Fl \-export\-to Ar file
+Export the given (or currently opened) file to the specified output
+.Ar file .
+The file type depends on the extension of the filename given.
+This option switches to
+.Dq converter mode
+and avoids the graphical user interface.
+.It Fl P | \-export\-score\-parts
+When converting to PDF with the
+.Fl o
+option, append each part's pages to the created PDF file.
+If the score has no parts, all default parts will
+temporarily be generated automatically.
+.It Fl p | Fl \-plugin Ar 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.
+.It Fl R | \-revert\-settings
+Use only the standard built-in presets
+.Pq Dq factory settings
+but do not delete user preferences; compare with the
+.Fl F
+option
+.It Fl r | Fl \-image\-resolution Ar DPI
+Set image resolution for conversion to PNG files.
+.Pp
+Default: 300 DPI (actually, the value of
+.Dq Resolution
+of the PNG option group in the Export tab of the preferences)
+.It Fl S | Fl \-style Ar style
+Load a style file first; useful for use with the
+.Fl o
+option
+.It Fl s | \-no\-synthesizer
+Disable the integrated software synthesiser
+.It Fl T | Fl \-trim\-image Ar margin
+Trim exported PNG and SVG images to remove whitespace
+surrounding the score.
+The specified
+.Ar margin ,
+in pixels, will be retained (use 0 for a tightly cropped image).
+When exporting to SVG, this option only works with single-page scores.
+.It Fl t | \-test\-mode
+Set test mode flag for all files
+.It Fl v | \-version
+Display the name and version of the application
+without starting the graphical user interface
+.It Fl w | \-no\-webview
+Disable the web view component in the Start Centre
+.It Fl x | Fl \-gui\-scaling Ar factor
+Scale the score display and other GUI elements by the specified
+.Ar factor ;
+intended for use with high-resolution displays
+.It Fl \-long\-version
+Display the full name, version and git revision of the application
+without starting the graphical user interface
+.It Fl \-template\-mode
+Save files in template mode (e.g. without page sizes)
+.El
+.Pp
+MuseScore supports the automatic Qt command line options (see below).
+.Ss Batch conversion job JSON format
+The argument to the
+.Fl j
+option must be the pathname of a file comprised of a valid JSON
+document honouring the following specification:
+.Bl -bullet
+.It
+The top-level element must be a JSONArray, which may be empty.
+.It
+Each array element must be a JSONObject with the following keys:
+.Bl -tag -width plugin
+.It Li in
+Value is the name of the input file (score to convert), as JSONString.
+.It Li plugin
+Value is the filename of a plugin (with the .qml extension), which
+will be read from either the global or per-user plugin path and
+executed before the conversion output happens, as JSONString.
+Optional, but at least one of
+.Li plugin
+and
+.Li out
+.Em must
+be given.
+.It Li out
+Value is the conversion output target, as defined below.
+Optional, but at least one of
+.Li plugin
+and
+.Li out
+.Em must
+be given.
+.El
+.It
+The conversion output target may be a filename (with extension,
+which decided the format to convert to), as JSONString.
+.It
+The conversion output target may be a JSONArray of filenames as
+JSONString, as above, which will cause the score to be written
+to multiple output files (in multiple output formats) sequentially,
+without being closed, re-opened and re-processed in between.
+.It
+If the conversion output target is a JSONArray, one or more of
+its elements may also be, each, a JSONArray of two JSONStrings
+(called first and second half in the following description).
+This will cause part extraction: for each such two-tuple, all
+extant parts of the score will be saved
+.Em individually ,
+with filenames being composed by concatenating the first half,
+the name (title) of the part, and the second half.
+The resulting string must be a valid filename (with extension,
+determining the output format).
+If a score has no parts (excerpts) defined, this will be
+silently ignored without error.
+.It
+Valid file extensions for output are:
+.Bl -tag -width musicxml
+.It Li flac
+Free Lossless Audio Codec (compressed audio)
+.It Li mid
+standard MIDI file
+.It Li mlog
+internal file sanity check log (JSON)
+.It Li mp3
+MPEG Layer III (lossy compressed audio)
+.It Li mpos
+measure positions (XML)
+.It Li mscx
+uncompressed MuseScore file
+.It Li mscz
+compressed MuseScore file
+.It Li musicxml
+uncompressed MusicXML file
+.It Li mxl
+compressed MusicXML file
+.It Li ogg
+OGG Vorbis (lossy compressed audio)
+.It Li pdf
+portable document file (print)
+.It Li png
+portable network graphics (image)
+.Pp
+Individual files, one per score page, with a hyphen-minus followed
+by the page number placed before the file extension, will be generated.
+.It Li spos
+segment positions (XML)
+.It Li svg
+scalable vector graphics (image)
+.It Li wav
+RIFF Waveform (uncompressed audio)
+.It Li xml
+uncompressed MusicXML file
+.El
+.El
+.Pp
+See below for an example.
+.Sh ENVIRONMENT
+.Bl -tag -width Ds
+.It Ev SKIP_LIBJACK
+Set this (the value does not matter) to skip initialisation
+of the JACK Audio Connection Kit library, in case it causes trouble.
+.It Ev XDG_CONFIG_HOME
+User configuration location; defaults to
+.Pa \(ti/.config
+if unset.
+.It Ev XDG_DATA_HOME
+User data location; defaults to
+.Pa \(ti/.local/share
+if unset.
+.It Ev XDG_DOCUMENTS_DIR
+Location of works the user created with the application; defaults to
+.Pa \(ti/Documents
+(or a localised version) and can be set in
+.Pa $XDG_CONFIG_HOME/user-dirs.dirs .
+.El
+.Pp
+Note that MuseScore also supports the normal Qt environment variables such as
+.Ev QT_QPA_GENERIC_PLUGINS ,
+.Ev QT_QPA_PLATFORM ,
+.Ev QT_QPA_PLATFORMTHEME ,
+.Ev QT_QPA_PLATFORM_PLUGIN_PATH ,
+.Ev QT_STYLE_OVERRIDE ,
+.Ev DISPLAY ,
+etc.
+.Sh FILES
+.Pa @CMAKE_INSTALL_PREFIX@/@Mscore_SHARE_NAME@@Mscore_INSTALL_NAME@
+contains the application support data (demos, instruments, localisation,
+system-wide plugins, soundfonts, styles, chords, templates and wallpapers).
+In the Debian packages, system-wide soundfonts are installed into
+.Pa /usr/share/sounds/sf2/ ,
+.Pa /usr/share/sounds/sf3/
+or
+.Pa /usr/share/sounds/sfz/ ,
+respectively, instead.
+.Pp
+The per-user data (extensions, plugins, soundfonts, styles, templates) and
+files (images, scores) are normally installed into subdirectories under
+.Pa $XDG_DOCUMENTS_DIR/MuseScore2/
+but may be changed in the configuration.
+Note that snapshot, alpha and beta versions use
+.Pa MuseScore3Development
+instead of
+.Pa MuseScore2
+in all of these paths.
+.Pp
+.Pa $XDG_CONFIG_HOME/MuseScore/MuseScore2.ini
+contains the user preferences, list of recently used files and their
+locations, window sizes and positions, etc.
+See above for development version paths.
+.Pp
+.Pa $XDG_DATA_HOME/data/MuseScore/MuseScore2/
+contains updated localisation files downloaded from within the
+program, plugin information, cached scores, credentials for the
+.Pa musescore.com
+community site, session information, synthesiser settings, custom
+key and time signatures and shortcuts.
+See above for development version paths.
+.Sh EXAMPLES
+Convert a score to PDF from the command line:
+.Pp
+.Dl Nm Fl o No "\(aqMy Score.pdf\(aq" "\(aqMy Score.mscz\(aq"
+.Pp
+Run a batch job converting multiple documents:
+.Pp
+.Dl Nm Fl j No job.json
+.Pp
+This requires the file
+.Pa job.json
+in the current working directory to have content
+similar to the following:
+.Bd -literal -offset indent
+[
+ {
+ "in": "Reunion.mscz",
+ "out": "Reunion\-coloured.pdf",
+ "plugin": "colornotes.qml"
+ },
+ {
+ "in": "Reunion.mscz",
+ "out": [
+ "Reunion.pdf",
+ [ "Reunion (part for ", ").pdf" ],
+ "Reunion.musicxml",
+ "Reunion.mid"
+ ]
+ },
+ {
+ "in": "Piece with excerpts.mscz",
+ "out": [
+ "Piece with excerpts (Partitura).pdf",
+ [ "Piece with excerpts (part for ", ").pdf" ],
+ "Piece with excerpts.mid"
+ ]
+ }
+]
+.Ed
+.Pp
+The last part of the job would, for example, cause files like
+.Dq Pa "Piece with excerpts (part for Violin).pdf"
+to be generated alongside the conductor's partitura and a MIDI
+file with the full orchestra sound, whereas the equivalent part
+of the Reunion conversion will be silently ignored (because the
+Reunion piece (a MuseScore demo) has no excerpts defined).
+.Pp
+.Pa https://musescore.org/sites/musescore.org/files/midi_import_options_0.xml
+is a sample MIDI import operations file for the
+.Fl M
+option.
+.Sh DIAGNOSTICS
+.Ex -std
+.Sh SEE ALSO
+.Xr fluidsynth 1 ,
+.Xr midicsv 1 ,
+.Xr timidity 1 ,
+.Xr qtoptions 7
+.Bl -tag -width Ds
+.It Pa https://musescore.org/handbook
+Online Handbook, full user manual
+.It Pa https://musescore.org/forum
+Support Forum
+.It Pa https://musescore.org/handbook/command\-line\-options\-0
+Further documentation of command line options
+.It Pa https://musescore.org/handbook/revert\-factory\-settings\-0
+Reverting to factory settings (troubleshooting)
+.It Pa https://musescore.org/project/issues
+Project Issue Tracker
+.Pp
+Please check first to if the bug you're encountering
+has already been reported.
+If you just need help with something, then please use the
+support forum (see above) instead.
+.It Pa http://doc.qt.io/qt\-5/qguiapplication.html#supported\-command\-line\-options
+Documentation of automatic Qt command line options
+.El
+.Sh STANDARDS
+MuseScore attempts to implement the following standards:
+.Bl -bullet
+.It
+MusicXML 3.1 (score interchange format)
+.It
+SF2 (SoundFont 2.01)
+.It
+SF3 (SoundFont with OGG Vorbis-compressed samples)
+.It
+SFZ (Sforzato soundfont)
+.It
+SMuFL (Standard Music Font Layout 1.18)
+.El
+.Sh HISTORY
+MuseScore was split off the MusE sequencer in 2002 and has since
+become the foremost Open Source notation software.
+.Sh AUTHORS
+MuseScore is developed by Werner Schweer and others.
+.Pp
+This manual page was written by
+.An mirabilos Aq tg@debian.org .
+.Sh CAVEATS
+The automatic Qt command line options are removed from the
+argument vector before the application has a chance at option
+processing; this means that an invocation like
+.Pp
+.Dl Nm Fl S Ar \-reverse
+.Pp
+has no chance at working because the
+.Fl reverse
+is removed by Qt first.
+.Sh BUGS
+MuseScore does not honour
+.Pa /etc/papersize .
+.Pp
+Probably some more; check the project's bug tracker (cf.\&
+.Sx SEE ALSO ) .
--- /dev/null
+++ b/build/Linux+BSD/mscore.1.preview.sh
@@ -0,0 +1,24 @@
+#!/bin/sh
+
+cd "$(dirname "$0")"
+
+case $1 in
+(portable|p)
+ portable=''
+ ;;
+(*)
+ portable='.\\"'
+ ;;
+esac
+
+sed \
+ -e 's!@MAN_MSCORE_UPPER@!MSCORE!g' \
+ -e 's!@Variables_substituted_by_CMAKE_on_installation@!!g' \
+ -e 's!@MSCORE_INSTALL_SUFFIX@!!g' \
+ -e 's!@MUSESCORE_NAME_VERSION@!MuseScore 2!g' \
+ -e 's!@MAN_PORTABLE@!'"$portable"'!g' \
+ -e 's!@PORTABLE_INSTALL_NAME@!MuseScorePortable!g' \
+ -e 's!@CMAKE_INSTALL_PREFIX@!/usr!g' \
+ -e 's!@Mscore_SHARE_NAME@!share/!g' \
+ -e 's!@Mscore_INSTALL_NAME@!mscore-2.3/!g' \
+ <mscore.1.in | man -l -
|