comparison libinterp/corefcn/syscalls.cc @ 20233:b597bd161a5f stable

doc: Document that mkfifo's mode argument is in decimal (bug #45054). * dirfns.cc (Fmkdir): Document that umask is applied to the mode bits of a newly created directory. * file-io.cc (Ffopen): Document that umask is applied to the mode bits of a newly created file. * file-io.cc (Fumask): Add brief explanation of umask and UNIX permission bits. * syscalls.cc (Fmkfifo): Document that mode is in decimal and subject to umask processing.
author Rik <rik@octave.org>
date Sun, 17 May 2015 09:45:54 -0700
parents aa36fb998a4d
children d9f35ceff9e1
comparison
equal deleted inserted replaced
20229:b0f7ee81d974 20233:b597bd161a5f
819 return retval; 819 return retval;
820 } 820 }
821 821
822 DEFUNX ("mkfifo", Fmkfifo, args, , 822 DEFUNX ("mkfifo", Fmkfifo, args, ,
823 "-*- texinfo -*-\n\ 823 "-*- texinfo -*-\n\
824 @deftypefn {Built-in Function} {} mkfifo (@var{name}, @var{mode})\n\ 824 @deftypefn {Built-in Function} {@var{err} =} mkfifo (@var{name}, @var{mode})\n\
825 @deftypefnx {Built-in Function} {[@var{err}, @var{msg}] =} mkfifo (@var{name}, @var{mode})\n\ 825 @deftypefnx {Built-in Function} {[@var{err}, @var{msg}] =} mkfifo (@var{name}, @var{mode})\n\
826 Create a FIFO special file named @var{name} with file mode @var{mode}\n\ 826 Create a FIFO special file named @var{name} with file mode @var{mode}.\n\
827 \n\
828 @var{mode} is interpreted as a decimal number (@emph{not} octal) and is\n\
829 subject to umask processing. The final calculated mode is\n\
830 @code{@var{mode} - @var{umask}}.\n\
827 \n\ 831 \n\
828 If successful, @var{err} is 0 and @var{msg} is an empty string.\n\ 832 If successful, @var{err} is 0 and @var{msg} is an empty string.\n\
829 Otherwise, @var{err} is nonzero and @var{msg} contains a system-dependent\n\ 833 Otherwise, @var{err} is nonzero and @var{msg} contains a system-dependent\n\
830 error message.\n\ 834 error message.\n\
831 @seealso{pipe}\n\ 835 @seealso{pipe, umask}\n\
832 @end deftypefn") 836 @end deftypefn")
833 { 837 {
834 octave_value_list retval; 838 octave_value_list retval;
835 839
836 retval(1) = std::string (); 840 retval(1) = std::string ();