Bug 351642

Summary:	Manpage for balooctl
Product:	[Frameworks and Libraries] frameworks-baloo	Reporter:	Unknown <null>
Component:	balooctl	Assignee:	Pinak Ahuja <pinak.ahuja>
Status:	RESOLVED INTENTIONAL
Severity:	wishlist	CC:	aspotashev, info, nate, pinak.ahuja
Priority:	NOR
Version:	unspecified
Target Milestone:	---
Platform:	Ubuntu
OS:	Linux
Latest Commit:		Version Fixed In:
Sentry Crash Report:

Description Unknown 2015-08-23 14:09:00 UTC

Please create a manpage.

I am using Kubuntu 14.04.3 LTS.

I am not sure about the baloo version. '-v' print out this.

Qt: 4.8.6
KDE Development Platform: 4.13.3
: 0.1

Reproducible: Always

Comment 1 Alexander Potashev 2016-03-12 02:18:01 UTC

Man pages are usually for command-line tool. What Baloo command line tool do you need a manpage for?

Comment 2 Nate Graham 2017-10-27 18:57:13 UTC

Probably balooctl:

$ man balooctl 
No manual entry for balooctl

That said, it does have a -v flag:

$ balooctl -v
baloo 5.39.0

Comment 3 Nate Graham 2017-10-27 19:25:15 UTC

*** Bug 364078 has been marked as a duplicate of this bug. ***

Comment 4 Nate Graham 2020-04-25 22:06:04 UTC

Just running `balooctl` shows the options and what they will do. It's not a full manpage, but it's good enough IMO.

Comment 5 Unknown 2020-04-26 11:27:39 UTC

The decission if this is a bug or not should not depend on YOUR opinion but on rules and regularities; e.g. goals of KDE to make the Linux Desktop usable for everyone (also granny).

KDE is not a Hacker/Nerd graphical desktop environment on top of GNU Linux!

A manpage should be the minimum for each application.

btw: Just running `balooctl` is buggy, too because there is no version information given. Using explicite `-v` for is is unusal, too and an unneeded obstacle to the user.

btw: I am not a usual KDE user. I am just a member of the FOSS community and try to improve a "product" having the FOSS movement and the users in my mind. I am not the user here.

Comment 6 Nate Graham 2020-04-27 15:43:39 UTC

(In reply to moonkid from comment #5)
> The decission if this is a bug or not should not depend on YOUR opinion but
> on rules and regularities; e.g. goals of KDE to make the Linux Desktop
> usable for everyone (also granny).
Well, I'm one of the Baloo developers, so in fact it does depend on my opinion. :) However even if that was not true, KDE does not have a global policy that all command line tools much have manpages.

Also, most grannies I know don't read manpages. They use GUI software.

Can you articulate what exactly is the problem is with running `balooctl --help`?

Comment 7 Unknown 2020-04-29 14:52:33 UTC

> Can you articulate what exactly is the problem is
> with running `balooctl --help`?

It is not usual in unixoid environments.

Comment 8 Nate Graham 2020-04-29 15:40:28 UTC

I disagree. It's extremely common and I've encountered it over and over again throughout my career using UNIX-like operating systems. And KDE's command-line programs universally use this style instead of manpages.

Comment 9 Christoph Feck 2020-04-29 19:43:15 UTC

--help and --version are indeed not a Unix standard, but a GNU standard. Many KDE tools follow GNU conventions, despite not being GNU projects. We actually try to support both standards for these two important options: -h and -v also work on most KDE programs.

https://www.gnu.org/prep/standards/html_node/Command_002dLine-Interfaces.html

Comment 10 Alexander Potashev 2020-05-02 14:00:44 UTC

(In reply to Nate Graham from comment #4)
> Just running `balooctl` shows the options and what they will do. It's not a
> full manpage, but it's good enough IMO.

This only works if you have `balooctl` installed. If we had a real manpage, you could also find it online, e.g. http://manpages.org/meinproc5/8 for meinproc5.