svn commit: r303682 - head/usr.sbin/kgzip

[Ed Maste]

Author: emaste
Date: Tue Aug  2 21:48:26 2016
New Revision: 303682
URL: https://svnweb.freebsd.org/changeset/base/303682

Log:
  kgzip.8: note that it is deprecated and clarify BUGS section
  
  kgzip is only useful on i386 and has a number of other limitations.
  We're better served by officially deprecating it and encouraging users
  to use loader(8) instead.
  
  Reviewed by:	dteske, wblock
  Differential Revision:	https://reviews.freebsd.org/D7098

Modified:
  head/usr.sbin/kgzip/kgzip.8

Modified: head/usr.sbin/kgzip/kgzip.8
==============================================================================
--- head/usr.sbin/kgzip/kgzip.8	Tue Aug  2 21:17:59 2016	(r303681)
+++ head/usr.sbin/kgzip/kgzip.8	Tue Aug  2 21:48:26 2016	(r303682)
@@ -24,7 +24,7 @@
 .\"
 .\" $FreeBSD$
 .\"
-.Dd July 19, 1999
+.Dd August 2, 2016
 .Dt KGZIP 8
 .Os
 .Sh NAME
@@ -38,6 +38,14 @@
 .Op Fl o Ar output
 .Ar file
 .Sh DESCRIPTION
+.Bf -symbolic
+This utility is deprecated.
+Users are advised to use
+.Xr loader 8
+and compress the kernel with
+.Xr gzip 1 .
+.Ef
+.Pp
 The
 .Nm
 utility compresses a kernel or some other bootable binary.
@@ -137,7 +145,12 @@ The default loader
 As symbols are lost, the usefulness of this utility for compressing
 kernels is limited to situations where
 .Xr loader 8
-cannot be used; otherwise the preferred method of compressing a kernel
+cannot be used.
+.Pp
+.Pa kgzldr.o
+is only available for the i386 and pc98 architectures.
+.Pp
+The preferred method of compressing a kernel
 is simply to
 .Xr gzip 1
 it.