V6 development branch - man page gone

General Beta 6.0
1

The pihole-FTL man page seems not installed anymore with one of my recently deployed v6 nodes.
Also bash completion is gone.

Below a v6 node that was installed a long time ago with a working man page and auto completion:

dehakkelaar@ph6b:~$ pihole version
Core
    Version is v5.18.3-492-g65806a90 (Latest: null)
    Branch is development
    Hash is 65806a90 (Latest: 65806a90)
Web
    Version is v5.21-959-g7acf4647 (Latest: null)
    Branch is devel
    Hash is 7acf4647 (Latest: 7acf4647)
FTL
    Version is vDev-cb8e8b0 (Latest: null)
    Branch is development
    Hash is cb8e8b06 (Latest: d749dffb)

dehakkelaar@ph6b:~$ sudo find /usr/ -iname '*pihole*'
/usr/local/share/man/man8/pihole-FTL.8
/usr/local/share/man/man8/pihole.8
/usr/local/bin/pihole
/usr/share/bash-completion/completions/pihole-FTL
/usr/bin/pihole-FTL

Below the troubled node that was installed just before the switch from development-v6 to development:

dehakkelaar@ph6c:~$ sudo pihole updatePihole
[..]
  [â] man pages installed and database updated

dehakkelaar@ph6c:~$ pihole version
Core
    Version is v5.18.3-505-g65806a90 (Latest: null)
    Branch is development
    Hash is 65806a90 (Latest: 65806a90)
Web
    Version is v5.21-959-g7acf4647 (Latest: null)
    Branch is devel
    Hash is 7acf4647 (Latest: 7acf4647)
FTL
    Version is vDev-d749dff (Latest: null)
    Branch is development
    Hash is d749dffb (Latest: d749dffb)

dehakkelaar@ph6c:~$ sudo find /usr/ -iname '*pihole*'
/usr/local/share/man/man8/pihole.8
/usr/local/bin/pihole
/usr/bin/pihole-FTL

https://tricorder.pi-hole.net/4f7w3tEO/

2

Oops, forget about the bash completion bit ... my bad!
That was my attempt:

dehakkelaar@ph6b:~$ cat /usr/share/bash-completion/completions/pihole-FTL
# bash completion for pihole-FTL                           -*- shell-script -*-

_pihole-FTL()
{
    local cur prev words cword
    _init_completion || return

    local command=${words[1]}

    case $cword in
        1)
            COMPREPLY=($(compgen -W "--
                                     debug
                                     dhcp-discover
                                     dnsmasq-test
                                     lua
                                     luac
                                     regex-test
                                     test" -- "$cur"))
            ;;
        2)
            case $command in
                regex-test) ;;

                *)
                    COMPREPLY=($(compgen -W "$($1 regex-test |
                        awk 'NR>1 {print $1}')" -- "$cur"))
                    ;;
            esac
            ;;
        3)
            case $command in
                addif | delif)
                    _configured_interfaces
                    ;;
                stp)
                    COMPREPLY=($(compgen -W 'on off' -- "$cur"))
                    ;;
            esac
            ;;
    esac
} &&
    complete -F _pihole-FTL -o default pihole-FTL

# ex: filetype=sh

dehakkelaar@ph6b:~$ pihole-FTL
--             dhcp-discover  lua            regex-test
debug          dnsmasq-test   luac           test

Thing is, I already got used to it :wink:

3

It was already removed two years ago.

4

@deHakkelaar

There is a new help function for FTL.

Did you try pihole-FTL help? (or pihole-FTL -h)

1 Like
5

Hi Yubi, its not the man page for pihole-FTL.conf but for the pihole-FTL binary that seems to be missing.

Older v6 release on ph6b host:

dehakkelaar@ph6b:~$ man pihole-FTL
Pihole-FTL(8)               November 2020              Pihole-FTL(8)

NAME
       pihole-FTL - Pi-hole : The Faster-Than-Light (FTL) Engine

SYNOPSIS
       service pihole-FTL (start|stop|restart)

       pihole-FTL debug
       pihole-FTL test
[..]

Latest v6 release on ph6c host:

dehakkelaar@ph6c:~$ man pihole-FTL
No manual entry for pihole-FTL

That man page is a bit outdated and maybe a remnant of the v5 release that wasnt cleaned up properly?

6

I know.
And the pihole command does have bash completion :slight_smile:

dehakkelaar@ph6b:~$ pihole
allow          debug          logging        tail
allow-regex    deny           query          uninstall
allow-wild     disable        reconfigure    updateGravity
api            enable         regex          updatePihole
arpflush       flush          restartdns     version
checkout       help           status         wildcard
8

Sorry, I mixed it.

__

That's strange, because the code to install it, is still there Is gone...

__

The reason was probably that FTL has an extensive built-in help function starting with

1 Like
9

Thanks for looking into this!
This dedicated v6 VM was setup last year a couple of months after the man page was removed:

dehakkelaar@xen02:~$ stat /etc/xen/ph6b.cfg
[..]
 Birth: 2023-10-24 00:46:25.238660294 +0200

Bit weird it still has the v5 man page though.

10

Hurts a bit though that it doesnt have a man page anymore :sleepy:

$ systemctl help pihole-FTL.service
Documentation for (null) not known.

$ systemctl help ssh.service
SSHD(8)              BSD System Manager's Manual             SSHD(8)

NAME
     sshd -- OpenSSH daemon

SYNOPSIS
     sshd [-46DdeiqTtV] [-C connection_spec]
          [-c host_certificate_file] [-E log_file] [-f config_file]
          [-g login_grace_time] [-h host_key_file] [-o option]
          [-p port] [-u len]

DESCRIPTION
     sshd (OpenSSH Daemon) is the daemon program for ssh(1).
[..]

$ systemctl cat ssh.service
[..]
Documentation=man:sshd(8) man:sshd_config(5)
11

I might have discovered what went wrong with above.
It looks for below to remove:

/usr/local/share/man/man5/pihole-FTL.8

But mine is in a different path:

/usr/local/share/man/man8/pihole-FTL.8

EDIT: Also on my very old Raspi v5 host:

pi@ph5b:~ $ stat /usr/local/share/man/man8/pihole-FTL.8
[..]
Access: (0644/-rw-r--r--)  Uid: (    0/    root)   Gid: (    0/    root)
Access: 2024-04-07 17:59:25.807453015 +0200
Modify: 2024-04-07 17:59:25.807453015 +0200
Change: 2024-04-07 17:59:25.807453015 +0200
 Birth: 2024-04-07 17:59:25.807453015 +0200
1 Like
12

Thanks for spotting this. Clearly a copy&paste error.

1 Like
13

Fixed:

dehakkelaar@ph6b:~$ find /usr/ -iname '*pihole*'
/usr/local/share/man/man8/pihole-FTL.8
/usr/local/share/man/man8/pihole.8
/usr/local/bin/pihole
/usr/bin/pihole-FTL

dehakkelaar@ph6b:~$ sudo pihole updatePihole
[..]
  [â] Done.

dehakkelaar@ph6b:~$ find /usr/ -iname '*pihole*'
/usr/local/share/man/man8/pihole.8
/usr/local/bin/pihole
/usr/bin/pihole-FTL
14

This topic was automatically closed 21 days after the last reply. New replies are no longer allowed.