From owner-svn-doc-head@freebsd.org Thu Oct 1 14:34:21 2015 Return-Path: Delivered-To: svn-doc-head@mailman.ysv.freebsd.org Received: from mx1.freebsd.org (mx1.freebsd.org [IPv6:2001:1900:2254:206a::19:1]) by mailman.ysv.freebsd.org (Postfix) with ESMTP id 42404A0C1CE; Thu, 1 Oct 2015 14:34:21 +0000 (UTC) (envelope-from mat@FreeBSD.org) Received: from repo.freebsd.org (repo.freebsd.org [IPv6:2001:1900:2254:2068::e6a:0]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (Client did not present a certificate) by mx1.freebsd.org (Postfix) with ESMTPS id 2671214F3; Thu, 1 Oct 2015 14:34:21 +0000 (UTC) (envelope-from mat@FreeBSD.org) Received: from repo.freebsd.org ([127.0.1.70]) by repo.freebsd.org (8.15.2/8.15.2) with ESMTP id t91EYLZZ026679; Thu, 1 Oct 2015 14:34:21 GMT (envelope-from mat@FreeBSD.org) Received: (from mat@localhost) by repo.freebsd.org (8.15.2/8.15.2/Submit) id t91EYLNX026678; Thu, 1 Oct 2015 14:34:21 GMT (envelope-from mat@FreeBSD.org) Message-Id: <201510011434.t91EYLNX026678@repo.freebsd.org> X-Authentication-Warning: repo.freebsd.org: mat set sender to mat@FreeBSD.org using -f From: Mathieu Arnold Date: Thu, 1 Oct 2015 14:34:21 +0000 (UTC) To: doc-committers@freebsd.org, svn-doc-all@freebsd.org, svn-doc-head@freebsd.org Subject: svn commit: r47466 - head/en_US.ISO8859-1/books/porters-handbook/plist X-SVN-Group: doc-head MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit X-BeenThere: svn-doc-head@freebsd.org X-Mailman-Version: 2.1.20 Precedence: list List-Id: SVN commit messages for the doc tree for head List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Thu, 01 Oct 2015 14:34:21 -0000 Author: mat Date: Thu Oct 1 14:34:20 2015 New Revision: 47466 URL: https://svnweb.freebsd.org/changeset/doc/47466 Log: Restructurate the custom keywords section in subsections. Reviewed by: brd, wblock Sponsored by: Absolight Differential Revision: https://reviews.freebsd.org/D3755 Modified: head/en_US.ISO8859-1/books/porters-handbook/plist/chapter.xml Modified: head/en_US.ISO8859-1/books/porters-handbook/plist/chapter.xml ============================================================================== --- head/en_US.ISO8859-1/books/porters-handbook/plist/chapter.xml Thu Oct 1 14:34:14 2015 (r47465) +++ head/en_US.ISO8859-1/books/porters-handbook/plist/chapter.xml Thu Oct 1 14:34:20 2015 (r47466) @@ -667,14 +667,45 @@ PLIST_SUB+= X11I386="@comment " directory. The settings for each keyword are stored in a UCL file named keyword.ucl. - The file must contain at least one of the next - sections: + The file must contain at least one of these sections: - - - attributes + + + attributes + + + + action + + + + pre-install + + + + post-install + + + + pre-deinstall + + + + post-deinstall + + + + pre-upgrade + + + + post-upgrade + + + + + <literal>attributes</literal> - Changes the owner, group, or mode used by the keyword. Contains an associative array where the possible keys are owner, @@ -683,13 +714,11 @@ PLIST_SUB+= X11I386="@comment " and a file mode. For example: attributes: { owner: "games", group: "games", mode: 0555 } - - + - - action + + <literal>action</literal> - Defines what happens to the keyword's parameter. Contains an array where the possible values are: @@ -783,13 +812,11 @@ PLIST_SUB+= X11I386="@comment " - - + - - arguments + + <literal>arguments</literal> - If set to true, adds argument handling, splitting the whole line, %@, into numbered arguments, %1, @@ -810,18 +837,16 @@ other.content argument number must be specified. For example: actions: [file(1)] - - + - - pre-install - post-install - pre-deinstall - post-deinstall - pre-upgrade - post-upgrade + + <literal>pre-install</literal>, + <literal>post-install</literal>, + <literal>pre-deinstall</literal>, + <literal>post-deinstall</literal>, + <literal>pre-upgrade</literal>, + <literal>post-upgrade</literal> - These keywords contains a &man.sh.1; script to be executed before or after installation, deinstallation, or upgrade of the package. In addition to the usual @@ -831,9 +856,10 @@ other.content linkend="plist-keywords-base-exec"/>, there is a new one, %@, which represents the argument of the keyword. - - - + + + + Custom Keyword Examples Example of a <literal>@dirrmtryecho</literal> @@ -888,6 +914,7 @@ pre-deinstall: <<EOD fi EOD</programlisting> </example> + </sect3> </sect2> </sect1> </chapter>