<?xml version="1.0" encoding="utf-8" ?> <!-- for emacs: -*- coding: utf-8 -*- --> <!-- Apache may like this line in the file .htaccess: AddCharset utf-8 .html --> <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1 plus MathML 2.0 plus SVG 1.1//EN" "http://www.w3.org/2002/04/xhtml-math-svg/xhtml-math-svg-flat.dtd" > <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en"> <head><title>File -- the class of all files</title> <link rel="stylesheet" type="text/css" href="../../../../Macaulay2/Style/doc.css"/> </head> <body> <table class="buttons"> <tr> <td><div><a href="___File_sp_lt_lt_sp__Thing.html">next</a> | <a href="___Fano_lp__Z__Z_cm__Ideal_cm__Ring_rp.html">previous</a> | <a href="___File_sp_lt_lt_sp__Thing.html">forward</a> | <a href="___Fano_lp__Z__Z_cm__Ideal_cm__Ring_rp.html">backward</a> | up | <a href="index.html">top</a> | <a href="master.html">index</a> | <a href="toc.html">toc</a> | <a href="http://www.math.uiuc.edu/Macaulay2/">Macaulay2 web site</a></div> </td> </tr> </table> <hr/> <div><h1>File -- the class of all files</h1> <div class="single"><h2>Description</h2> <div>Files may be input files, output files, pipes, or sockets. A list of currently open files may be obtained with <a href="_open__Files.html" title="list the open files">openFiles</a>.<div class="waystouse"><h2>Functions operating on path names:</h2> <ul><li><span><a href="_minimize__Filename.html" title="minimize a file name">minimizeFilename</a> -- minimize a file name</span></li> <li><span><a href="_path.html" title="list of directories to look in">path</a> -- list of directories to look in</span></li> <li><span><a href="_relativize__Filename.html" title="relativize a file name">relativizeFilename</a> -- relativize a file name</span></li> <li><span><a href="_search__Path_lp__List_cm__String_rp.html" title="search a path for a file">searchPath</a> -- search a path for a file</span></li> <li><span><a href="_temporary__File__Name.html" title="make a temporary file name">temporaryFileName</a> -- make a temporary file name</span></li> <li><span><a href="_to__Absolute__Path.html" title="the absolute path version of a file name">toAbsolutePath</a> -- the absolute path version of a file name</span></li> </ul> </div> </div> </div> <div class="waystouse"><h2>Functions and methods returning a file :</h2> <ul><li><span>File << Manipulator, see <span><a href="___File_sp_lt_lt_sp__Thing.html" title="print to a file">File << Thing</a> -- print to a file</span></span></li> <li><span>File << Symbol, see <span><a href="___File_sp_lt_lt_sp__Thing.html" title="print to a file">File << Thing</a> -- print to a file</span></span></li> <li><span><a href="___File_sp_lt_lt_sp__Thing.html" title="print to a file">File << Thing</a> -- print to a file</span></li> <li><span>String << Thing, see <span><a href="___File_sp_lt_lt_sp__Thing.html" title="print to a file">File << Thing</a> -- print to a file</span></span></li> <li><span>NetFile << Manipulator, see <span><a href="___Net__File.html" title="the class of all net files">NetFile</a> -- the class of all net files</span></span></li> <li><span><a href="_open__In_lp__String_rp.html" title="open an output file">openIn(String)</a> -- open an output file</span></li> <li><span>openInOut(File), see <span><a href="_open__In__Out.html" title="open an input output file">openInOut</a> -- open an input output file</span></span></li> <li><span>openInOut(String), see <span><a href="_open__In__Out.html" title="open an input output file">openInOut</a> -- open an input output file</span></span></li> <li><span><a href="_open__Listener_lp__String_rp.html" title="open a port for listening">openListener(String)</a> -- open a port for listening</span></li> <li><span><a href="_open__Out_lp__String_rp.html" title="open an output file">openOut(String)</a> -- open an output file</span></li> <li><span><a href="_open__Out__Append_lp__String_rp.html" title="open an output file for appending">openOutAppend(String)</a> -- open an output file for appending</span></li> </ul> <h2>Methods that use a file :</h2> <ul><li><span><a href="_at__End__Of__File_lp__File_rp.html" title="test for end of file">atEndOfFile(File)</a> -- test for end of file</span></li> <li><span>echoOff(File), see <span><a href="_echo__Off.html" title="turn off echoing">echoOff</a> -- turn off echoing</span></span></li> <li><span>echoOn(File), see <span><a href="_echo__On.html" title="turn on echoing">echoOn</a> -- turn on echoing</span></span></li> <li><span>File << Net, see <span><a href="___File_sp_lt_lt_sp__Thing.html" title="print to a file">File << Thing</a> -- print to a file</span></span></li> <li><span>File << String, see <span><a href="___File_sp_lt_lt_sp__Thing.html" title="print to a file">File << Thing</a> -- print to a file</span></span></li> <li><span><a href="_file__Mode_lp__File_rp.html" title="get file mode">fileMode(File)</a> -- get file mode</span></li> <li><span><a href="_file__Mode_lp__Z__Z_cm__File_rp.html" title="set file mode">fileMode(ZZ,File)</a> -- set file mode</span></li> <li><span>get(File), see <span><a href="_get.html" title="get the contents of a file">get</a> -- get the contents of a file</span></span></li> <li><span>getc(File), see <span><a href="_getc.html" title="get a byte">getc</a> -- get a byte</span></span></li> <li><span><a href="_height_lp__File_rp.html" title="get window height">height(File)</a> -- get window height</span></li> <li><span><a href="_is__Input__File_lp__File_rp.html" title="whether a file is open for input">isInputFile(File)</a> -- whether a file is open for input</span></li> <li><span><a href="_is__Listener_lp__File_rp.html" title="whether a file is open for listening">isListener(File)</a> -- whether a file is open for listening</span></li> <li><span>isOpen(File), see <span><a href="_is__Open.html" title="whether a file or database is open">isOpen</a> -- whether a file or database is open</span></span></li> <li><span><a href="_is__Output__File_lp__File_rp.html" title="whether a file is open for output">isOutputFile(File)</a> -- whether a file is open for output</span></li> <li><span><a href="_is__Ready_lp__File_rp.html" title="whether a file has data available for reading">isReady(File)</a> -- whether a file has data available for reading</span></li> <li><span>kill(File), see <span><a href="_kill.html" title="kill a process">kill</a> -- kill a process</span></span></li> <li><span>Manipulator File, see <span><a href="___Manipulator.html" title="the class of all file manipulators">Manipulator</a> -- the class of all file manipulators</span></span></li> <li><span><a href="_read_lp__File_rp.html" title="read from a file">read(File)</a> -- read from a file</span></li> <li><span><a href="_read_lp__File_cm__Z__Z_rp.html" title="read from a file">read(File,ZZ)</a> -- read from a file</span></li> <li><span><a href="_width_lp__File_rp.html" title="get window width">width(File)</a> -- get window width</span></li> </ul> <h2>Fixed objects of class File :</h2> <ul><li><span><a href="_stderr.html" title="the standard error output file">stderr</a> -- the standard error output file</span></li> <li><span><a href="_stdio.html" title="the standard input output file">stdio</a> -- the standard input output file</span></li> </ul> </div> <div class="waystouse"><h2>For the programmer</h2> <p>The object <a href="___File.html" title="the class of all files">File</a> is <span>a <a href="___Type.html">type</a></span>, with ancestor class <a href="___Thing.html" title="the class of all things">Thing</a>.</p> </div> </div> </body> </html>