#1124774 debconf-doc: Where is the user’s guide?

#1124774#5
Date:
2026-01-06 15:02:48 UTC
From:
To:
/usr/share/doc/debconf/README.Debian says:

Running “aptitude show debconf-doc” shows:

This states that there is a “debconf user's guide”. When working on
Debian offline, such a thing would be indispensible. But it apparently
does not exist in that package. After installing debconf-doc, I
checked /usr/share/doc/debconf-doc and only see NEWS, copyright, and a
changelog. According to “apt-file show debconf-doc”, there are just a
few man pages.

The man page for debconf(1) does not pass for a user’s guide. The
debconf(7) man page gives some more information but still could not
pass for a user’s guide. Where are all the configuration fields
documented?

For example, I needed to solve a simple problem that should in
principle be solvable using a debconf command. After a new Debian
installation using primarily default options, we end up with
gnome. The machine goes to sleep very quick, after like 5 min of no
GUI activity. This is quite annoying for a terminal user because
typing running apps does not count as activity. Sleep mode could be
disabled in Gnome’s power settings, but the setting has no
effect. This is perhaps because a normal user should not have control
over system power modes.

Fair enough, but how does root change that?  When offline, we would
expect root to be able to use debconf to change that setting. But the
power settings are not mentioned nowhere in the debconf docs.

I see 2 possible fixes here:

 - (high effort) produce a comprehensive document that covers all possible pkg config fields
 - (low effort) edit the debconf-doc pkg description in apt to say something like “this is just a basic man page in English, French, and Spanish, and NOT a user guide covering config fields; (help wanted to create a comprehensive user guide)”.

#1124774#10
Date:
2026-01-06 17:18:41 UTC
From:
To:
On Tue, Jan 06, 2026 at 04:02:48PM +0100, Manny wrote:
[..]

/usr/share/doc/debconf/README says:

| The main sources of documentation on debconf for users are:
|
| 	- The debconf(7) man page is a complete debconf user's guide.
| 	- The debconf.conf(5) man page is useful reading if you want to use
| 	  a different debconf database setup.

This documentation cannot exist in debconf(-doc), as *packages using
debconf* define the fields and their meaning. This is also true for
the installer.

Chris