Files
sudo/doc/fixmdoc.sh
Todd C. Miller 8b1d645534 Simplify usage messages a bit and make --help output more closely
resemble GNU usage wrt long options.  Sync usage and man page
SYNOPSYS sections and improve long options in the manual pages.
Now that we have long options we don't need to give the mnemonic
for the single-character options in the description.
2013-08-14 10:30:51 -06:00

165 lines
3.5 KiB
Bash
Executable File

#!/bin/sh
#
# Copyright (c) 2012-2013 Todd C. Miller <Todd.Miller@courtesan.com>
#
# Permission to use, copy, modify, and distribute this software for any
# purpose with or without fee is hereby granted, provided that the above
# copyright notice and this permission notice appear in all copies.
#
# THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
# WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
# MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
# ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
# WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
# ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
# OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
#
OUTFILE="$1"
rm -f "$OUTFILE"
> "$OUTFILE"
# Page specific hacks
case "$OUTFILE" in
sudo.mdoc.sed)
# Replace "0 minutes" with "unlimited"
cat >>"$OUTFILE" <<-'EOF'
/^\.Li 0$/ {
N
s/^\.Li 0\nminutes\.$/unlimited./
}
EOF
# BSD auth
BA_FLAG=
if [ X"$BAMAN" != X"1" ]; then
BA_FLAG='/^.*\n\.Op Fl a Ar type/{;N;/^.*\n\.Ek$/d;};'
cat >>"$OUTFILE" <<-'EOF'
/^\.It Fl a Ar type/,/BSD authentication\.$/ {
d
}
EOF
fi
# BSD login class
LC_FLAG=
if [ X"$LCMAN" != X"1" ]; then
LC_FLAG='/^.*\n\.Op Fl c Ar class/{;N;/^.*\n\.Ek$/d;};'
cat >>"$OUTFILE" <<-'EOF'
/^\.It Fl c Ar class/,/BSD login classes\.$/ {
d
}
/^\.Xr login_cap 3 ,$/d
/^BSD login class$/ {
N
/^BSD login class\n\.It$/d
}
EOF
fi
# SELinux
SE_FLAG=
if [ X"$SEMAN" != X"1" ]; then
SE_FLAG='/^.*\n\.Op Fl r Ar role/{;N;/^.*\n\.Ek$/d;};/^.*\n\.Op Fl t Ar type/{;N;/^.*\n\.Ek$/d;};'
cat >>"$OUTFILE" <<-'EOF'
/^\.It Fl r Ar role/,/^\.Ar role \.$/ {
d
}
/^\.It Fl t Ar type/,/derived from the role\.$/ {
d
}
/^SELinux role and type$/ {
N
/^SELinux role and type\n\.It$/d
}
EOF
fi
# Solaris privileges
if [ X"$PSMAN" != X"1" ]; then
cat >>"$OUTFILE" <<-'EOF'
/^Solaris project$/ {
N
N
N
/^Solaris project\n\.It\nSolaris privileges\n\.It$/d
}
EOF
fi
# Unsupported flags must be removed together
if [ -n "$BA_FLAG$LC_FLAG$SE_FLAG" ]; then
cat >>"$OUTFILE" <<-EOF
/^\.Bk -words\$/ {
N
$BA_FLAG$LC_FLAG$SE_FLAG
}
EOF
fi
;;
sudoers.mdoc.sed)
# Subsections to remove (SELinux and Solaris are adjacent)
RM_SS=
if [ X"$PSMAN" != X"1" ]; then
if [ X"$SEMAN" != X"1" ]; then
RM_SS='/^\.Ss SELinux_Spec/,/^\.Ss [^S]/{;/^\.Ss [^S][^o][^l]/!d;};'
else
RM_SS='/^\.Ss Solaris_Priv_Spec/,/^\.Ss/{;/^\.Ss [^S][^o][^l]/!d;};'
fi
elif [ X"$SEMAN" != X"1" ]; then
RM_SS='/^\.Ss SELinux_Spec/,/^\.Ss/{;/^\.Ss [^S][^E][^L]/!d;};'
fi
if [ -n "$RM_SS" ]; then
cat >>"$OUTFILE" <<-EOF
$RM_SS
EOF
fi
# BSD login class
if [ X"$LCMAN" != X"1" ]; then
cat >>"$OUTFILE" <<-'EOF'
/^On BSD systems/,/\.$/ {
d
}
/^\.It use_loginclass$/,/^\.It/ {
/^\.It [^u][^s][^e][^_][^l]/!d
}
EOF
fi
# Solaris PrivSpec
if [ X"$PSMAN" != X"1" ]; then
cat >>"$OUTFILE" <<-'EOF'
s/Solaris_Priv_Spec? //
/^Solaris_Priv_Spec ::=/ {
N
d
}
/^\.It limitprivs$/,/^\.It/ {
/^\.It [^l][^i][^m][^i][^t]/!d
}
/^\.It privs$/,/^\.It/ {
/^\.It [^p][^r][^i][^v][^s]$/!d
}
/^On Solaris 10/,/^\.Pp/ {
d
}
EOF
fi
# SELinux
if [ X"$SEMAN" != X"1" ]; then
cat >>"$OUTFILE" <<-'EOF'
s/SELinux_Spec? //
/^SELinux_Spec ::=/ {
N
d
}
/^\.It [rt][oy][lp]e$/,/^\.It/ {
/^\.It [^rt][^oy][^lp][^e]$/!d
}
EOF
fi
;;
esac