sad state of command line option documentation
Type
Functional
Frequency
Once
Severity
S4 - Minor
Reproducibility
Always
Status
closed
Regression
No
Workaround
No
Project
The manpage musescore(1) is the same between 2.3 and git master. There are several problems with it:
- several options are not documented at all
- the three new options of master are also not documented (obviously)
- one option (-T) is even misdocumented
- the list is not sorted (normal sort order: case-insensitively by short option letter (per letter: uppercase before lowercase), followed by GNU long options without a short equivalent, sorted in the same manner)
I’ve attached a list of all command line options I could find in musescore.cpp and the current manpage, and where problems are.
| Attachment | Size |
|---|---|
| d.txt | 807 bytes |
Fix version
3.1.0
Comments
I’d be willing to provide an updated manual page in mdoc format, if someone could provide me with correct documentation text snippets for all options marked as 'miss'(ing), NEW (in master) or WRONG, together with what the optarg should be named, if any.
In reply to I’d be willing to provide an… by mirabilos
I'm sure others will comment also, but I remember lasconic asked that -e not be documented.
Just go ahead and fix the handbook yourself.
I started working on this (in parallel to tons of other stuff).
In reply to Just go ahead and fish the… by Jojo-Schmitz
Voilà, here it is: https://github.com/musescore/MuseScore/pull/4265
This is roughly how the new manpage reads:
m3.pdf
Of course, normal rendering is plaintext (with bold and underlined) in a terminal, and system-dependent.
Does that -job json feature where you export to parts by adding out: ["first-halfof-filename", "second-half-of-filename"] to the json really work?
In reply to Does that -job json feature… by Blaarghinator
Once that PR of mine is applied, it works. It’s shipped in the Debian experimental version even for 2.3 (and, as it’s a compatible change, I’m considering uploading it to unstable/testing/the next stable later).
I'm going to ask the forbidden question: Is there an option that the website uses to extract the screen position and dimensions of each measure in its page (for is pink box)?
In reply to I'm going to ask the… by [DELETED] 1831606
I believe converting to
.mposor.sposfiles is what you want.!!!! What will science think of next!?!!? This is pretty remarkable. This is all one needs to implement a private web player. Thanks (as well as for the improved command-line documents!)!
In reply to Once that PR of mine is… by mirabilos
Is there any update on this? Curious if it's going to be added to MS3 or not.
See https://musescore.org/en/node/278640
The Pr is not yet merged though.
In reply to Is there any update on this?… by Blaarghinator
Iff by 'this' you mean export in a Web-Player compatible format: yes. There are the --score-media and --score-mp3 command line options which work well with MS3. This made implementing a custom Web score player trivial ;-)
In reply to Iff by 'this' you mean… by rmattes
Sorry, I meant, rather, is there any update on the batch export of parts to separate PDFs via command line?
In reply to Sorry, I meant, rather, is… by Blaarghinator
Well, '--score-parts-pdf' will generate per-part PDFs, you'd need to split the resulting JSON file into separate pdf files (but that's trivial with a simple python/perl/whatever script).
And, yes, a separate pdf-parts format for ' --export-to' would have been nice.
In reply to Sorry, I meant, rather, is… by Blaarghinator
That’s https://github.com/musescore/MuseScore/pull/4166 which currently just gets ignored by the people with commit access (although Jojo-Schmitz has thankfully helped by reviewing it).
In reply to Well, '--score-parts-pdf'… by rmattes
--export-score-parts generates all the parts, but it generates one PDF. The PDF contains the score, and then appends each part after it. Is there a way to, from an MSCZ that has a score + six parts, generate seven PDFs, one for the score, and one for each individual part?
has got nothing to do with this issue, please better discuss in the forum.
In reply to --export-score-parts… by Blaarghinator
Yes, the PR I referenced in my last comment allows you to do precisely that, from the command line.
It’s incidentally coupled to the PR merging the new manpage because I document it in there. (I removed the not-yet-merge parts from the online handbook page for now.)
Fixed in branch master, commit e292cfb527
_fix #277903: new manpage
Completely rewritten manpage, with improved documentation for most
aspects of the program, and documentation of the better batch con‐
version (see PR 4166). The new mscore.1.preview.sh shell script is
intended to be used for previewing changes, by developers._
Fixed in branch master, commit faffc934ff
_Merge pull request #4265 from mirabilos/new-manpage
fix #277903: new manpage_
Automatically closed -- issue fixed for 2 weeks with no activity.