os/doc
3
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity

Restructurate the custom keywords section in subsections.

Browse source 
Reviewed by:	brd, wblock
Sponsored by:	Absolight
Differential Revision:	https://reviews.freebsd.org/D3755
This commit is contained in:
Mathieu Arnold 2015-10-01 14:34:20 +00:00
parent f02de77171
commit 862b2b51c6
Notes: svn2git 2020-12-08 03:00:23 +00:00 
svn path=/head/; revision=47466
1 changed files with 56 additions and 29 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

85
en_US.ISO8859-1/books/porters-handbook/plist/chapter.xml
View file

@ -667,14 +667,45 @@ PLIST_SUB+= X11I386="@comment "
directory. The settings for each keyword are stored in a directory. The settings for each keyword are stored in a
<acronym>UCL</acronym> file named <acronym>UCL</acronym> file named
<filename><replaceable>keyword</replaceable>.ucl</filename>. <filename><replaceable>keyword</replaceable>.ucl</filename>.
The file must contain at least one of the next The file must contain at least one of these sections:</para>
sections:</para>
<variablelist> <itemizedlist>
<varlistentry xml:id="plist-keywords-attributes"> <listitem>
<term><literal>attributes</literal></term> <para><literal>attributes</literal></para>
</listitem>
<listitem>
<para><literal>action</literal></para>
</listitem>
<listitem>
<para><literal>pre-install</literal></para>
</listitem>
<listitem>
<para><literal>post-install</literal></para>
</listitem>
<listitem>
<para><literal>pre-deinstall</literal></para>
</listitem>
<listitem>
<para><literal>post-deinstall</literal></para>
</listitem>
<listitem>
<para><literal>pre-upgrade</literal></para>
</listitem>
<listitem>
<para><literal>post-upgrade</literal></para>
</listitem>
</itemizedlist>
<sect3 xml:id="plist-keywords-attributes">
<title><literal>attributes</literal></title>
<listitem>
<para>Changes the owner, group, or mode used by the <para>Changes the owner, group, or mode used by the
keyword. Contains an associative array where the keyword. Contains an associative array where the
possible keys are <literal>owner</literal>, possible keys are <literal>owner</literal>,
@ -683,13 +714,11 @@ PLIST_SUB+= X11I386="@comment "
and a file mode. For example:</para> and a file mode. For example:</para>
<programlisting>attributes: { owner: "games", group: "games", mode: 0555 }</programlisting> <programlisting>attributes: { owner: "games", group: "games", mode: 0555 }</programlisting>
</listitem> </sect3>
</varlistentry>
<varlistentry xml:id="plist-keywords-action"> <sect3 xml:id="plist-keywords-action">
<term><literal>action</literal></term> <title><literal>action</literal></title>
<listitem>
<para>Defines what happens to the keyword's parameter. <para>Defines what happens to the keyword's parameter.
Contains an array where the possible values are:</para> Contains an array where the possible values are:</para>
@ -783,13 +812,11 @@ PLIST_SUB+= X11I386="@comment "
</listitem> </listitem>
</varlistentry> </varlistentry>
</variablelist> </variablelist>
</listitem> </sect3>
</varlistentry>
<varlistentry xml:id="plist-keywords-arguments"> <sect3 xml:id="plist-keywords-arguments">
<term><literal>arguments</literal></term> <title><literal>arguments</literal></title>
<listitem>
<para>If set to <literal>true</literal>, adds argument <para>If set to <literal>true</literal>, adds argument
handling, splitting the whole line, <literal>%@</literal>, handling, splitting the whole line, <literal>%@</literal>,
into numbered arguments, <literal>%1</literal>, into numbered arguments, <literal>%1</literal>,
@ -810,18 +837,16 @@ other.content</programlisting>
argument number must be specified. For example:</para> argument number must be specified. For example:</para>
<programlisting>actions: [file(1)]</programlisting> <programlisting>actions: [file(1)]</programlisting>
</listitem> </sect3>
</varlistentry>
<varlistentry xml:id="plist-keywords-pre-post"> <sect3 xml:id="plist-keywords-pre-post">
<term><literal>pre-install</literal></term> <title><literal>pre-install</literal>,
<term><literal>post-install</literal></term> <literal>post-install</literal>,
<term><literal>pre-deinstall</literal></term> <literal>pre-deinstall</literal>,
<term><literal>post-deinstall</literal></term> <literal>post-deinstall</literal>,
<term><literal>pre-upgrade</literal></term> <literal>pre-upgrade</literal>,
<term><literal>post-upgrade</literal></term> <literal>post-upgrade</literal></title>
<listitem>
<para>These keywords contains a &man.sh.1; script to be <para>These keywords contains a &man.sh.1; script to be
executed before or after installation, deinstallation, executed before or after installation, deinstallation,
or upgrade of the package. In addition to the usual or upgrade of the package. In addition to the usual
@ -831,9 +856,10 @@ other.content</programlisting>
linkend="plist-keywords-base-exec"/>, there is a new linkend="plist-keywords-base-exec"/>, there is a new
one, <literal>%@</literal>, which represents the one, <literal>%@</literal>, which represents the
argument of the keyword.</para> argument of the keyword.</para>
</listitem> </sect3>
</varlistentry>
</variablelist> <sect3 xml:id="plist-keywords-examples">
<title>Custom Keyword Examples</title>
<example xml:id="plist-keywords-fc-example"> <example xml:id="plist-keywords-fc-example">
<title>Example of a <literal>@dirrmtryecho</literal> <title>Example of a <literal>@dirrmtryecho</literal>
@ -888,6 +914,7 @@ pre-deinstall: &lt;&lt;EOD
fi fi
EOD</programlisting> EOD</programlisting>
</example> </example>
</sect3>
</sect2> </sect2>
</sect1> </sect1>
</chapter> </chapter>