Man page or keyword search:   man All Sections 1 - General Commands 2 - System Calls 3 - Subroutines, Functions 4 - Special Files 5 - File Formats 6 - Games and Screensavers 7 - Macros and Conventions 8 - Maintenence Commands 9 - Kernel Interface New Commands Server 4.4BSD AIX Alpinelinux Archlinux Aros BSDOS BSDi Bifrost CentOS Cygwin Darwin Debian DigitalUNIX DragonFly ElementaryOS Fedora FreeBSD Gentoo GhostBSD HP-UX Haiku Hurd IRIX Inferno JazzOS Kali Knoppix LinuxMint MacOSX Mageia Mandriva Manjaro Minix MirBSD NeXTSTEP NetBSD OPENSTEP OSF1 OpenBSD OpenDarwin OpenIndiana OpenMandriva OpenServer OpenSuSE OpenVMS Oracle PC-BSD Peanut Pidora Plan9 QNX Raspbian RedHat Scientific Slackware SmartOS Solaris SuSE SunOS Syllable Tru64 UNIXv7 Ubuntu Ultrix UnixWare Xenix YellowDog aLinux   549 pages apropos Keyword Search (all sections) Output format html ascii pdf view pdf save postscript

COMPLETE(2)							   COMPLETE(2)

NAME
       complete - file name completion

SYNOPSIS
       #include <u.h>
       #include <libc.h>
       #include <complete.h>

       typedef struct CompletionCompletion;
       struct Completion{
	   uchar advance;  /* whether forward progress has been made */
	   uchar complete; /* whether the completion now represents a file or directory */
	   char *string;   /* the string to advance, suffixed " " or "/" for file or directory */
	   int nmatch;	   /* number of files that matched */
	   int nfile;	   /* number of files returned */
	   char **filename;/* their names */
       };

       Completion* complete(char *dir, char *s);

       void freecompletion(Completion *c);

DESCRIPTION
       The  complete function implements file name completion.	Given a direc‐
       tory dir and a string s, it returns an analysis of the  file  names  in
       that  directory	that  begin  with the string s.	 The fields nmatch and
       nfile will be set to the number of files	 that  match  the  prefix  and
       filename	 will  be  filled in with their names.	If the file named is a
       directory, a slash character will be appended to it.

       If no files match the string, nmatch will be zero,  but	complete  will
       return  the full set of files in the directory, with nfile set to their
       number.

       The flag advance reports whether the string s can be  extended  without
       changing	 the  set of files that match.	If true, string will be set to
       the extension; that is, the value of string may be appended to s by the
       caller to extend the embryonic file name unambiguously.

       The flag complete reports whether the extended file name uniquely iden‐
       tifies a file.  If true, string will be suffixed with  a	 blank,	 or  a
       slash and a blank, depending on whether the resulting file name identi‐
       fies a plain file or a directory.

       The freecompletion function frees a Completion structure and  its  con‐
       tents.

       In rio(1) and acme(1), file name completion is triggered by a control-F
       character or an Insert character.

SOURCE
       /sys/src/libcomplete

SEE ALSO
       rio(1), acme(1)

DIAGNOSTICS
       The complete function returns a null pointer and	 sets  errstr  if  the
       directory is unreadable or there is some other error.

BUGS
       The  behavior  of  file	name  completion  should  be controlled by the
       plumber.

								   COMPLETE(2)

                             _         _         _ 
                            | |       | |       | |     
                            | |       | |       | |     
                         __ | | __ __ | | __ __ | | __  
                         \ \| |/ / \ \| |/ / \ \| |/ /  
                          \ \ / /   \ \ / /   \ \ / /   
                           \   /     \   /     \   /    
                            \_/       \_/       \_/ 

Vote for polarhome