pkgfmt.1 revision 3356
3139N/A<?xml version="1.0" encoding="iso-8859-1"?>
3139N/A<!--Arbortext, Inc., 1988-2008, v.4002-->
3139N/A<!DOCTYPE refentry PUBLIC "-//Sun Microsystems//DTD SolBook-XML 3.7//EN" "xsolbook.dtd" [
3139N/A<!ENTITY % ent SYSTEM "entities.ent">
3139N/A%ent;
3139N/A]>
2494N/A
3139N/A<refentry id="pkgfmt-1">
3139N/A<refmeta><refentrytitle>pkgfmt</refentrytitle><manvolnum>1</manvolnum>
3139N/A<refmiscinfo class="date">21 May 2013</refmiscinfo>
3139N/A<refmiscinfo class="sectdesc">&man1;</refmiscinfo>
3139N/A<refmiscinfo class="software">&release;</refmiscinfo>
3139N/A<refmiscinfo class="arch">generic</refmiscinfo>
3356N/A<refmiscinfo class="copyright">Copyright (c) 2007, 2016, Oracle and/or its affiliates. All rights reserved.</refmiscinfo>
3139N/A</refmeta>
3139N/A<refnamediv>
3139N/A<refname>pkgfmt</refname><refpurpose>format a package manifest</refpurpose>
3139N/A</refnamediv>
3139N/A<refsynopsisdiv><title></title>
3139N/A<synopsis>/usr/bin/pkgfmt [-c|-d|-u] [<replaceable>package-manifest-file</replaceable>]
3139N/A</synopsis>
3139N/A</refsynopsisdiv>
3139N/A<refsect1 id="pkgfmt-1-desc" role="description"><title></title>
3139N/A<para><command>pkgfmt</command> without the <option>c</option> or <option>d</option> options
3139N/Aformats a package manifest in a consistent manner, including wrapping lines
3139N/Aat 80 characters, sorting actions by type, and sorting attributes. Lines that
3139N/Ado not parse into actions (such as macros, comments, or transforms) do not
3139N/Aappear in sorted order.</para>
3139N/A<para>If no arguments are given, <command>pkgfmt</command> reads <literal>stdin</literal> until
3139N/AEOF, and then writes the formatted manifest to <literal>stdout</literal>.
3139N/AAny manifests specified on the command line are formatted in place.</para>
3139N/A<para><command>pkgfmt</command> with the <option>c</option> option checks
3139N/Awhether the manifests are formatted in <command>pkgfmt</command> style. The <option>
3139N/Ad</option> option displays the differences if the file is not properly formatted.
3139N/A</para>
3139N/A</refsect1>
3139N/A<refsect1 role="options"><title></title>
3139N/A<para>The following options are supported:</para>
3139N/A<variablelist>
3139N/A<varlistentry><term><option>?</option></term><term><option>-help</option></term>
3139N/A<listitem><para>Display a usage message.</para>
3139N/A</listitem>
3139N/A</varlistentry>
3139N/A<varlistentry><term><option>c</option></term>
3139N/A<listitem><para>Check whether the manifest is formatted in the <command>pkgfmt</command> style.
3139N/A</para>
3139N/A</listitem>
3139N/A</varlistentry>
3139N/A<varlistentry><term><option>d</option></term>
3139N/A<listitem><para>Display manifest differences from the formatted version in
3139N/Aunified form.</para>
3139N/A</listitem>
3139N/A</varlistentry>
3139N/A<varlistentry><term><option>u</option></term>
3139N/A<listitem><para>Do not wrap lines at 80 characters. This option is useful
3139N/Afor applying traditional text processing tools to package manifests.</para>
3139N/A</listitem>
3139N/A</varlistentry>
3139N/A</variablelist>
3139N/A</refsect1>
3139N/A<refsect1 role="exit-status"><title></title>
3139N/A<para>The following exit values are returned:</para>
3139N/A<variablelist>
3139N/A<varlistentry><term><returnvalue>0</returnvalue></term>
3139N/A<listitem><para>Command succeeded.</para>
3139N/A</listitem>
3139N/A</varlistentry>
3139N/A<varlistentry><term><returnvalue>1</returnvalue></term>
3139N/A<listitem><para>The <option>c</option> or <option>d</option> options were
3139N/Aspecified, and one or more manifests are not in <command>pkgfmt</command> normal
3139N/Aform, or an error occurred.</para>
3139N/A</listitem>
3139N/A</varlistentry>
3139N/A<varlistentry><term><returnvalue>2</returnvalue></term>
3139N/A<listitem><para>Invalid command line options were specified.</para>
3139N/A</listitem>
3139N/A</varlistentry>
3139N/A<varlistentry><term><returnvalue>99</returnvalue></term>
3139N/A<listitem><para>An unanticipated exception occurred.</para>
3139N/A</listitem>
3139N/A</varlistentry>
3139N/A</variablelist>
3139N/A</refsect1>
3139N/A<refsect1 role="attributes"><title></title>
3356N/A<para>See <literal>attributes</literal>(7) for descriptions of the following
3139N/Aattributes:</para>
3139N/A<informaltable frame="all" orient="port">
3139N/A<tgroup cols="2" colsep="1" rowsep="1"><colspec colname="col1" colwidth="198*"
3139N/Aalign="left"/><colspec colname="col2" colwidth="198*" align="left"/><thead>
3139N/A<row>
3139N/A<entry align="center">
3139N/A<para>ATTRIBUTE TYPE</para>
3139N/A</entry>
3139N/A<entry align="center">
3139N/A<para>ATTRIBUTE VALUE</para>
3139N/A</entry>
3139N/A</row>
3139N/A</thead>
3139N/A<tbody>
3139N/A<row>
3139N/A<entry align="left">
3139N/A<para>Availability</para>
3139N/A</entry>
3139N/A<entry align="left">
3139N/A<para><literal>package/pkg</literal></para>
3139N/A</entry>
3139N/A</row>
3139N/A<row>
3139N/A<entry align="left">
3139N/A<para>Interface Stability</para>
3139N/A</entry>
3139N/A<entry align="left">
3139N/A<para>Uncommitted</para>
3139N/A</entry>
3139N/A</row>
3139N/A</tbody>
3139N/A</tgroup>
3139N/A</informaltable></refsect1>
3139N/A<refsect1 role="see-also"><title></title>
3356N/A<para><olink targetdoc="refman" targetptr="pkg-7"><citerefentry><refentrytitle>pkg</refentrytitle><manvolnum>7</manvolnum></citerefentry></olink></para>
3139N/A<para><literal>https://java.net/projects/ips/pages/Home</literal></para>
3139N/A</refsect1>
3139N/A</refentry>
2494N/A