octave_packages/m/@ftp/mget.m

   1 ## Copyright (C) 2009-2012 David Bateman
   2 ##
   3 ## This file is part of Octave.
   4 ##
   5 ## Octave is free software; you can redistribute it and/or modify it
   6 ## under the terms of the GNU General Public License as published by
   7 ## the Free Software Foundation; either version 3 of the License, or (at
   8 ## your option) any later version.
   9 ##
  10 ## Octave is distributed in the hope that it will be useful, but
  11 ## WITHOUT ANY WARRANTY; without even the implied warranty of
  12 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13 ## General Public License for more details.
  14 ##
  15 ## You should have received a copy of the GNU General Public License
  16 ## along with Octave; see the file COPYING.  If not, see
  17 ## <http://www.gnu.org/licenses/>.
  18
  19 ## -*- texinfo -*-
  20 ## @deftypefn  {Function File} {} mget (@var{f}, @var{file})
  21 ## @deftypefnx {Function File} {} mget (@var{f}, @var{dir})
  22 ## @deftypefnx {Function File} {} mget (@dots{}, @var{target})
  23 ## Download a remote file @var{file} or directory @var{dir} to the local
  24 ## directory on the FTP connection @var{f}.  @var{f} is an FTP object
  25 ## returned by the @code{ftp} function.
  26 ##
  27 ## The arguments @var{file} and @var{dir} can include wildcards and any
  28 ## files or directories on the remote server that match will be downloaded.
  29 ##
  30 ## If a third argument @var{target} is given, then a single file or
  31 ## directory will be downloaded with the name @var{target} to the local
  32 ## directory.
  33 ## @end deftypefn
  34
  35 function mget (f, file)
  36   __ftp_mget__ (f.curlhandle, file);
  37 endfunction