Blame doc/modules/posix.fcntl.html

Packit 437b5e
Packit 437b5e
   "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
Packit 437b5e
<html>
Packit 437b5e
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
Packit 437b5e
<head>
Packit 437b5e
    <title>luaposix 33.3.0 Reference</title>
Packit 437b5e
    <link rel="stylesheet" href="../ldoc.css" type="text/css" />
Packit 437b5e
</head>
Packit 437b5e
<body>
Packit 437b5e
Packit 437b5e
Packit 437b5e
Packit 437b5e
Packit 437b5e
	
Packit 437b5e
	
<big></big>
Packit 437b5e
	
Packit 437b5e
 
Packit 437b5e
Packit 437b5e
Packit 437b5e
Packit 437b5e
Packit 437b5e
Packit 437b5e
Packit 437b5e
Packit 437b5e
Packit 437b5e

Packit 437b5e

luaposix 33.3.0

Packit 437b5e
Packit 437b5e
    Packit 437b5e
      
  • Index
  • Packit 437b5e
    Packit 437b5e
    Packit 437b5e

    Contents

    Packit 437b5e
      Packit 437b5e
    • Functions
    • Packit 437b5e
    • Constants
    • Packit 437b5e
    • Tables
    • Packit 437b5e
      Packit 437b5e
      Packit 437b5e
      Packit 437b5e

      Modules

      Packit 437b5e
        Packit 437b5e
          
      • posix
      • Packit 437b5e
          
      • posix.ctype
      • Packit 437b5e
          
      • posix.curses
      • Packit 437b5e
          
      • posix.dirent
      • Packit 437b5e
          
      • posix.errno
      • Packit 437b5e
          
      • posix.fcntl
      • Packit 437b5e
          
      • posix.fnmatch
      • Packit 437b5e
          
      • posix.getopt
      • Packit 437b5e
          
      • posix.glob
      • Packit 437b5e
          
      • posix.grp
      • Packit 437b5e
          
      • posix.libgen
      • Packit 437b5e
          
      • posix.poll
      • Packit 437b5e
          
      • posix.pwd
      • Packit 437b5e
          
      • posix.sched
      • Packit 437b5e
          
      • posix.signal
      • Packit 437b5e
          
      • posix.stdio
      • Packit 437b5e
          
      • posix.stdlib
      • Packit 437b5e
          
      • posix.sys.msg
      • Packit 437b5e
          
      • posix.sys.resource
      • Packit 437b5e
          
      • posix.sys.socket
      • Packit 437b5e
          
      • posix.sys.stat
      • Packit 437b5e
          
      • posix.sys.statvfs
      • Packit 437b5e
          
      • posix.sys.time
      • Packit 437b5e
          
      • posix.sys.times
      • Packit 437b5e
          
      • posix.sys.utsname
      • Packit 437b5e
          
      • posix.sys.wait
      • Packit 437b5e
          
      • posix.syslog
      • Packit 437b5e
          
      • posix.termio
      • Packit 437b5e
          
      • posix.time
      • Packit 437b5e
          
      • posix.unistd
      • Packit 437b5e
          
      • posix.utime
      • Packit 437b5e
        Packit 437b5e

        Classes

        Packit 437b5e
          Packit 437b5e
            
        • posix.curses.chstr
        • Packit 437b5e
            
        • posix.curses.window
        • Packit 437b5e
          Packit 437b5e

          Examples

          Packit 437b5e
            Packit 437b5e
              
          • curses.lua
          • Packit 437b5e
              
          • dir.lua
          • Packit 437b5e
              
          • fork.lua
          • Packit 437b5e
              
          • fork2.lua
          • Packit 437b5e
              
          • getopt.lua
          • Packit 437b5e
              
          • glob.lua
          • Packit 437b5e
              
          • limit.lua
          • Packit 437b5e
              
          • lock.lua
          • Packit 437b5e
              
          • netlink-uevent.lua
          • Packit 437b5e
              
          • ping.lua
          • Packit 437b5e
              
          • poll.lua
          • Packit 437b5e
              
          • rt_sched.lua
          • Packit 437b5e
              
          • signal.lua
          • Packit 437b5e
              
          • socket.lua
          • Packit 437b5e
              
          • termios.lua
          • Packit 437b5e
              
          • tree.lua
          • Packit 437b5e
            Packit 437b5e
            Packit 437b5e
            Packit 437b5e
            Packit 437b5e
            Packit 437b5e
            Packit 437b5e

            Module posix.fcntl

            Packit 437b5e

            File Control.

            Packit 437b5e

            Low-level control over file descriptors, including creating new file

            Packit 437b5e
             descriptors with open.

            Packit 437b5e
            Packit 437b5e
            Packit 437b5e

            Functions

            Packit 437b5e
            Packit 437b5e
            	
            Packit 437b5e
            	fcntl (fd, cmd[, arg=0])
            Packit 437b5e
            	Manipulate file descriptor.
            Packit 437b5e
            	
            Packit 437b5e
            	
            Packit 437b5e
            	open (path, oflags[, mode=511])
            Packit 437b5e
            	Open a file.
            Packit 437b5e
            	
            Packit 437b5e
            	
            Packit 437b5e
            	posix_fadvise (fd, offset, len, advice)
            Packit 437b5e
            	Instruct kernel on appropriate cache behaviour for a file or file segment.
            Packit 437b5e
            	
            Packit 437b5e
            Packit 437b5e

            Constants

            Packit 437b5e
            Packit 437b5e
            	
            Packit 437b5e
            	posix.fcntl
            Packit 437b5e
            	Fcntl constants.
            Packit 437b5e
            	
            Packit 437b5e
            Packit 437b5e

            Tables

            Packit 437b5e
            Packit 437b5e
            	
            Packit 437b5e
            	flock
            Packit 437b5e
            	Advisory file locks.
            Packit 437b5e
            	
            Packit 437b5e
            Packit 437b5e
            Packit 437b5e

            Packit 437b5e

            Packit 437b5e
            Packit 437b5e
            Packit 437b5e
                

            Functions

            Packit 437b5e
            Packit 437b5e
                
            Packit 437b5e
                
            Packit 437b5e
                
            Packit 437b5e
                fcntl (fd, cmd[, arg=0])
            Packit 437b5e
                
            Packit 437b5e
                
            Packit 437b5e
                Manipulate file descriptor.
            Packit 437b5e
            Packit 437b5e
            Packit 437b5e
                

            Parameters:

            Packit 437b5e
                
              Packit 437b5e
                      
            • fd
            • Packit 437b5e
                          int
              Packit 437b5e
                       file descriptor to act on
              Packit 437b5e
                      
              Packit 437b5e
                      
            • cmd
            • Packit 437b5e
                          int
              Packit 437b5e
                       operation to perform
              Packit 437b5e
                      
              Packit 437b5e
                      
            • arg
            • Packit 437b5e
                          int or flock
              Packit 437b5e
                       when cmd is F_GETLK, F_SETLK or F_SETLKW,
              Packit 437b5e
                then arg is a flock table, otherwise an integer with meaning dependent
              Packit 437b5e
                upon the value of cmd.
              Packit 437b5e
                       (default 0)
              Packit 437b5e
                      
              Packit 437b5e
                  
              Packit 437b5e
              Packit 437b5e
                  

              Returns:

              Packit 437b5e
                  
                Packit 437b5e
                Packit 437b5e
                        integer return value depending on cmd, if successful
                Packit 437b5e
                    
                Packit 437b5e
                     

                Or

                Packit 437b5e
                    
                  Packit 437b5e
                          
                1. Packit 437b5e
                          nil
                  Packit 437b5e
                          
                2. Packit 437b5e
                             string
                  Packit 437b5e
                          error message
                  Packit 437b5e
                          
                3. Packit 437b5e
                             int
                  Packit 437b5e
                          errnum
                  Packit 437b5e
                      
                  Packit 437b5e
                  Packit 437b5e
                  Packit 437b5e
                      

                  See also:

                  Packit 437b5e
                      
                    Packit 437b5e
                             
                  • fcntl(2)
                  • Packit 437b5e
                             
                  • lock.lua
                  • Packit 437b5e
                        
                    Packit 437b5e
                    Packit 437b5e
                        

                    Usage:

                    Packit 437b5e
                        
                      Packit 437b5e
                              
                      local flag = P.fcntl (fd, P.F_GETFL)
                      Packit 437b5e
                          
                      Packit 437b5e
                      Packit 437b5e
                      Packit 437b5e
                          
                      Packit 437b5e
                          
                      Packit 437b5e
                          open (path, oflags[, mode=511])
                      Packit 437b5e
                          
                      Packit 437b5e
                          
                      Packit 437b5e
                          Open a file.
                      Packit 437b5e
                      Packit 437b5e
                      Packit 437b5e
                          

                      Parameters:

                      Packit 437b5e
                          
                        Packit 437b5e
                                
                      • path
                      • Packit 437b5e
                                    string
                        Packit 437b5e
                        Packit 437b5e
                        Packit 437b5e
                        Packit 437b5e
                                
                        Packit 437b5e
                                
                      • oflags
                      • Packit 437b5e
                                    int
                        Packit 437b5e
                                 bitwise OR of zero or more of O_RDONLY, O_WRONLY, O_RDWR,
                        Packit 437b5e
                          O_APPEND, O_CREAT, O_DSYNC, O_EXCL, O_NOCTTY, O_NONBLOCK,
                        Packit 437b5e
                          O_RSYNC, O_SYNC, O_TRUNC
                        Packit 437b5e
                                
                        Packit 437b5e
                                
                      • mode
                      • Packit 437b5e
                                    int
                        Packit 437b5e
                                 access modes used by O_CREAT
                        Packit 437b5e
                                 (default 511)
                        Packit 437b5e
                                
                        Packit 437b5e
                            
                        Packit 437b5e
                        Packit 437b5e
                            

                        Returns:

                        Packit 437b5e
                            
                          Packit 437b5e
                          Packit 437b5e
                                     int
                          Packit 437b5e
                                  file descriptor for path, if successful
                          Packit 437b5e
                              
                          Packit 437b5e
                               

                          Or

                          Packit 437b5e
                              
                            Packit 437b5e
                                    
                          1. Packit 437b5e
                                    nil
                            Packit 437b5e
                                    
                          2. Packit 437b5e
                                       string
                            Packit 437b5e
                                    error message
                            Packit 437b5e
                                    
                          3. Packit 437b5e
                                       int
                            Packit 437b5e
                                    errnum
                            Packit 437b5e
                                
                            Packit 437b5e
                            Packit 437b5e
                            Packit 437b5e
                                

                            See also:

                            Packit 437b5e
                                
                              Packit 437b5e
                                       open(2)
                              Packit 437b5e
                                  
                              Packit 437b5e
                              Packit 437b5e
                                  

                              Usage:

                              Packit 437b5e
                                  
                                Packit 437b5e
                                        
                                fd = P.open ("data", bit.bor (P.O_CREAT, P.O_RDWR), bit.bor (P.S_IRWXU, P.S_IRGRP))
                                Packit 437b5e
                                    
                                Packit 437b5e
                                Packit 437b5e
                                Packit 437b5e
                                    
                                Packit 437b5e
                                    
                                Packit 437b5e
                                    posix_fadvise (fd, offset, len, advice)
                                Packit 437b5e
                                    
                                Packit 437b5e
                                    
                                Packit 437b5e
                                    Instruct kernel on appropriate cache behaviour for a file or file segment.
                                Packit 437b5e
                                Packit 437b5e
                                Packit 437b5e
                                    

                                Parameters:

                                Packit 437b5e
                                    
                                  Packit 437b5e
                                          
                                • fd
                                • Packit 437b5e
                                              int
                                  Packit 437b5e
                                           open file descriptor
                                  Packit 437b5e
                                          
                                  Packit 437b5e
                                          
                                • offset
                                • Packit 437b5e
                                              int
                                  Packit 437b5e
                                           start of region
                                  Packit 437b5e
                                          
                                  Packit 437b5e
                                          
                                • len
                                • Packit 437b5e
                                              int
                                  Packit 437b5e
                                           number of bytes in region
                                  Packit 437b5e
                                          
                                  Packit 437b5e
                                          
                                • advice
                                • Packit 437b5e
                                              int
                                  Packit 437b5e
                                           one of POSIX_FADV_NORMAL, POSIX_FADV_SEQUENTIAL,
                                  Packit 437b5e
                                    POSIX_FADV_RANDOM, POSIX_FADV_NOREUSE, POSIX_FADV_WILLNEED or
                                  Packit 437b5e
                                    POSIX_FADV_DONTNEED
                                  Packit 437b5e
                                          
                                  Packit 437b5e
                                      
                                  Packit 437b5e
                                  Packit 437b5e
                                      

                                  Returns:

                                  Packit 437b5e
                                      
                                    Packit 437b5e
                                    Packit 437b5e
                                               int
                                    Packit 437b5e
                                            0, if successful
                                    Packit 437b5e
                                        
                                    Packit 437b5e
                                         

                                    Or

                                    Packit 437b5e
                                        
                                      Packit 437b5e
                                              
                                    1. Packit 437b5e
                                              nil
                                      Packit 437b5e
                                              
                                    2. Packit 437b5e
                                                 string
                                      Packit 437b5e
                                              error message
                                      Packit 437b5e
                                              
                                    3. Packit 437b5e
                                                 int
                                      Packit 437b5e
                                              errnum
                                      Packit 437b5e
                                          
                                      Packit 437b5e
                                      Packit 437b5e
                                      Packit 437b5e
                                          

                                      See also:

                                      Packit 437b5e
                                          
                                        Packit 437b5e
                                                 posix_fadvise(2)
                                        Packit 437b5e
                                            
                                        Packit 437b5e
                                        Packit 437b5e
                                        Packit 437b5e
                                        Packit 437b5e
                                        Packit 437b5e
                                            

                                        Constants

                                        Packit 437b5e
                                        Packit 437b5e
                                        Packit 437b5e
                                            
                                        Packit 437b5e
                                            
                                        Packit 437b5e
                                            
                                        Packit 437b5e
                                            posix.fcntl
                                        Packit 437b5e
                                            
                                        Packit 437b5e
                                            
                                        Packit 437b5e
                                            Fcntl constants.
                                        Packit 437b5e
                                        Any constants not available in the underlying system will be nil valued.
                                        Packit 437b5e
                                        Packit 437b5e
                                        Packit 437b5e
                                            

                                        Fields:

                                        Packit 437b5e
                                            
                                          Packit 437b5e
                                                  
                                        • F_DUPFD
                                        • Packit 437b5e
                                                      int
                                          Packit 437b5e
                                                   duplicate file descriptor
                                          Packit 437b5e
                                                  
                                          Packit 437b5e
                                                  
                                        • F_GETFD
                                        • Packit 437b5e
                                                      int
                                          Packit 437b5e
                                                   get file descriptor flags
                                          Packit 437b5e
                                                  
                                          Packit 437b5e
                                                  
                                        • F_SETFD
                                        • Packit 437b5e
                                                      int
                                          Packit 437b5e
                                                   set file descriptor flags
                                          Packit 437b5e
                                                  
                                          Packit 437b5e
                                                  
                                        • F_GETFL
                                        • Packit 437b5e
                                                      int
                                          Packit 437b5e
                                                   get file status flags
                                          Packit 437b5e
                                                  
                                          Packit 437b5e
                                                  
                                        • F_SETFL
                                        • Packit 437b5e
                                                      int
                                          Packit 437b5e
                                                   set file status flags
                                          Packit 437b5e
                                                  
                                          Packit 437b5e
                                                  
                                        • F_GETLK
                                        • Packit 437b5e
                                                      int
                                          Packit 437b5e
                                                   get record locking information
                                          Packit 437b5e
                                                  
                                          Packit 437b5e
                                                  
                                        • F_SETLK
                                        • Packit 437b5e
                                                      int
                                          Packit 437b5e
                                                   set record locking information
                                          Packit 437b5e
                                                  
                                          Packit 437b5e
                                                  
                                        • F_SETLKW
                                        • Packit 437b5e
                                                      int
                                          Packit 437b5e
                                                   set lock, and wait if blocked
                                          Packit 437b5e
                                                  
                                          Packit 437b5e
                                                  
                                        • F_GETOWN
                                        • Packit 437b5e
                                                      int
                                          Packit 437b5e
                                                   get SIGIO/SIGURG process owner
                                          Packit 437b5e
                                                  
                                          Packit 437b5e
                                                  
                                        • F_SETOWN
                                        • Packit 437b5e
                                                      int
                                          Packit 437b5e
                                                   set SIGIO/SIGURG process owner
                                          Packit 437b5e
                                                  
                                          Packit 437b5e
                                                  
                                        • F_RDLCK
                                        • Packit 437b5e
                                                      int
                                          Packit 437b5e
                                                   shared or read lock
                                          Packit 437b5e
                                                  
                                          Packit 437b5e
                                                  
                                        • F_WRLCK
                                        • Packit 437b5e
                                                      int
                                          Packit 437b5e
                                                   exclusive or write lock
                                          Packit 437b5e
                                                  
                                          Packit 437b5e
                                                  
                                        • F_UNLCK
                                        • Packit 437b5e
                                                      int
                                          Packit 437b5e
                                                   unlock
                                          Packit 437b5e
                                                  
                                          Packit 437b5e
                                                  
                                        • O_RDONLY
                                        • Packit 437b5e
                                                      int
                                          Packit 437b5e
                                                   open for reading only
                                          Packit 437b5e
                                                  
                                          Packit 437b5e
                                                  
                                        • O_WRONLY
                                        • Packit 437b5e
                                                      int
                                          Packit 437b5e
                                                   open for writing only
                                          Packit 437b5e
                                                  
                                          Packit 437b5e
                                                  
                                        • O_RDWR
                                        • Packit 437b5e
                                                      int
                                          Packit 437b5e
                                                   open for reading and writing
                                          Packit 437b5e
                                                  
                                          Packit 437b5e
                                                  
                                        • O_APPEND
                                        • Packit 437b5e
                                                      int
                                          Packit 437b5e
                                                   set append mode
                                          Packit 437b5e
                                                  
                                          Packit 437b5e
                                                  
                                        • O_CREAT
                                        • Packit 437b5e
                                                      int
                                          Packit 437b5e
                                                   create if nonexistent
                                          Packit 437b5e
                                                  
                                          Packit 437b5e
                                                  
                                        • O_DSYNC
                                        • Packit 437b5e
                                                      int
                                          Packit 437b5e
                                                   synchronise io data integrity
                                          Packit 437b5e
                                                  
                                          Packit 437b5e
                                                  
                                        • O_EXCL
                                        • Packit 437b5e
                                                      int
                                          Packit 437b5e
                                                   error if file already exists
                                          Packit 437b5e
                                                  
                                          Packit 437b5e
                                                  
                                        • O_NOCTTY
                                        • Packit 437b5e
                                                      int
                                          Packit 437b5e
                                                   don't assign controlling terminal
                                          Packit 437b5e
                                                  
                                          Packit 437b5e
                                                  
                                        • O_NONBLOCK
                                        • Packit 437b5e
                                                      int
                                          Packit 437b5e
                                                   no delay
                                          Packit 437b5e
                                                  
                                          Packit 437b5e
                                                  
                                        • O_RSYNC
                                        • Packit 437b5e
                                                      int
                                          Packit 437b5e
                                                   synchronise file read integrity
                                          Packit 437b5e
                                                  
                                          Packit 437b5e
                                                  
                                        • O_SYNC
                                        • Packit 437b5e
                                                      int
                                          Packit 437b5e
                                                   synchronise file write integrity
                                          Packit 437b5e
                                                  
                                          Packit 437b5e
                                                  
                                        • O_TRUNC
                                        • Packit 437b5e
                                                      int
                                          Packit 437b5e
                                                   truncate to zero length
                                          Packit 437b5e
                                                  
                                          Packit 437b5e
                                                  
                                        • POSIX_FADV_NORMAL
                                        • Packit 437b5e
                                                      int
                                          Packit 437b5e
                                                   no advice
                                          Packit 437b5e
                                                  
                                          Packit 437b5e
                                                  
                                        • POSIX_FADV_SEQUENTIAL
                                        • Packit 437b5e
                                                      int
                                          Packit 437b5e
                                                   expecting to access data sequentially
                                          Packit 437b5e
                                                  
                                          Packit 437b5e
                                                  
                                        • POSIX_FADV_RANDOM
                                        • Packit 437b5e
                                                      int
                                          Packit 437b5e
                                                   expecting to access data randomly
                                          Packit 437b5e
                                                  
                                          Packit 437b5e
                                                  
                                        • POSIX_FADV_NOREUSE
                                        • Packit 437b5e
                                                      int
                                          Packit 437b5e
                                                   expecting to access data once only
                                          Packit 437b5e
                                                  
                                          Packit 437b5e
                                                  
                                        • POSIX_FADV_WILLNEED
                                        • Packit 437b5e
                                                      int
                                          Packit 437b5e
                                                   expecting to access data in the near future
                                          Packit 437b5e
                                                  
                                          Packit 437b5e
                                                  
                                        • POSIX_FADV_DONTNEED
                                        • Packit 437b5e
                                                      int
                                          Packit 437b5e
                                                   not expecting to access the data in the near future
                                          Packit 437b5e
                                                  
                                          Packit 437b5e
                                              
                                          Packit 437b5e
                                          Packit 437b5e
                                          Packit 437b5e
                                          Packit 437b5e
                                          Packit 437b5e
                                              

                                          Usage:

                                          Packit 437b5e
                                              
                                            Packit 437b5e
                                                    
                                            Packit 437b5e
                                              -- Print fcntl constants supported on this host.
                                            Packit 437b5e
                                              for name, value in pairs (require "posix.fcntl") do
                                            Packit 437b5e
                                                if type (value) == "number" then
                                            Packit 437b5e
                                                  print (name, value)
                                            Packit 437b5e
                                                 end
                                            Packit 437b5e
                                              end
                                            Packit 437b5e
                                                
                                            Packit 437b5e
                                            Packit 437b5e
                                            Packit 437b5e
                                            Packit 437b5e
                                                

                                            Tables

                                            Packit 437b5e
                                            Packit 437b5e
                                            Packit 437b5e
                                                
                                            Packit 437b5e
                                                
                                            Packit 437b5e
                                                
                                            Packit 437b5e
                                                flock
                                            Packit 437b5e
                                                
                                            Packit 437b5e
                                                
                                            Packit 437b5e
                                                Advisory file locks.
                                            Packit 437b5e
                                            Passed as arg to fcntl when cmd is F_GETLK, F_SETLK or F_SETLKW.
                                            Packit 437b5e
                                            Packit 437b5e
                                            Packit 437b5e
                                                

                                            Fields:

                                            Packit 437b5e
                                                
                                              Packit 437b5e
                                                      
                                            • l_start
                                            • Packit 437b5e
                                                          int
                                              Packit 437b5e
                                                       starting offset
                                              Packit 437b5e
                                                      
                                              Packit 437b5e
                                                      
                                            • l_len
                                            • Packit 437b5e
                                                          int
                                              Packit 437b5e
                                                       len = 0 means until end of file
                                              Packit 437b5e
                                                      
                                              Packit 437b5e
                                                      
                                            • l_pid
                                            • Packit 437b5e
                                                          int
                                              Packit 437b5e
                                                       lock owner
                                              Packit 437b5e
                                                      
                                              Packit 437b5e
                                                      
                                            • l_type
                                            • Packit 437b5e
                                                          int
                                              Packit 437b5e
                                                       lock type
                                              Packit 437b5e
                                                      
                                              Packit 437b5e
                                                      
                                            • l_whence
                                            • Packit 437b5e
                                                          int
                                              Packit 437b5e
                                                       one of SEEK_SET, SEEK_CUR or SEEK_END
                                              Packit 437b5e
                                                      
                                              Packit 437b5e
                                                  
                                              Packit 437b5e
                                              Packit 437b5e
                                              Packit 437b5e
                                              Packit 437b5e
                                              Packit 437b5e
                                              Packit 437b5e
                                              Packit 437b5e
                                              Packit 437b5e
                                              Packit 437b5e
                                              Packit 437b5e
                                               
                                              Packit 437b5e
                                               
                                              Packit 437b5e
                                              Packit 437b5e
                                              generated by LDoc 1.4.3
                                              Packit 437b5e
                                              Last updated 2015-03-01 09:06:02 
                                              Packit 437b5e
                                               
                                              Packit 437b5e
                                               
                                              Packit 437b5e
                                              </body>
                                              Packit 437b5e
                                              </html>