Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Command line help fix #4036

Merged
merged 4 commits into from
Jul 2, 2021
Merged

Command line help fix #4036

merged 4 commits into from
Jul 2, 2021

Conversation

daschuer
Copy link
Member

This fixes the command line output:

Now:

Usage: ./mixxx [options] file
Mixxx is an open source DJ software. For more information, see: https://manual.mixxx.org/2.4/chapters/appendix/commandline_dev_tools.html

Options:
  -f, --full-screen          Starts Mixxx in full-screen mode
  --locale                   Use a custom locale for loading translations. (e.g
                             'fr')
  --settings-path <path>     Top-level directory where Mixxx should look for
                             settings. Default is:/home/sperry/.mixxx/
  --resource-path <path>     Top-level directory where Mixxx should look for
                             its resource files such as MIDI mappings,
                             overriding the default installation location.
  --timeline-path <path>     Path the debug statistics time line is written to
  --controller-debug         Causes Mixxx to display/log all of the controller
                             data it receives and script functions it loads
  --developer                Enables developer-mode. Includes extra log info,
                             stats on performance, and a Developer tools menu.
  --safe-mode                Enables safe-mode. Disables OpenGL waveforms, and
                             spinning vinyl widgets. Try this option if Mixxx is
                             crashing on startup.
  --color <color>            [auto|always|never] Use colors on the console
                             output.
  --log-level <level>        Sets the verbosity of command line logging.
                             critical - Critical/Fatal only
                             warning  - Above + Warnings
                             info     - Above + Informational messages
                             debug    - Above + Debug/Developer messages
                             trace    - Above + Profiling messages
  --log-flush-level <level>  Sets the the logging level at which the log buffer
                             is flushed to mixxx.log. <level> is one of the
                             values defined at --log-level above.
  --debug-assert-break       Breaks (SIGINT) Mixxx, if a DEBUG_ASSERT evaluates
                             to false. Under a debugger you can continue
                             afterwards.
  -h, --help                 Displays this help.
  -v, --version              Displays version information.

Arguments:
  file                       Load the specified music file(s) at start-up. Each
                             file you specify will be loaded into the next
                             virtual deck.

Before:

Usage: ./mixxx [options] file
Mixxx is an open source DJ software. For more information, see https://manual.mixxx.org/2.4/chapters/appendix/commandline_dev_tools.html
.CamelCase arguments are deprecated and will be removed in 2.5

Options:
  -f, --full-screen, --fullScreen                                   Starts
                                                                    Mixxx in
                                                                    full-screen
                                                                    mode
  --locale                                                          Use a
                                                                    custom
                                                                    locale for
                                                                    loading
                                                                    translations
                                                                    . (e.g 'fr')
  --settings-path, --settingsPath <settingsPath>                    Top-level
                                                                    directory
                                                                    where Mixxx
                                                                    should look
                                                                    for
                                                                    settings.
                                                                    Default
                                                                    is:/home/spe
                                                                    rry/.mixxx/
  --resource-path, --resourcePath <resourcePath>                    Top-level
                                                                    directory
                                                                    where Mixxx
                                                                    should look
                                                                    for its
                                                                    resource
                                                                    files such
                                                                    as MIDI
                                                                    mappings,
                                                                    overriding
                                                                    the default
                                                                    installation
                                                                    location.
  --timeline-path, --timelinePath                                   Path the
                                                                    timeline is
                                                                    written to
  --controller-debug, --controllerDebug, --midi-debug, --midiDebug  Causes
                                                                    Mixxx to
                                                                    display/log
                                                                    all of the
                                                                    controller
                                                                    data it
                                                                    receives and
                                                                    script
                                                                    functions it
                                                                    loads
  --developer                                                       Enables
                                                                    developer-mo
                                                                    de. Includes
                                                                    extra log
                                                                    info, stats
                                                                    on
                                                                    performance,
                                                                    and a
                                                                    Developer
                                                                    tools menu.
  --safe-mode, --safeMode                                           Enables
                                                                    safe-mode.
                                                                    Disables
                                                                    OpenGL
                                                                    waveforms,
                                                                    and spinning
                                                                    vinyl
                                                                    widgets. Try
                                                                    this option
                                                                    if Mixxx is
                                                                    crashing on
                                                                    startup.
  --color <color>                                                   [auto|alway
                                                                    s|never] Use
                                                                    colors on
                                                                    the console
                                                                    output.
  --log-level, --logLevel <logLevel>                                Sets the
                                                                    verbosity of
                                                                    command line
                                                                    logging.
                                                                    critical -
                                                                    Critical/Fat
                                                                    al only
                                                                    warning  -
                                                                    Above +
                                                                    Warnings
                                                                    info     -
                                                                    Above +
                                                                    Informationa
                                                                    l messages
                                                                    debug    -
                                                                    Above +
                                                                    Debug/Develo
                                                                    per messages
                                                                    trace    -
                                                                    Above +
                                                                    Profiling
                                                                    messages
  --log-flush-level, --logFlushLevel <logFlushLevel>                Sets the
                                                                    the logging
                                                                    level at
                                                                    which the
                                                                    log buffer
                                                                    is flushed
                                                                    to
                                                                    mixxx.log.
                                                                    LEVEL is one
                                                                    of the
                                                                    values
                                                                    defined at
                                                                    --logLevel
                                                                    above.
  --debug-assert-break, --debugAssertBreak                          Breaks
                                                                    (SIGINT)
                                                                    Mixxx, if a
                                                                    DEBUG_ASSERT
                                                                    evaluates to
                                                                    false. Under
                                                                    a debugger
                                                                    you can
                                                                    continue
                                                                    afterwards.
  -h, --help                                                        Displays
                                                                    this help.
  -v, --version                                                     Displays
                                                                    version
                                                                    information.

Arguments:
  file                                                              Load the
                                                                    specified
                                                                    music
                                                                    file(s) at
                                                                    start-up.
                                                                    Each file
                                                                    you specify
                                                                    will be
                                                                    loaded into
                                                                    the next
                                                                    virtual
                                                                    deck.

src/util/cmdlineargs.cpp Outdated Show resolved Hide resolved
Co-authored-by: Be <be.0@gmx.com>
@Be-ing
Copy link
Contributor

Be-ing commented Jun 30, 2021

This line is really long:

Mixxx is an open source DJ software. For more information, see: https://manual.mixxx.org/2.4/chapters/appendix/commandline_dev_tools.html

How about putting the URL on its own line?

@daschuer
Copy link
Member Author

daschuer commented Jul 2, 2021

@Be-ing: merge?

@Holzhaus
Copy link
Member

Holzhaus commented Jul 2, 2021

Already approved, I'll hit merge.

@Holzhaus Holzhaus merged commit aa75711 into mixxxdj:main Jul 2, 2021
@uklotzde
Copy link
Contributor

uklotzde commented Jul 2, 2021

This PR breaks the legacy command line arguments. I was wondering why Mixxx no longer finds my settings path when using --settingsPath although it still exists. Mixxx stops with an assertion on startup and complains that it is not able to open the database.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants