rclone / rclone

"rsync for cloud storage" - Google Drive, S3, Dropbox, Backblaze B2, One Drive, Swift, Hubic, Wasabi, Google Cloud Storage, Azure Blob, Azure Files, Yandex Files
https://rclone.org
MIT License
46.09k stars 4.13k forks source link

whatis parse for rclone(1) failed #7430

Open Paraphraser opened 10 months ago

Paraphraser commented 10 months ago

The associated forum post URL from https://forum.rclone.org

I searched the forum for "whatis" (the relevant keyword in the error message discussed below) but there were no hits so I conclude this is a new problem.

Save for #458 (April 2016) which sounds like it might be a problem with the same cause, there were also no hits for "whatis" in this GitHub repo.

What is the problem you are having with rclone?

Installing rclone on a Raspberry Pi 4B Bookworm always seems to produce this message towards the end of the install:

Updating index cache for path `/usr/local/man/man1'. Wait...mandb: warning: /usr/local/man/man1/rclone.1: whatis parse for rclone(1) failed

In context:

…
Processing manual pages under /usr/share/man/sv...
Checking for stray cats under /usr/share/man/sv...
Checking for stray cats under /var/cache/man/sv...
Purging old database entries in /usr/share/man/it...
Processing manual pages under /usr/share/man/it...
Checking for stray cats under /usr/share/man/it...
Checking for stray cats under /var/cache/man/it...
Processing manual pages under /usr/local/man...
Updating index cache for path `/usr/local/man/man1'. Wait...mandb: warning: /usr/local/man/man1/rclone.1: whatis parse for rclone(1) failed
done.
Checking for stray cats under /usr/local/man...
Checking for stray cats under /var/cache/man/oldlocal...
1 man subdirectory contained newer manual pages.
1 manual page was added.
0 stray cats were added.
0 old database entries were purged.

rclone v1.64.2 has successfully installed.
Now run "rclone config" for setup. Check https://rclone.org/docs/ for more details.

This is on a clean install of Raspbian (details below) so it's not as if rclone was already installed, migrated, self-updated etc.

I've also noticed the same thing installing a Bookworm guest on Proxmox VE, also a clean install from Debian distribution media. I haven't tried Bullseye on either platform to see whether this is something peculiar to Bookworm.

What is your rclone version (output from rclone version)

$ rclone version
rclone v1.64.2
- os/version: raspbian 12.2 (64 bit)
- os/kernel: 6.1.0-rpi6-rpi-v8 (aarch64)
- os/type: linux
- os/arch: arm64 (ARMv8 compatible)
- go/version: go1.21.3
- go/linking: static
- go/tags: none

$ uname -a
Linux tri-dev 6.1.0-rpi6-rpi-v8 #1 SMP PREEMPT Debian 1:6.1.58-1+rpt2 (2023-10-27) aarch64 GNU/Linux

Which OS you are using and how many bits (e.g. Windows 7, 64 bit)

Raspberry Pi OS (Bookworm) 64-bit. Specifically:

Which cloud storage system are you using? (e.g. Google Drive)

Not relevant - this is an install-time problem.

The command you were trying to run (e.g. rclone copy /tmp remote:tmp)

$ curl https://rclone.org/install.sh | sudo bash

A log from the command with the -vv flag (e.g. output from rclone -vv copy /tmp remote:tmp)

Not relevant - this is not a problem running rclone. It is an install-time problem. The error output is shown above.

How to use GitHub

kapitainsky commented 10 months ago

Save for #458 (April 2016) which sounds like it might be a problem with the same cause, there were also no hits for "whatis" in this GitHub repo.

As explained in #458 it is only a warning that rclone won't appear in the whatis database which is indeed the case:

$ whatis rclone
rclone (1)           - (unknown subject)

vs, e.g.

$ whatis ls
ls (1)               - list directory contents

You can easily fix it and contribute to rclone:)

makewhatis program (which outputs parse error you talk about) picks up the first line from the NAME section of the man page of a command.

But as you run man rclone you notice that NAME is missing:

rclone(1)                                                                                                                                                                   rclone(1)

Rclone syncs your files to cloud storage
       • About rclone

       • What can rclone do for you?

       • What features does rclone have?

vs e.g. man ls

 LS(1)

NAME
       ls - list directory contents

SYNOPSIS
       ls [OPTION]... [FILE]...

so what you have to do is to add NAME section to rclone man generated page and submit PR.

However I think linux man page is something nobody really paid much attention to. IMO man rclone is "useless" at the moment - it is 50k lines (270k words) saga and does not really follow man pages established practices. I doubt anybody uses it...

If you feel it is worth you can make it better including fixing whatis issue.

But given that rclone does not really follow Unix philosophy "make each program do one thing well" - and does million things (to do it well is never ending work in progress) creating proper man page might be sisyphean task...