Update command line options

[rdswift]

Summary

This is a…

• Correction
• Addition
• Restructuring
• Minor / simple change (like a typo)
• Other

Reason for the Change

An addional command line option was added in metabrainz/picard#2316

Description of the Change

Add the information for the new -a, --audit command line option. Also add the information for the --no-crash-dialog command line option that was added 2 years ago but was never documented.

Additional Action Required

Once merged, the translation files will need to be updated.

[rdswift]

@phw,

Should we also update the Getting Logs section of the Troubleshooting page to include this command line option? Also, there are instructions for Windows users on starting Picard to display the debug information, so I'm wondering if we should also include something similar for macOS users?

[phw]

I wouldn't include audit flag in the troubleshooting for now because you can't give a general recommendation. This audit logging is mostly useful if you are looking for some very specific issue. But that all depends on the actual case. So I would leave this as an option for us to request more detailed information from users if needed.

Regarding starting Picard: I think yes, we should include something for macOS. But also we should improve the documentation for Windows. The current advise there turns out to be not so helpful in practice.

Currently it describes how to enable debug mode by editing the shortcut. While this works, I think the far easier method is to start Picard, open the log window, enable debug mode, then restart Picard (so we get complete startup log). This also has the advantage of being platform independent and working everywhere.

What we should instead document separately is how to start Picard from command line (with debug mode) on all platforms. This is often needed to investigate crashes, as otherwise the log is not accessible.

Hence I would suggest to separate the current docs for "Getting Logs" into "Enable Debug Mode" and "Getting Logs in Case of Crashes", which describes how to open Picard from command line to get the full log output.

For the majority of Linux users that should be easy to do. They might use different desktop environments and use different terminal apps, but they should be able to open one and type picard -d.

Windows users require often more help in opening a "Command Prompt" and type "C:\Program Files\MusicBrainz Picard\picard.exe" -d. Also this works only for the installer version and the path needs to be adjusted for the actual install location.

macOS is similar. The "Terminal" is available on all installs. The exact command also depends where the Picard app is put. But if Picard was put into the system wide Applications folder then it can be run with "/Applications/MusicBrainz Picard.app/Contents/MacOS/picard-run" -d.