xref: /third_party/selinux/secilc/secil2tree.8.xml

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML//EN"
               "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">

<refentry>
   <refentryinfo>
      <author>
         <firstname>James</firstname><surname>Carter</surname><contrib></contrib>
      </author>
   </refentryinfo>

   <refmeta>
      <refentrytitle>SECIL2TREE</refentrytitle>
      <manvolnum>8</manvolnum>
      <refmiscinfo class="date">05 April 2021</refmiscinfo>
      <refmiscinfo class="source">secil2tree</refmiscinfo>
      <refmiscinfo class="manual">SELinux CIL AST Writer</refmiscinfo>
   </refmeta>
   <refnamediv id="name">
      <refname>secil2tree</refname>
      <refpurpose>invoke the SELinux Common Intermediate Language (CIL) AST Writer </refpurpose>
   </refnamediv>

   <refsynopsisdiv id="synopsis">
      <cmdsynopsis>
        <command>secil2tree</command>
          <arg choice="opt" rep="repeat"><replaceable>OPTION</replaceable></arg>
          <arg choice="plain"><replaceable>file</replaceable></arg>
      </cmdsynopsis>
   </refsynopsisdiv>

   <refsect1 id="description"><title>DESCRIPTION</title>
      <para><emphasis role="italic">secil2tree</emphasis> invokes the CIL AST Writer with the specified <emphasis role="italic">argument</emphasis>s.</para>
   </refsect1>

   <refsect1 id="options"><title>OPTIONS</title>
      <variablelist>
         <varlistentry>
            <term><option>-o, --output=&lt;file></option></term>
            <listitem><para>Write AST to <emphasis role="italic">file</emphasis> (default: stdout)</para></listitem>
         </varlistentry>

         <varlistentry>
            <term><option>-P, --preserve-tunables</option></term>
            <listitem><para>Treat tunables as booleans.</para></listitem>
         </varlistentry>

         <varlistentry>
            <term><option>-Q, --qualified-names</option></term>
            <listitem><para>Allow names containing dots (qualified names). Blocks, blockinherits, blockabstracts, and in-statements will not be allowed.</para></listitem>
         </varlistentry>

         <varlistentry>
            <term><option>-A, --ast-phase=&lt;phase></option></term>
            <listitem><para>Write AST of phase <emphasis role="italic">phase</emphasis>. Must be <emphasis role="bold">parse</emphasis>, <emphasis role="bold">build</emphasis>, or <emphasis role="bold">resolve</emphasis>. (default: <emphasis role="bold">resolve</emphasis>)</para></listitem>
         </varlistentry>

         <varlistentry>
            <term><option>-v, --verbose</option></term>
            <listitem><para>Increment verbosity level.</para></listitem>
         </varlistentry>

         <varlistentry>
            <term><option>-h, --help</option></term>
            <listitem><para>Display usage information.</para></listitem>
         </varlistentry>
      </variablelist>
   </refsect1>

   <refsect1 id="see_also"><title>SEE ALSO</title>
      <para>
      <simplelist type="inline">
         <member><citerefentry>
            <refentrytitle>secilc</refentrytitle>
            <manvolnum>8</manvolnum>
         </citerefentry></member>
         <member><citerefentry>
            <refentrytitle>secil2conf</refentrytitle>
            <manvolnum>8</manvolnum>
         </citerefentry></member>
      </simplelist>
      </para>
      <para>HTML documentation describing the CIL language statements is available starting with <emphasis role="italic">docs/html/index.html</emphasis>.</para>
      <para>PDF documentation describing the CIL language statements is available at: <emphasis role="italic">docs/pdf/CIL_Reference_Guide.pdf</emphasis>.</para>
   </refsect1>
</refentry>