Date: Thu, 1 Oct 2015 14:34:32 +0000 (UTC) From: Mathieu Arnold <mat@FreeBSD.org> To: doc-committers@freebsd.org, svn-doc-all@freebsd.org, svn-doc-head@freebsd.org Subject: svn commit: r47468 - head/en_US.ISO8859-1/books/porters-handbook/plist Message-ID: <201510011434.t91EYWNR026777@repo.freebsd.org>
next in thread | raw e-mail | index | archive | help
Author: mat Date: Thu Oct 1 14:34:32 2015 New Revision: 47468 URL: https://svnweb.freebsd.org/changeset/doc/47468 Log: Whitespace fixes, translators can ignore. Sponsored by: Absolight 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:26 2015 (r47467) +++ head/en_US.ISO8859-1/books/porters-handbook/plist/chapter.xml Thu Oct 1 14:34:32 2015 (r47468) @@ -27,8 +27,8 @@ numeric revision of the operating system (for example, <literal>4.9</literal>). <literal>%%PERL_VERSION%%</literal> and <literal>%%PERL_VER%%</literal> is the full version number - of <command>perl</command> (for example, <literal>5.8.9</literal>). - Several other + of <command>perl</command> (for example, + <literal>5.8.9</literal>). Several other <literal>%%<replaceable>VARS</replaceable>%%</literal> related to port's documentation files are described in <link linkend="install-documentation">the relevant @@ -54,8 +54,8 @@ PLIST_SUB= OCTAVE_VERSION=${OCTAVE_VERSI <para>in the <filename>Makefile</filename> and use <literal>%%OCTAVE_VERSION%%</literal> wherever the version shows up in <filename>pkg-plist</filename>. When - the port is upgraded, it will not be necessary to edit dozens (or in some - cases, hundreds) of lines in + the port is upgraded, it will not be necessary to edit dozens + (or in some cases, hundreds) of lines in <filename>pkg-plist</filename>.</para> <para>If files are installed conditionally on the options @@ -113,7 +113,8 @@ OPTIONS_SUB= yes</programlisting> <para>From time to time, using <varname>OPTIONS_SUB</varname> is not enough. In those cases, adding a specific - <literal><replaceable>TAG</replaceable></literal> to <varname>PLIST_SUB</varname> + <literal><replaceable>TAG</replaceable></literal> to + <varname>PLIST_SUB</varname> inside the <filename>Makefile</filename> with a special value of <literal>@comment</literal>, makes package tools to ignore the line. For instance, if some files are only installed @@ -175,13 +176,13 @@ PLIST_SUB+= X11I386="@comment " <filename>PREFIX/etc</filename> (or elsewhere) do <emphasis>not</emphasis> list them in <filename>pkg-plist</filename>. That will cause - <command>pkg delete</command> to remove files that have been carefully - edited by the user, and a re-installation will wipe them - out.</para> + <command>pkg delete</command> to remove files that have been + carefully edited by the user, and a re-installation will wipe + them out.</para> <para>Instead, install sample files with a <filename><replaceable>filename</replaceable>.sample</filename> - extension. The <literal>@sample</literal> macro automates this, + extension. The <literal>@sample</literal> macro automates this, see <xref linkend="plist-keywords-sample"/> for what it does exactly. For each sample file, add a line to <filename>pkg-plist</filename>:</para> @@ -259,8 +260,9 @@ PLIST_SUB+= X11I386="@comment " the package list changes drastically based upon optional features of the port (and thus maintaining a static package list is infeasible), or ports which change the package list based - upon the version of dependent software used. For example, ports which - generate docs with <application>Javadoc</application>.</para> + upon the version of dependent software used. For example, ports + which generate docs with + <application>Javadoc</application>.</para> </sect1> <sect1 xml:id="plist-autoplist"> @@ -635,8 +637,8 @@ PLIST_SUB+= X11I386="@comment " <replaceable>command</replaceable> (Deprecated)</title> <para>Execute <replaceable>command</replaceable> as part of - the installation or deinstallation process. Please use <xref - linkend="plist-keywords-base-exec"/> instead.</para> + the installation or deinstallation process. Please use + <xref linkend="plist-keywords-base-exec"/> instead.</para> </sect3> <sect3 xml:id="plist-keywords-base-dirrm"> @@ -703,194 +705,189 @@ PLIST_SUB+= X11I386="@comment " </listitem> </itemizedlist> - <sect3 xml:id="plist-keywords-attributes"> - <title><literal>attributes</literal></title> + <sect3 xml:id="plist-keywords-attributes"> + <title><literal>attributes</literal></title> - <para>Changes the owner, group, or mode used by the - keyword. Contains an associative array where the - possible keys are <literal>owner</literal>, - <literal>group</literal>, and <literal>mode</literal>. - The values are, respectively, a user name, a group name, - and a file mode. For example:</para> - - <programlisting>attributes: { owner: "games", group: "games", mode: 0555 }</programlisting> - </sect3> - - <sect3 xml:id="plist-keywords-action"> - <title><literal>action</literal></title> - - <para>Defines what happens to the keyword's parameter. - Contains an array where the possible values are:</para> - - <variablelist> - <varlistentry> - <term><literal>setprefix</literal></term> - - <listitem> - <para>Set the prefix for the next plist - entries.</para> - </listitem> - </varlistentry> - - <varlistentry> - <term><literal>dir</literal></term> - - <listitem> - <para>Register a directory to be created on - install and removed on deinstall.</para> - </listitem> - </varlistentry> - - <varlistentry> - <term><literal>dirrm</literal></term> - - <listitem> - <para>Register a directory to be deleted on - deinstall. Deprecated.</para> - </listitem> - </varlistentry> - - <varlistentry> - <term><literal>dirrmtry</literal></term> - - <listitem> - <para>Register a directory to try and deleted on - deinstall. Deprecated.</para> - </listitem> - </varlistentry> - - <varlistentry> - <term><literal>file</literal></term> - - <listitem> - <para>Register a file.</para> - </listitem> - </varlistentry> - - <varlistentry> - <term><literal>setmode</literal></term> - - <listitem> - <para>Set the mode for the next plist - entries.</para> - </listitem> - </varlistentry> - - <varlistentry> - <term><literal>setowner</literal></term> - - <listitem> - <para>Set the owner for the next plist - entries.</para> - </listitem> - </varlistentry> - - <varlistentry> - <term><literal>setgroup</literal></term> - - <listitem> - <para>Set the group for the next plist - entries.</para> - </listitem> - </varlistentry> - - <varlistentry> - <term><literal>comment</literal></term> - - <listitem> - <para>Does not do anything, equivalent to not - entering an <literal>action</literal> - section.</para> - </listitem> - </varlistentry> - - <varlistentry> - <term><literal>ignore_next</literal></term> - - <listitem> - <para>Ignore the next entry in the plist.</para> - </listitem> - </varlistentry> - </variablelist> - </sect3> - - <sect3 xml:id="plist-keywords-arguments"> - <title><literal>arguments</literal></title> - - <para>If set to <literal>true</literal>, adds argument - handling, splitting the whole line, <literal>%@</literal>, - into numbered arguments, <literal>%1</literal>, - <literal>%2</literal>, and so on. For example, for this - line:</para> + <para>Changes the owner, group, or mode used by the keyword. + Contains an associative array where the possible keys are + <literal>owner</literal>, <literal>group</literal>, and + <literal>mode</literal>. The values are, respectively, a + user name, a group name, and a file mode. For + example:</para> - <programlisting>@foo some.content other.content</programlisting> + <programlisting>attributes: { owner: "games", group: "games", mode: 0555 }</programlisting> + </sect3> + + <sect3 xml:id="plist-keywords-action"> + <title><literal>action</literal></title> + + <para>Defines what happens to the keyword's parameter. + Contains an array where the possible values are:</para> + + <variablelist> + <varlistentry> + <term><literal>setprefix</literal></term> + + <listitem> + <para>Set the prefix for the next plist entries.</para> + </listitem> + </varlistentry> + + <varlistentry> + <term><literal>dir</literal></term> + + <listitem> + <para>Register a directory to be created on install and + removed on deinstall.</para> + </listitem> + </varlistentry> + + <varlistentry> + <term><literal>dirrm</literal></term> + + <listitem> + <para>Register a directory to be deleted on deinstall. + Deprecated.</para> + </listitem> + </varlistentry> + + <varlistentry> + <term><literal>dirrmtry</literal></term> + + <listitem> + <para>Register a directory to try and deleted on + deinstall. Deprecated.</para> + </listitem> + </varlistentry> + + <varlistentry> + <term><literal>file</literal></term> + + <listitem> + <para>Register a file.</para> + </listitem> + </varlistentry> + + <varlistentry> + <term><literal>setmode</literal></term> + + <listitem> + <para>Set the mode for the next plist entries.</para> + </listitem> + </varlistentry> + + <varlistentry> + <term><literal>setowner</literal></term> + + <listitem> + <para>Set the owner for the next plist entries.</para> + </listitem> + </varlistentry> - <para><literal>%1</literal> and <literal>%2</literal> - will contain:</para> + <varlistentry> + <term><literal>setgroup</literal></term> + + <listitem> + <para>Set the group for the next plist entries.</para> + </listitem> + </varlistentry> + + <varlistentry> + <term><literal>comment</literal></term> - <programlisting>some.content + <listitem> + <para>Does not do anything, equivalent to not entering + an <literal>action</literal> section.</para> + </listitem> + </varlistentry> + + <varlistentry> + <term><literal>ignore_next</literal></term> + + <listitem> + <para>Ignore the next entry in the plist.</para> + </listitem> + </varlistentry> + </variablelist> + </sect3> + + <sect3 xml:id="plist-keywords-arguments"> + <title><literal>arguments</literal></title> + + <para>If set to <literal>true</literal>, adds argument + handling, splitting the whole line, <literal>%@</literal>, + into numbered arguments, <literal>%1</literal>, + <literal>%2</literal>, and so on. For example, for this + line:</para> + + <programlisting>@foo some.content other.content</programlisting> + + <para><literal>%1</literal> and <literal>%2</literal> will + contain:</para> + + <programlisting>some.content other.content</programlisting> - <para>It also affects how the <link - linkend="plist-keywords-action"><literal>action</literal></link> - entry works. When there is more than one argument, the - argument number must be specified. For example:</para> - - <programlisting>actions: [file(1)]</programlisting> - </sect3> - - <sect3 xml:id="plist-keywords-pre-post"> - <title><literal>pre-install</literal>, - <literal>post-install</literal>, - <literal>pre-deinstall</literal>, - <literal>post-deinstall</literal>, - <literal>pre-upgrade</literal>, - <literal>post-upgrade</literal></title> - - <para>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 - <literal>@exec</literal> - <literal>%<replaceable>foo</replaceable></literal> - placeholders described in <xref - linkend="plist-keywords-base-exec"/>, there is a new - one, <literal>%@</literal>, which represents the - argument of the keyword.</para> - </sect3> + <para>It also affects how the <link + linkend="plist-keywords-action"><literal>action</literal></link> + entry works. When there is more than one argument, the + argument number must be specified. For example:</para> + + <programlisting>actions: [file(1)]</programlisting> + </sect3> + + <sect3 xml:id="plist-keywords-pre-post"> + <title><literal>pre-install</literal>, + <literal>post-install</literal>, + <literal>pre-deinstall</literal>, + <literal>post-deinstall</literal>, + <literal>pre-upgrade</literal>, + <literal>post-upgrade</literal></title> + + <para>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 + <literal>@exec</literal> + <literal>%<replaceable>foo</replaceable></literal> + placeholders described in <xref + linkend="plist-keywords-base-exec"/>, there is a new one, + <literal>%@</literal>, which represents the argument of the + keyword.</para> + </sect3> <sect3 xml:id="plist-keywords-examples"> <title>Custom Keyword Examples</title> - <example xml:id="plist-keywords-fc-example"> - <title>Example of a <literal>@dirrmtryecho</literal> - Keyword</title> - - <para>This keyword does two things, it adds a - <literal>@dirrmtry - <replaceable>directory</replaceable></literal> line to the - packing list, and echoes the fact that the directory is - removed when deinstalling the package.</para> + <example xml:id="plist-keywords-fc-example"> + <title>Example of a <literal>@dirrmtryecho</literal> + Keyword</title> + + <para>This keyword does two things, it adds a + <literal>@dirrmtry + <replaceable>directory</replaceable></literal> line to + the packing list, and echoes the fact that the directory + is removed when deinstalling the package.</para> - <programlisting>actions: [dirrmtry] + <programlisting>actions: [dirrmtry] post-deinstall: <<EOD echo "Directory %D/%@ removed." EOD</programlisting> - </example> + </example> - <example xml:id="plist-keywords-sample-example"> - <title>Real Life Example, How <literal>@sample</literal> - is Implemented</title> - - <para>This keyword does three things. It adds the first - <replaceable>filename</replaceable> passed as an argument to - <literal>@sample</literal> to the packing list, it adds to - the <literal>post-install</literal> script instructions to - copy the sample to the actual configuration file if it does - not already exist, and it adds to the - <literal>post-deinstall</literal> instructions to remove the - configuration file if it has not been modified.</para> + <example xml:id="plist-keywords-sample-example"> + <title>Real Life Example, How <literal>@sample</literal> is + Implemented</title> + + <para>This keyword does three things. It adds the first + <replaceable>filename</replaceable> passed as an argument + to <literal>@sample</literal> to the packing list, it adds + to the <literal>post-install</literal> script instructions + to copy the sample to the actual configuration file if it + does not already exist, and it adds to the + <literal>post-deinstall</literal> instructions to remove + the configuration file if it has not been modified.</para> - <programlisting>actions: [file(1)] + <programlisting>actions: [file(1)] arguments: true post-install: <<EOD case "%1" in @@ -932,7 +929,7 @@ pre-deinstall: <<EOD echo "You may need to manually remove ${target_file} if it is no longer needed." fi EOD</programlisting> - </example> + </example> </sect3> </sect2> </sect1>
Want to link to this message? Use this URL: <https://mail-archive.FreeBSD.org/cgi/mid.cgi?201510011434.t91EYWNR026777>