Mercurial > octave-antonio

comparison scripts/miscellaneous/fileattrib.m @ 20164:df437a52bcaf stable

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
doc: Update more docstrings to have one sentence summary as first line. Reviewed miscellaneous, sparse, strings in scripts directory. * scripts/miscellaneous/bzip2.m, scripts/miscellaneous/citation.m, scripts/miscellaneous/compare_versions.m, scripts/miscellaneous/computer.m, scripts/miscellaneous/debug.m, scripts/miscellaneous/dir.m, scripts/miscellaneous/edit.m, scripts/miscellaneous/error_ids.m, scripts/miscellaneous/fileattrib.m, scripts/miscellaneous/fullfile.m, scripts/miscellaneous/genvarname.m, scripts/miscellaneous/gzip.m, scripts/miscellaneous/mkoctfile.m, scripts/miscellaneous/news.m, scripts/miscellaneous/open.m, scripts/miscellaneous/parseparams.m, scripts/miscellaneous/recycle.m, scripts/miscellaneous/run.m, scripts/miscellaneous/swapbytes.m, scripts/miscellaneous/tar.m, scripts/miscellaneous/tmpnam.m, scripts/miscellaneous/unpack.m, scripts/miscellaneous/what.m, scripts/sparse/bicg.m, scripts/sparse/bicgstab.m, scripts/sparse/cgs.m, scripts/sparse/colperm.m, scripts/sparse/eigs.m, scripts/sparse/etreeplot.m, scripts/sparse/gmres.m, scripts/sparse/gplot.m, scripts/sparse/ichol.m, scripts/sparse/ilu.m, scripts/sparse/pcg.m, scripts/sparse/pcr.m, scripts/sparse/qmr.m, scripts/sparse/spaugment.m, scripts/sparse/spconvert.m, scripts/sparse/spdiags.m, scripts/sparse/spfun.m, scripts/sparse/spones.m, scripts/sparse/sprandsym.m, scripts/sparse/spstats.m, scripts/sparse/spy.m, scripts/sparse/svds.m, scripts/sparse/treelayout.m, scripts/sparse/treeplot.m, scripts/strings/base2dec.m, scripts/strings/bin2dec.m, scripts/strings/blanks.m, scripts/strings/cstrcat.m, scripts/strings/deblank.m, scripts/strings/dec2base.m, scripts/strings/dec2bin.m, scripts/strings/dec2hex.m, scripts/strings/findstr.m, scripts/strings/hex2dec.m, scripts/strings/index.m, scripts/strings/isletter.m, scripts/strings/isstrprop.m, scripts/strings/mat2str.m, scripts/strings/ostrsplit.m, scripts/strings/regexptranslate.m, scripts/strings/rindex.m, scripts/strings/str2num.m, scripts/strings/strcat.m, scripts/strings/strchr.m, scripts/strings/strjoin.m, scripts/strings/strjust.m, scripts/strings/strmatch.m, scripts/strings/strsplit.m, scripts/strings/strtok.m, scripts/strings/strtrim.m, scripts/strings/strtrunc.m, scripts/strings/substr.m, scripts/strings/untabify.m, scripts/time/datenum.m: Update more docstrings to have one sentence summary as first line.
author Rik <rik@octave.org>
date Mon, 04 May 2015 14:22:02 -0700
parents 4197fc428c7d
children
comparison
equal deleted inserted replaced
20163:075a5e2e1ba5 20164:df437a52bcaf
18 18
19 ## -*- texinfo -*- 19 ## -*- texinfo -*-
20 ## @deftypefn {Function File} {[@var{status}, @var{result}, @var{msgid}] =} fileattrib (@var{file}) 20 ## @deftypefn {Function File} {[@var{status}, @var{result}, @var{msgid}] =} fileattrib (@var{file})
21 ## Return information about @var{file}. 21 ## Return information about @var{file}.
22 ## 22 ##
23 ## If successful, @var{status} is 1, with @var{result} containing a 23 ## If successful, @var{status} is 1, with @var{result} containing a structure
24 ## structure with the following fields: 24 ## with the following fields:
25 ## 25 ##
26 ## @table @code 26 ## @table @code
27 ## @item Name 27 ## @item Name
28 ## Full name of @var{file}. 28 ## Full name of @var{file}.
29 ## 29 ##
40 ## True if @var{file} is a directory. 40 ## True if @var{file} is a directory.
41 ## 41 ##
42 ## @item UserRead 42 ## @item UserRead
43 ## @itemx GroupRead 43 ## @itemx GroupRead
44 ## @itemx OtherRead 44 ## @itemx OtherRead
45 ## True if the user (group; other users) has read permission for 45 ## True if the user (group; other users) has read permission for @var{file}.
46 ## @var{file}.
47 ## 46 ##
48 ## @item UserWrite 47 ## @item UserWrite
49 ## @itemx GroupWrite 48 ## @itemx GroupWrite
50 ## @itemx OtherWrite 49 ## @itemx OtherWrite
51 ## True if the user (group; other users) has write permission for 50 ## True if the user (group; other users) has write permission for @var{file}.
52 ## @var{file}.
53 ## 51 ##
54 ## @item UserExecute 52 ## @item UserExecute
55 ## @itemx GroupExecute 53 ## @itemx GroupExecute
56 ## @itemx OtherExecute 54 ## @itemx OtherExecute
57 ## True if the user (group; other users) has execute permission for 55 ## True if the user (group; other users) has execute permission for @var{file}.
58 ## @var{file}.
59 ## @end table 56 ## @end table
60 ## 57 ##
61 ## If an attribute does not apply (i.e., archive on a Unix system) then 58 ## If an attribute does not apply (i.e., archive on a Unix system) then the
62 ## the field is set to NaN. 59 ## field is set to NaN.
63 ## 60 ##
64 ## With no input arguments, return information about the current 61 ## With no input arguments, return information about the current directory.
65 ## directory.
66 ## 62 ##
67 ## If @var{file} contains globbing characters, return information about 63 ## If @var{file} contains globbing characters, return information about all
68 ## all the matching files. 64 ## the matching files.
69 ## @seealso{glob} 65 ## @seealso{glob}
70 ## @end deftypefn 66 ## @end deftypefn
71 67
72 function [status, msg, msgid] = fileattrib (file) 68 function [status, msg, msgid] = fileattrib (file)
73 69