From 31c464e0a298965b2b504e2363ebd29396b42fca Mon Sep 17 00:00:00 2001 From: espie Date: Fri, 3 Jan 2014 13:10:04 +0000 Subject: [PATCH] finish moving annotations around --- usr.sbin/pkg_add/package.5 | 73 ++++++++++++++++++++++++++++++++++- usr.sbin/pkg_add/pkg_create.1 | 59 ++-------------------------- 2 files changed, 75 insertions(+), 57 deletions(-) diff --git a/usr.sbin/pkg_add/package.5 b/usr.sbin/pkg_add/package.5 index bb564523273..fcc57b5edf2 100644 --- a/usr.sbin/pkg_add/package.5 +++ b/usr.sbin/pkg_add/package.5 @@ -1,4 +1,4 @@ -.\" $OpenBSD: package.5,v 1.13 2014/01/03 12:54:59 espie Exp $ +.\" $OpenBSD: package.5,v 1.14 2014/01/03 13:10:04 espie Exp $ .\" Copyright (c) 2005-2006 Marc Espie .\" .\" Permission to use, copy, modify, and distribute this software for any @@ -91,6 +91,7 @@ This corresponds to .Fl A Ar arches of .Xr pkg_create 1 +.Pp .It Cm @comment pkgpath=path cdrom=yes/no ftp=yes/no Historical accident. This specific comment encodes the actual @@ -114,6 +115,76 @@ Record a dependency declared using the option of .Xr pkg_create 1 . .Pp +.It Xo +.Cm @digital-signature +.Sm off +.Ar style : +.Ar date : +.Ar b64sig +.Sm on +.Xc +Record a digital signature of the packing-list, corresponding +to +.Xr pkg_create 1 Ns 's +.Fl s +option. +.Pp +.It Cm @link Ar name +Added after a file entry by +.Nm +to record that the entry is actually a hard link. +.Pp +.It Cm @localbase Ar base +Used internally to record the settings of +.Fl L +option. +.Pp +.It Cm @name Ar pkgname +Set the name of the package. +This name is potentially different than the name of +the file it came in, and is used when keeping track of the package +for later deinstallation. +.Xr pkg_create 1 +will derive this field from the package file name. +.Pp +.It Cm @option Ar name +Some options are automatically inserted by the package tools: +.Bl -tag -width indent +.It Ar manual-installation +Record that a package has been explicitly installed by the user, +and not as a result of a dependency look-up. +Refer to +.Xr pkg_add 1 Ns 's +.Fl a +option for details. +.El +.Pp +.It Cm @sha +Added after a file entry by +.Xr pkg_create 1 +to record the files's cryptographic checksum, +as a sha256 digest encoded in base64. +.Pp +.It Cm @size +Added after a file entry by +.Xr pkg_create 1 +to record a file size. +.Pp +.It Cm @symlink Ar name +Added after a file entry by +.Xr pkg_create 1 +to record that the entry is actually a symbolic link. +.Pp +.It Cm @url +Original location of the package, automatically recorded in installed packages +by +.Xr pkg_add 1 . +.Pp +.It Cm @vendor +Internal annotation corresponding to +.Xr pkg_create 1 Ns 's +.Fl D Ar VENDOR +option. .Pp .It Cm @wantlib Ar libspec Record a library requirement declared using the option diff --git a/usr.sbin/pkg_add/pkg_create.1 b/usr.sbin/pkg_add/pkg_create.1 index e91554c2606..d2aeb5eda95 100644 --- a/usr.sbin/pkg_add/pkg_create.1 +++ b/usr.sbin/pkg_add/pkg_create.1 @@ -1,4 +1,4 @@ -.\" $OpenBSD: pkg_create.1,v 1.85 2014/01/03 12:54:59 espie Exp $ +.\" $OpenBSD: pkg_create.1,v 1.86 2014/01/03 13:10:04 espie Exp $ .\" .\" Documentation and design originally from FreeBSD. All the code has .\" been rewritten since. We keep the documentation's notice: @@ -535,10 +535,6 @@ Set default group ownership for all subsequently extracted files to Use without an arg to set back to default (extraction) group ownership. .Pp -.It Cm @ignore -Was used internally to tell extraction to ignore the next file. -No longer needed. -.Pp .It Cm @info Ar filename Specialized version of .Cm @file , @@ -561,16 +557,6 @@ See .Sq VARIABLE SUBSTITUTION AND FRAGMENT INCLUSION for some details. .Pp -.It Cm @link Ar name -Added after a file entry by -.Nm -to record that the entry is actually a hard link. -.Pp -.It Cm @localbase Ar base -Used internally to record the settings of -.Fl L -option. -.Pp .It Cm @man Ar filename Specialized version of .Cm @file , @@ -586,15 +572,6 @@ remove .Xr apropos 1 database when needed. .Pp -.It Cm @md5 -Added after a file entry by -.Nm -to record the files's cryptographic checksum. -Replaced by -.Cm @sha -since -.Ox 4.5 . -.Pp .It Cm @mode Ar mode Set default permission for all subsequently extracted files to .Ar mode . @@ -603,16 +580,6 @@ Format is the same as that used by the command. Use without an arg to set back to default (extraction) permissions. .Pp -.It Cm @name Ar pkgname -Set the name of the package. -This name is potentially different than the name of -the file it came in, and is used when keeping track of the package -for later deinstallation. -Note that -.Nm -will derive this field from the package name and add it automatically -if none is given. -.Pp .It Cm @newgroup Ar name : Ns Ar gid During .Xr pkg_add 1 , @@ -664,7 +631,7 @@ other installed packages don't list the same user. .It Cm @option Ar name Effects vary depending on .Ar name . -Some options are not documented yet. +These are the user settable options .Bl -tag -width indent .It Ar always-update By default, @@ -802,12 +769,6 @@ If ends with a slash, it refers to a configuration directory instead. .Pp -.It Cm @sha -Added after a file entry by -.Nm -to record the files's cryptographic checksum, -as a sha256 digest encoded in base64. -.Pp .It Cm @shell Ar filename Specialized version of .Cm @file , @@ -815,16 +776,6 @@ to handle shells. See .Xr shells 5 . .Pp -.It Cm @size -Added after a file entry by -.Nm -to record a file size. -.Pp -.It Cm @symlink Ar name -Added after a file entry by -.Nm -to record that the entry is actually a symbolic link. -.Pp .It Cm @sysctl Ar var Ns = Ns Ar val .It Cm @sysctl Ar var Ns \*(Ge Ns Ar val During @@ -871,12 +822,8 @@ Similar to .Cm @unexec , except it only gets executed while removing an old package during updates, and not during true deletions. -.Pp -.It Cm @url -Original location of the package, automatically recorded in installed packages -by -.Xr pkg_add 1 . .El +.Pp See .Xr package 5 for other internal annotations that are automatically added by the -- 2.20.1