Improved documentation regarding default behavior without CLI arguments.

This commit is contained in:
Martin-Eckleben
2020-09-05 16:32:59 +02:00
committed by borgmanJeremy
parent 924b11d975
commit 944469cd39
2 changed files with 8 additions and 2 deletions

View File

@@ -74,6 +74,9 @@
## Usage
Execute the command `flameshot` without parameters to launch a running instance of the program without taking actions.
Also adds a tray icon for configuration and management.
Example commands:
- Capture with GUI:
@@ -214,8 +217,6 @@ Steps for using the configuration:
- Press <kbd>Enter</kbd> or <kbd>Ctrl</kbd> + <kbd>C</kbd> when you are in a capture mode and you don't have an active selection and the whole desktop will be copied to your clipboard! Pressing <kbd>Ctrl</kbd> + <kbd>S</kbd> will save your capture in a file! Check the [Shortcuts](#shortcuts) for more information.
- Execute the command `flameshot` without parameters to launch a running instance of the program without taking actions.
## Installation
There are packages available for a few distros:

View File

@@ -340,6 +340,7 @@ CommandLineParser::printHelp(QStringList args, const Node* node)
{
args.removeLast(); // remove the help, it's always the last
QString helpText;
// add usage info
QString argName = node->argument.name();
if (argName.isEmpty()) {
@@ -350,6 +351,10 @@ CommandLineParser::printHelp(QStringList args, const Node* node)
.arg(args.join(QStringLiteral(" ")))
.arg(argName)
.arg(argText);
// short section about default behavior
helpText += QStringLiteral("Per default runs Flameshot in the background and adds a tray icon for configuration.\n\n");
// add command options and subarguments
QList<CommandArgument> subArgs;
for (const Node& n : node->subNodes)