Mercurial > octave
view libinterp/corefcn/getpwent.cc @ 19040:0850b5212619
doc: Add @nospell macro around proper names in documentation.
* aspell-octave.en.pws: Remove proper names from Octave's custom dictionary.
* doc/interpreter/audio.txi, doc/interpreter/diagperm.txi,
doc/interpreter/diffeq.txi, doc/interpreter/emacs.txi,
doc/interpreter/func.txi, doc/interpreter/geometry.txi,
doc/interpreter/intro.txi, doc/interpreter/linalg.txi,
doc/interpreter/numbers.txi, doc/interpreter/preface.txi,
doc/interpreter/quad.txi, doc/interpreter/sparse.txi,
libinterp/corefcn/colloc.cc, libinterp/corefcn/ellipj.cc,
libinterp/corefcn/gammainc.cc, libinterp/corefcn/hess.cc,
libinterp/corefcn/quadcc.cc, libinterp/corefcn/rand.cc,
libinterp/corefcn/sqrtm.cc, libinterp/dldfcn/ccolamd.cc,
libinterp/dldfcn/colamd.cc, libinterp/dldfcn/dmperm.cc,
libinterp/dldfcn/symrcm.cc, scripts/general/quadgk.m, scripts/general/quadl.m,
scripts/linear-algebra/commutation_matrix.m, scripts/linear-algebra/condest.m,
scripts/linear-algebra/duplication_matrix.m, scripts/linear-algebra/expm.m,
scripts/linear-algebra/housh.m, scripts/linear-algebra/krylov.m,
scripts/linear-algebra/onenormest.m, scripts/linear-algebra/qzhess.m,
scripts/optimization/fminsearch.m, scripts/optimization/glpk.m,
scripts/signal/arch_fit.m, scripts/signal/bartlett.m,
scripts/signal/blackman.m, scripts/signal/diffpara.m,
scripts/signal/durbinlevinson.m, scripts/signal/hamming.m,
scripts/signal/hanning.m, scripts/sparse/eigs.m, scripts/sparse/pcg.m,
scripts/sparse/pcr.m, scripts/specfun/ellipke.m,
scripts/special-matrix/gallery.m, scripts/special-matrix/invhilb.m,
scripts/statistics/base/quantile.m,
scripts/statistics/tests/kruskal_wallis_test.m,
scripts/statistics/tests/manova.m, scripts/statistics/tests/mcnemar_test.m:
Add @nospell macro around proper names in documentation.
author | Rik <rik@octave.org> |
---|---|
date | Thu, 21 Aug 2014 15:57:18 -0700 |
parents | 175b392e91fe |
children | 4197fc428c7d |
line wrap: on
line source
/* Copyright (C) 1996-2013 John W. Eaton This file is part of Octave. Octave is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 3 of the License, or (at your option) any later version. Octave is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with Octave; see the file COPYING. If not, see <http://www.gnu.org/licenses/>. */ #ifdef HAVE_CONFIG_H #include <config.h> #endif #include <string> #include <sys/types.h> #include "oct-passwd.h" #include "defun.h" #include "error.h" #include "gripes.h" #include "oct-map.h" #include "ov.h" #include "oct-obj.h" #include "utils.h" // Password file functions. (Why not?) static octave_value mk_pw_map (const octave_passwd& pw) { octave_value retval; if (pw) { octave_scalar_map m; m.assign ("name", pw.name ()); m.assign ("passwd", pw.passwd ()); m.assign ("uid", static_cast<double> (pw.uid ())); m.assign ("gid", static_cast<double> (pw.gid ())); m.assign ("gecos", pw.gecos ()); m.assign ("dir", pw.dir ()); m.assign ("shell", pw.shell ()); retval = m; } else retval = 0; return retval; } DEFUN (getpwent, args, , "-*- texinfo -*-\n\ @deftypefn {Built-in Function} {@var{pw_struct} =} getpwent ()\n\ Return a structure containing an entry from the password database,\n\ opening it if necessary. Once the end of the data has been reached,\n\ @code{getpwent} returns 0.\n\ @end deftypefn") { octave_value_list retval; retval(1) = std::string (); retval(0) = 0; int nargin = args.length (); if (nargin == 0) { std::string msg; retval(1) = msg; retval(0) = mk_pw_map (octave_passwd::getpwent (msg)); } else print_usage (); return retval; } DEFUN (getpwuid, args, , "-*- texinfo -*-\n\ @deftypefn {Built-in Function} {@var{pw_struct} =} getpwuid (@var{uid}).\n\ Return a structure containing the first entry from the password database\n\ with the user ID @var{uid}. If the user ID does not exist in the\n\ database, @code{getpwuid} returns 0.\n\ @end deftypefn") { octave_value_list retval; retval(1) = std::string (); retval(0) = 0; int nargin = args.length (); if (nargin == 1) { double dval = args(0).double_value (); if (! error_state) { if (D_NINT (dval) == dval) { uid_t uid = static_cast<uid_t> (dval); std::string msg; retval(1) = msg; retval(0) = mk_pw_map (octave_passwd::getpwuid (uid, msg)); } else error ("getpwuid: UID must be an integer"); } } else print_usage (); return retval; } DEFUN (getpwnam, args, , "-*- texinfo -*-\n\ @deftypefn {Built-in Function} {@var{pw_struct} =} getpwnam (@var{name})\n\ Return a structure containing the first entry from the password database\n\ with the user name @var{name}. If the user name does not exist in the\n\ database, @code{getpwname} returns 0.\n\ @end deftypefn") { octave_value_list retval; retval(1) = std::string (); retval(0) = 0.0; int nargin = args.length (); if (nargin == 1) { std::string s = args(0).string_value (); if (! error_state) { std::string msg; retval(1) = msg; retval(0) = mk_pw_map (octave_passwd::getpwnam (s, msg)); } } else print_usage (); return retval; } DEFUN (setpwent, args, , "-*- texinfo -*-\n\ @deftypefn {Built-in Function} {} setpwent ()\n\ Return the internal pointer to the beginning of the password database.\n\ @end deftypefn") { octave_value_list retval; retval(1) = std::string (); retval(0) = -1.0; int nargin = args.length (); if (nargin == 0) { std::string msg; retval(1) = msg; retval(0) = static_cast<double> (octave_passwd::setpwent (msg)); } else print_usage (); return retval; } DEFUN (endpwent, args, , "-*- texinfo -*-\n\ @deftypefn {Built-in Function} {} endpwent ()\n\ Close the password database.\n\ @end deftypefn") { octave_value_list retval; retval(1) = std::string (); retval(0) = -1.0; int nargin = args.length (); if (nargin == 0) { std::string msg; retval(1) = msg; retval(0) = static_cast<double> (octave_passwd::endpwent (msg)); } else print_usage (); return retval; }