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/
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
It was already removed two years ago.
pi-hole:development
← pi-hole:tweak/manpages
opened 06:18AM - 29 Dec 21 UTC
- [x] I have read and understood the [contributors guide](https://github.com/pi-… hole/pi-hole/blob/master/CONTRIBUTING.md), as well as this entire template.
- [x] I have made only one major change in my proposed changes.
- [x] I have commented my proposed changes within the code.
- [x] I have tested my proposed changes, and have included unit tests where possible.
- [x] I am willing to help maintain this change if there are issues with it later.
- [x] I give this submission freely and claim no ownership.
- [x] It is compatible with the [EUPL 1.2 license](https://opensource.org/licenses/EUPL-1.1)
- [x] I have squashed any insignificant commits. ([`git rebase`](http://gitready.com/advanced/2009/02/10/squashing-commits-with-rebase.html))
Please make sure you [Sign Off](https://docs.pi-hole.net/guides/github/how-to-signoff/) all commits. Pi-hole enforces the [DCO](https://docs.pi-hole.net/guides/github/contributing/).
---
**What does this PR aim to accomplish?:**
Removes the outdated `pihole-FTL.conf` manpage.
FTL's config options change quite often. We document all changes to FTL's config options in `https://https://docs.pi-hole.net/ftldns/configfile/`. Updating them all also in the man pages has been forgotten for over 1 year now and is likely to be forgotten again. Having them up-to-date online in one place seems sufficient given that Pi-hole is a DNS forwarder.
I added a link to the online resource in the manpage of `pihole-FTL`.
![Bildschirmfoto zu 2021-12-29 07-17-20](https://user-images.githubusercontent.com/26622301/147632834-a19f8fb9-1b7c-4c7b-b198-c3b5e9c378b4.png)
**How does this PR accomplish the above?:**
Remove the outdated file, update the installer to remove it from existing installations.
@deHakkelaar
There is a new help function for FTL.
Did you try pihole-FTL help
? (or pihole-FTL -h
)
1 Like
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?
I know.
And the pihole command does have bash completion
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
Sorry, I mixed it.
__
That's strange, because the code to install it, is still there Is gone...
committed 07:39PM - 30 May 23 UTC
Signed-off-by: Christian König <ckoenig@posteo.de>
__
The reason was probably that FTL
has an extensive built-in help function starting with
pi-hole:development
← pi-hole:new/colorful_cli
opened 10:35AM - 09 Dec 22 UTC
# What does this implement/fix?
This PR adds colors (if supported by the term… inal) to verbose version output and completely revamps the help function.
When the "consumer" is not a terminal (e.g. a pipe), no escape sequences will be added.
---
**`pihole-FTL -vv` BEFORE**
![vv-old](https://user-images.githubusercontent.com/16748619/206682516-ee5367a7-c1c8-4d14-ae41-b86d26365f4f.png)
**`pihole-FTL -vv` NOW**
![vv-new](https://user-images.githubusercontent.com/16748619/206682566-2991c908-c0e5-46ed-b0e4-2c780773853a.png)
---
**`pihole-FTL -h` BEFORE**
![help-old](https://user-images.githubusercontent.com/16748619/206682729-0e47abb6-b804-4071-a678-f996af18c922.png)
**`pihole-FTL -h` NOW**
![help-new](https://user-images.githubusercontent.com/16748619/206682800-899a13d9-54f5-4e2a-9655-34ee4de568e7.png)
---
**Related issue or feature (if applicable):** N/A
**Pull request in [docs](https://github.com/pi-hole/docs) with documentation (if applicable):** N/A
---
**By submitting this pull request, I confirm the following:**
1. I have read and understood the [contributors guide](https://docs.pi-hole.net/guides/github/contributing/), as well as this entire template. I understand which branch to base my commits and Pull Requests against.
4. I have commented my proposed changes within the code.
6. I am willing to help maintain this change if there are issues with it later.
7. It is compatible with the [EUPL 1.2 license](https://opensource.org/licenses/EUPL-1.1)
8. I have squashed any insignificant commits. ([`git rebase`](http://gitready.com/advanced/2009/02/10/squashing-commits-with-rebase.html))
## Checklist:
- [x] The code change is tested and works locally.
- [x] I based my code and PRs against the repositories `developmental` branch.
- [x] I [signed off](https://docs.pi-hole.net/guides/github/how-to-signoff/) all commits. Pi-hole enforces the [DCO](https://docs.pi-hole.net/guides/github/dco/) for all contributions
- [x] I [signed](https://docs.github.com/en/authentication/managing-commit-signature-verification/signing-commits) all my commits. Pi-hole requires signatures to verify authorship
- [x] I have read the above and my PR is ready for review.
1 Like
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.
Hurts a bit though that it doesnt have a man page anymore
$ 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)
committed 07:39PM - 30 May 23 UTC
Signed-off-by: Christian König <ckoenig@posteo.de>
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
Thanks for spotting this. Clearly a copy&paste error.
pi-hole:development
← pi-hole:fix/remove_man
opened 07:11PM - 30 Sep 24 UTC
**What does this PR aim to accomplish?:**
Fixes a copy&paste error of https:/… /github.com/pi-hole/pi-hole/commit/f7b9d70054758137d60318e6df32ebb0d92987fe.
Discovered by https://discourse.pi-hole.net/t/v6-development-branch-man-page-gone/72644/11?u=yubiuser
---
**By submitting this pull request, I confirm the following:**
1. I have read and understood the [contributors guide](https://docs.pi-hole.net/guides/github/contributing/), as well as this entire template. I understand which branch to base my commits and Pull Requests against.
2. I have commented my proposed changes within the code and I have tested my changes.
3. I am willing to help maintain this change if there are issues with it later.
4. It is compatible with the [EUPL 1.2 license](https://opensource.org/licenses/EUPL-1.1)
5. I have squashed any insignificant commits. ([`git rebase`](http://gitready.com/advanced/2009/02/10/squashing-commits-with-rebase.html))
6. I have checked that another pull request for this purpose does not exist.
7. I have considered, and confirmed that this submission will be valuable to others.
8. I accept that this submission may not be used, and the pull request closed at the will of the maintainer.
9. I give this submission freely, and claim no ownership to its content.
---
- [x] I have read the above and my PR is ready for review. *Check this box to confirm*
1 Like
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