<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.12 $ -->
<!-- splitted from ./en/functions/info.xml, last change in rev 1.7 -->
<refentry id="function.php-uname">
 <refnamediv>
  <refname>php_uname</refname>
  <refpurpose>Returns information about the operating system PHP is running on</refpurpose>
 </refnamediv>
 <refsect1>
  <title>Description</title>
  <methodsynopsis>
   <type>string</type><methodname>php_uname</methodname>
   <methodparam choice="opt"><type>string</type><parameter>mode</parameter></methodparam>
  </methodsynopsis>
  <para>
   <function>php_uname</function> returns a description of the operating
   system PHP is running on. For the name of just the operating system,
   consider using the <constant>PHP_OS</constant> constant, but be
   reminded this constant will contain the operating system PHP was
   <emphasis>built</emphasis> on.
  </para>
  <para>
   On Unix, the output reverts to displaying the operating system
   information PHP was built on if it cannot determine the currently
   running OS.
  </para>
  <para>
   <parameter>mode</parameter> is a single character that defines what
   information is returned:
   <itemizedlist>
    <listitem>
     <simpara>
      <literal>'a'</literal>: This is the default. Contains all modes in the sequence <literal>"s n r v m"</literal>.
     </simpara>
    </listitem>
    <listitem>
     <simpara>
      <literal>'s'</literal>: Operating system name. eg. <literal>FreeBSD</literal>.
     </simpara>
    </listitem>
    <listitem>
     <simpara>
      <literal>'n'</literal>: Host name. eg. <literal>localhost.example.com</literal>.
     </simpara>
    </listitem>
    <listitem>
     <simpara>
      <literal>'r'</literal>: Release name. eg. <literal>5.1.2-RELEASE</literal>.
     </simpara>
    </listitem>
    <listitem>
     <simpara>
      <literal>'v'</literal>: Version information. Varies a lot between operating systems.
     </simpara>
    </listitem>
    <listitem>
     <simpara>
      <literal>'m'</literal>: Machine type. eg. <literal>i386</literal>.
     </simpara>
    </listitem>
   </itemizedlist>
  </para>
  <para>
   <example>
    <title>Some <function>php_uname</function> examples</title>
    <programlisting role="php">
<![CDATA[
<?php
echo php_uname();
echo PHP_OS;

/* Some possible outputs:
Linux localhost 2.4.21-0.13mdk #1 Fri Mar 14 15:08:06 EST 2003 i686
Linux

FreeBSD localhost 3.2-RELEASE #15: Mon Dec 17 08:46:02 GMT 2001
FreeBSD

Windows NT XN1 5.1 build 2600
WINNT
*/

if (strtoupper(substr(PHP_OS, 0, 3)) === 'WIN') {
    echo 'This is a server using Windows!';
} else {
    echo 'This is a server not using Windows!';
}

?>
]]>
    </programlisting>
   </example>
  </para>
  <para>
   There are also some related
   <link linkend="language.constants.predefined">Predefined PHP
   constants</link> that may come in handy, for example:
  </para>
  <para>
   <example>
    <title>A few OS related constant examples</title>
    <programlisting role="php">
<![CDATA[
<?php
// *nix
echo DIRECTORY_SEPARATOR; // /
echo PHP_SHLIB_SUFFIX;    // so
echo PATH_SEPARATOR;      // :

// Win*
echo DIRECTORY_SEPARATOR; // \
echo PHP_SHLIB_SUFFIX;    // dll
echo PATH_SEPARATOR;      // ;
?>
]]>
    </programlisting>
   </example>
  </para>
  <para>
   See also <function>phpversion</function>,
   <function>php_sapi_name</function>, and
   <function>phpinfo</function>.
  </para>
 </refsect1>
</refentry>

<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"../../../../manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->