openafs/doc/man-pages/pod5
Michael Meffie b0cafad62a doc: Show correct path to BosConfig when using modern paths
The BosConfig.5 man page shows the incorrect path to the BosConfig file
when modern installation paths are used.  For example, BosConfig.5 man
page distributed by Debian contains the text:

    The file must reside in the /var/lib/openafs/local directory ...

which should read:

    The file must reside in the /etc/openafs directory ...

The man page files contain Transarc-style paths which are translated to
the configured paths by the install target.  The path /usr/afs/local in
the BosConfig pod file is interpreted as @afslocaldir@, not the correct
@afsbosconfigdir@.

Change the BosConfig POD text to trigger a special substitution case in
the install-man script. This case is is already in use to correctly
translate paths of the BosConfig.new and BosConfig files the bosserver
man page.

    /usr/afs/local/BosConfig -> @afsbosconfigdir@/BosConfig

Using this rule requires a change to the text to show the fully
qualified path to the BosConfig file, instead of just the directory
name.

Change-Id: If1c5872dd86c7c1a5de98fb37daef903cd10b26b
Reviewed-on: https://gerrit.openafs.org/14908
Tested-by: BuildBot <buildbot@rampaginggeek.com>
Reviewed-by: Benjamin Kaduk <kaduk@mit.edu>
2022-02-23 12:23:32 -05:00
..
afs_cache.pod man5-editing-pass-20051213 2005-12-14 01:30:20 +00:00
afs_volume_header.pod man5-editing-pass-20051213 2005-12-14 01:30:20 +00:00
afs.pod Document KeyFileExt(5) 2015-08-27 22:31:44 -04:00
afsmonitor.pod doc: document the version subcommand 2015-11-12 11:29:37 -05:00
afszcm.cat.pod man5-editing-pass-20051213 2005-12-14 01:30:20 +00:00
AuthLog.dir.pod Add warnings for Authentication Server commands 2010-05-31 20:40:58 -07:00
AuthLog.pod Add warnings for Authentication Server commands 2010-05-31 20:40:58 -07:00
BackupLog.pod externalize log rotation 2016-04-26 19:34:59 -04:00
bdb.DB0.pod man5-editing-pass-20051213 2005-12-14 01:30:20 +00:00
BosConfig.pod doc: Show correct path to BosConfig when using modern paths 2022-02-23 12:23:32 -05:00
BosLog.pod externalize log rotation 2016-04-26 19:34:59 -04:00
butc_logs.pod man5-editing-pass-20051213 2005-12-14 01:30:20 +00:00
butc.pod doc: fix some broken link specifications 2011-06-22 11:01:09 -07:00
cacheinfo.pod pod-updates-20060227 2006-02-27 20:46:25 +00:00
CellAlias.pod doc: replace hostnames with IETF example hostnames 2012-02-17 20:51:58 -08:00
CellServDB.pod doc: add linked cells description to man pages 2013-11-01 18:53:13 -07:00
FileLog.pod externalize log rotation 2016-04-26 19:34:59 -04:00
fms.log.pod man5-editing-pass-20051213 2005-12-14 01:30:20 +00:00
FORCESALVAGE.pod man5-editing-pass-20051213 2005-12-14 01:30:20 +00:00
kaserver.DB0.pod Add warnings for Authentication Server commands 2010-05-31 20:40:58 -07:00
kaserverauxdb.pod Add warnings for Authentication Server commands 2010-05-31 20:40:58 -07:00
KeyFile.pod Remove references to IBM AFS 2010-05-26 12:05:45 -07:00
KeyFileExt.pod Document KeyFileExt(5) 2015-08-27 22:31:44 -04:00
krb.conf.pod Document krb.excl 2010-07-30 18:56:07 -07:00
krb.excl.pod Document krb.excl 2010-07-30 18:56:07 -07:00
NetInfo.pod auth: Allow subnet ranges in NetInfo and NetRestrict 2016-05-05 22:50:23 -04:00
NetRestrict.pod auth: Allow subnet ranges in NetInfo and NetRestrict 2016-05-05 22:50:23 -04:00
NoAuth.pod Remove recommendation to use NoAuth from NoAuth.5 2021-06-11 03:12:49 -04:00
prdb.DB0.pod pod-updates-20060227 2006-02-27 20:46:25 +00:00
PtLog.pod doc: add the PtLog man page 2016-12-22 17:21:50 -05:00
SALVAGE.fs.pod man5-editing-pass-20051213 2005-12-14 01:30:20 +00:00
salvage.lock.pod man5-editing-pass-20051213 2005-12-14 01:30:20 +00:00
SalvageLog.pod Document in SalvageLog(5) the per-partition salvager logs 2010-06-03 19:58:27 -07:00
sysid.pod Remove references to IBM AFS 2010-05-26 12:05:45 -07:00
tapeconfig.pod Remove references to IBM AFS 2010-05-26 12:05:45 -07:00
ThisCell.pod doc: replace hostnames with IETF example hostnames 2012-02-17 20:51:58 -08:00
UserList.pod man5-editing-pass-20051213 2005-12-14 01:30:20 +00:00
uss_bulk.pod doc: the last partition name is /vicepiu 2018-09-14 08:35:26 -04:00
uss.pod doc: the last partition name is /vicepiu 2018-09-14 08:35:26 -04:00
vldb.DB0.pod man5-editing-pass-20051213 2005-12-14 01:30:20 +00:00
VLLog.pod doc: update information about vlserver logging 2016-11-24 17:29:56 -05:00
VolserLog.pod externalize log rotation 2016-04-26 19:34:59 -04:00