Bug 298725

Summary:	The akonadictl lacks a man page.
Product:	[Frameworks and Libraries] Akonadi	Reporter:	HughDaniel <hugh.kde.bugs>
Component:	general	Assignee:	kdepim bugs <pim-bugs-null>
Status:	RESOLVED UNMAINTAINED
Severity:	normal
Priority:	NOR
Version First Reported In:	unspecified
Target Milestone:	---
Platform:	Ubuntu
OS:	Linux
Latest Commit:		Version Fixed/Implemented In:
Sentry Crash Report:

Description HughDaniel 2012-04-24 09:03:37 UTC

I am trying to debug a problem with a fresh install of KDE where akonadictl fails to run (multiple problems?), but the akonadictl(1) program for some reaons lacks a man page so I have NO idea how to use it.  Someone familiar with akonadictl needs to spend a couple of hours writing one and I will be happy to review it if needed.

Reproducible: Always

Steps to Reproduce:
1. man akonadictl
2. man -k akonadictl
Both fail.

Actual Results:  
$ man akonadictl
No manual entry for akonadictl
See 'man 7 undocumented' for help when manual pages are not available.
$ man -k akonadictl
$ 


Expected Results:  
A useful man page show up giving a quick explanation as to how to use the program and
pointers to other useful resouces.


http://www.debian.org/doc/debian-policy/ch-docs.html
http://qa.debian.org/man-pages.html

Comment 1 Christophe Marin 2012-04-24 09:55:09 UTC

Well...

# akonadictl --help
Akonadi server manipulation tool
Usage: akonadictl [command]

Commands:
  start      : Starts the Akonadi server with all its processes
  stop       : Stops the Akonadi server and all its processes cleanly
  restart    : Restart Akonadi server with all its processes
  status     : Shows a status overview of the Akonadi server
  vacuum     : Vacuum internal storage (WARNING: needs a lot of time and disk space!)
  fsck       : Check (and attempt to fix) consistency of the internal storage (can take some time)

General options:
  -h [ --help ]         show this help message
  --version             show version information

Comment 2 Denis Kurz 2016-09-24 20:39:43 UTC

This bug has only been reported for versions older than KDEPIM 4.14 (at most akonadi-1.3). Can anyone tell if this bug still present?

If noone confirms this bug for a recent version of akonadi (part of KDE Applications 15.08 or later), it gets closed in about three months.

Comment 3 Denis Kurz 2017-01-07 22:09:19 UTC

Just as announced in my last comment, I close this bug. If you encounter it again in a recent version (at least 5.0 aka 15.08), please open a new one unless it already exists. Thank you for all your input.