No documentation for --background

[uusijani]

How to use GitHub

• Please use the 👍 reaction to show that you are affected by the same issue.
• Please don't comment if you have no relevant information to add. It's just extra noise for everyone subscribed to this issue.
• Subscribe to receive notifications on status change and new comments.

Preface

Ticking the "Launch on System Startup" box in the desktop client's General settings tab (correctly) adds a .desktop file under ~/.config/autostart/, with the following Exec line:

    Exec="/usr/bin/nextcloud" --background

Expected behaviour

The effect of --background should be mentioned in options.rst (and the resulting online documentation).

Actual behaviour

The --background parameter is undocumented.

Client configuration

Client version: 3.2.1
Operating system: Ubuntu 20.04
OS language: English
Client package: 3.2.1-20210429.171749.5901a0f98-1.0~focal1

[FlexW]

Are you feeling confident enough to do it yourself?

[uusijani]

@FlexW Not really, as I don't know what the parameter does... due to it being undocumented :) Editing options.rst shouldn't be an issue, I'd just need to know what it should say about --background.

[FlexW]

@uusijani If you enter nextcloud --help you get an explanation of what --background does. In fact, thats the output:

--background         : launch the application in the background.

[uusijani]

I can add that to options.rst, but the terse explanation still seems pretty meaningless; at least for me there's no visible difference when I run nextcloud with --background compared to running without.

This could be due to #2333 though, if running without --background is supposed to open the main dialog (which has never worked on Focal). If so, I'd mention this too, something like: "Launch the application in the background (without opening the main dialog)."

[FlexW]

@uusijani I admit the explanation is not good. When launching with --background the main dialog shows not up on start. Without --background the main dialog does show up. You can notice that difference when you have no tray implementation.

Please also see src/gui/main.cpp:179 and src/gui/main.cpp:143.