Home • Explore • Blog • CI
☰



postgresql
7th chunk of `doc/src/sgml/ref/pg_ctl-ref.sgml`
152d0ce6bd9d7e2795f3d943e6564d3de6df50ecd7a517f10000000100000f29
 <varlistentry>
      <term><option>-W</option></term>
      <term><option>--no-wait</option></term>
      <listitem>
       <para>
        Do not wait for the operation to complete.  This is the opposite of
        the option <option>-w</option>.
       </para>

       <para>
        If waiting is disabled, the requested action is triggered, but there
        is no feedback about its success.  In that case, the server log file
        or an external monitoring system would have to be used to check the
        progress and success of the operation.
       </para>

       <para>
        In prior releases of PostgreSQL, this was the default except for
        the <literal>stop</literal> mode.
       </para>
      </listitem>
     </varlistentry>

     <varlistentry>
      <term><option>-?</option></term>
      <term><option>--help</option></term>
      <listitem>
       <para>
        Show help about <application>pg_ctl</application> command line
        arguments, and exit.
       </para>
      </listitem>
     </varlistentry>
   </variablelist>

  <para>
   If an option is specified that is valid, but not relevant to the selected
   operating mode, <application>pg_ctl</application> ignores it.
  </para>

  <refsect2 id="app-pg-ctl-windows-options">
   <title>Options for Windows</title>

   <variablelist>
    <varlistentry>
     <term><option>-e <replaceable class="parameter">source</replaceable></option></term>
     <listitem>
      <para>
       Name of the event source for <application>pg_ctl</application> to use
       for logging to the event log when running as a Windows service.  The
       default is <literal>PostgreSQL</literal>.  Note that this only controls
       messages sent from <application>pg_ctl</application> itself; once
       started, the server will use the event source specified
       by its <xref linkend="guc-event-source"/> parameter.  Should the server
       fail very early in startup, before that parameter has been set,
       it might also log using the default event
       source name <literal>PostgreSQL</literal>.
      </para>
     </listitem>
    </varlistentry>

    <varlistentry>
     <term><option>-N <replaceable class="parameter">servicename</replaceable></option></term>
     <listitem>
      <para>
       Name of the system service to register. This name will be used
       as both the service name and the display name.
       The default is <literal>PostgreSQL</literal>.
      </para>
     </listitem>
    </varlistentry>

    <varlistentry>
     <term><option>-P <replaceable class="parameter">password</replaceable></option></term>
     <listitem>
      <para>
       Password for the user to run the service as.
      </para>
     </listitem>
    </varlistentry>

    <varlistentry>
     <term><option>-S <replaceable class="parameter">start-type</replaceable></option></term>
     <listitem>
      <para>
       Start type of the system service.  <replaceable>start-type</replaceable> can
       be <literal>auto</literal>, or <literal>demand</literal>, or
       the first letter of one of these two. If this option is omitted,
       <literal>auto</literal> is the default.
      </para>
     </listitem>
    </varlistentry>

    <varlistentry>
     <term><option>-U <replaceable class="parameter">username</replaceable></option></term>
     <listitem>
      <para>
       User name for the user to run the service as. For domain users, use the
       format <literal>DOMAIN\username</literal>.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </refsect2>

 </refsect1>


 <refsect1>
  <title>Environment</title>

  <variablelist>
   <varlistentry>
    <term><envar>PGCTLTIMEOUT</envar></term>

    <listitem>
     <para>
      Default limit on the number of seconds to wait when waiting for startup
      or shutdown to complete.  If not set, the default is 60 seconds.
Title: pg_ctl Options: No-Wait, Help, and Windows-Specific Options
Summary
This section covers the remaining general `pg_ctl` options, including `-W` to disable waiting for operations, and `-?` to display help. It also details the options specific to Windows, such as `-e` for setting the event source, `-N` for naming the service, `-P` for the user password, `-S` for the service start type, and `-U` for the username to run the service as.