summaryrefslogtreecommitdiff
path: root/opcodes/pwd.xml
diff options
context:
space:
mode:
Diffstat (limited to 'opcodes/pwd.xml')
-rw-r--r--opcodes/pwd.xml65
1 files changed, 65 insertions, 0 deletions
diff --git a/opcodes/pwd.xml b/opcodes/pwd.xml
new file mode 100644
index 0000000..a7a5280
--- /dev/null
+++ b/opcodes/pwd.xml
@@ -0,0 +1,65 @@
+
+<refentry id="pwd">
+
+<indexterm id="Indexpwd"><primary>pwd</primary></indexterm>
+ <refentryinfo><title>Miscellaneous</title></refentryinfo>
+ <refmeta>
+ <refentrytitle>pwd</refentrytitle>
+ </refmeta>
+
+
+
+ <refnamediv>
+ <refname>pwd</refname>
+ <refpurpose>
+ Asks the underlying operating system for the current directory
+ name as a string.
+ </refpurpose>
+ </refnamediv>
+
+ <refsect1>
+ <title>Description</title>
+ <para>
+ <command>pwd</command> call the operating system to determine
+ the current directory (folder). <command>pwd</command> runs
+ at i-time only.
+ </para>
+ </refsect1>
+
+ <refsect1>
+ <title>Syntax</title>
+ <synopsis>Sres <command>pwd</command></synopsis>
+ </refsect1>
+
+ <refsect1>
+ <title>Performance</title>
+ <para>
+ <emphasis>Sres</emphasis> -- the returned string.
+ </para>
+ </refsect1>
+
+ <refsect1>
+ <title>Example</title>
+ <para>
+ Here is an example of the pwd opcode. It uses the file <ulink url="examples/pwd.csd"><citetitle>pwd.csd</citetitle></ulink>.
+
+ <example>
+ <title>Example of the pwd opcode.</title>
+
+ <para>See the sections <link linkend="UsingRealTime"><citetitle>Real-time Audio</citetitle></link> and <link linkend="CommandFlags"><citetitle>Command Line Flags</citetitle></link> for more information on using command line flags.</para>
+ <xi:include href="examples-xml/pwd.csd.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
+ </example>
+ </para>
+ </refsect1>
+
+ <refsect1>
+ <title>Credits</title>
+ <para>
+ <simplelist>
+ <member>Author: &namejohn;</member>
+ <member>July 2012</member>
+ </simplelist>
+ <para>New in version 5.18</para>
+ </para>
+ </refsect1>
+</refentry>