From 533128af894c881037fd15aab110e7e394a7f337 Mon Sep 17 00:00:00 2001 From: hugogogo Date: Thu, 4 Nov 2021 15:46:31 +0100 Subject: [PATCH] still continue to fill readme with external functions --- README.md | 126 +++++++++++++++++++++++++++--------------------------- 1 file changed, 63 insertions(+), 63 deletions(-) diff --git a/README.md b/README.md index 0e22f61..325b23b 100644 --- a/README.md +++ b/README.md @@ -1,66 +1,3 @@ -## 2. external functions : ---- -### readline : -- **readline** : `char *readline (const char *prompt);` will read a line from the terminal and return it, using prompt as a prompt -- **rl_clear_history** : ` ` -- **rl_on_new_line** : ` ` -- **rl_replace_line** : ` ` -- **rl_redisplay** : ` ` -- **add_history** : ` ` -### files : -- **access** : `int access(const char *pathname, int mode);` checks whether the calling process can access the file pathname -- **open** : `int open(const char *pathname, int flags, [mode_t mode]);` system call opens the file specified by pathname -- **read** : `ssize_t read(int fd, void *buf, size_t count);` attempts to read up to count bytes from file descriptor fd into the buffer starting at buf -- **close** : `int close(int fd);` closes a file descriptor, so that it no longer refers to any file and may be reused -- **dup** : `int dup(int oldfd);` creates a copy of the file descriptor oldfd, using the lowest-numbered unused file descriptor for the new descriptor -- **dup2** : `int dup2(int oldfd, int newfd);` performs the same task as dup(), but instead of using the lowest-numbered unused file descriptor, it uses the file descriptor number specified in newfd -- **pipe** : `int pipe(int pipefd[2]);` creates a pipe, a unidirectional data channel that can be used for interprocess communication. The array pipefd is used to return two file descriptors referring to the ends of the pipe. pipefd[0] refers to the read end of the pipe. pipefd[1] refers to the write end of the pipe -- **stat** : `int stat(const char *pathname, struct stat *statbuf);` returns information about a file, in the buffer pointed to by statbuf -- **lstat** : `int fstat(int fd, struct stat *statbuf);` lstat() is identical to stat(), except that if pathname is a symbolic link, then it returns information about the link itself, not the file that it refers to -- **fstat** : `int lstat(const char *pathname, struct stat *statbuf);` fstat() is identical to stat(), except that the file about which information is to be retrieved is specified by the file descriptor fd -- **unlink** : `int unlink(const char *pathname);` unlink() deletes a name from the filesystem -### process : -- **fork** : ` ` -- **wait** : ` ` -- **waitpid** : ` ` -- **wait3** : ` ` -- **wait4** : ` ` -- **exit** : ` ` -### signals : -- **signal** : ` ` -- **sigaction** : ` ` -- **kill** : ` ` -### directories : -- **getcwd** : `char *getcwd(char *buf, size_t size);` returns a null-terminated string containing an absolute pathname that is the current working directory of the calling process -- **chdir** : `int chdir(const char *path);` changes the current working directory of the calling process to the directory specified in path -- **execve** : `int execve(const char *filename, char *const argv[], char *const envp[]);` executes the program pointed to by filename -- **opendir** : `DIR *opendir(const char *name);` opens a directory stream corresponding to the directory name, and returns a pointer to the directory stream -- **readdir** : `struct dirent *readdir(DIR *dirp);` returns a pointer to a dirent structure representing the next directory entry in the directory stream pointed to by dirp -- **closedir** : `int closedir(DIR *dirp);` closes the directory stream associated with dirp -### errors : -- **strerror** : `char *strerror(int errnum);` returns a pointer to a string that describes the error code passed in the argument errnum -- **perror** : `void perror(const char *s);` produces a message on standard error describing the last error encountered during a call to a system or library function -### other : -- **printf** : ` ` -- **malloc** : ` ` -- **free** : ` ` -- **write** : ` ` - -- **isatty** : ` ` -- **ttyname** : ` ` -- **ttyslot** : ` ` -- **ioctl** : ` ` -- **getenv** : ` ` -- **tcsetattr** : ` ` -- **tcgetattr** : ` ` -- **tgetent** : ` ` -- **tgetflag** : ` ` -- **tgetnum** : ` ` -- **tgetstr** : ` ` -- **tgoto** : ` ` -- **tputs** : ` ` - - ## sommaire : --- - [1. todo list :](#markdown-header-1-todo-list) @@ -120,6 +57,69 @@ *[\go to sommaire](#markdown-header-sommaire)* +## 2. external functions : +--- +### readline : +- **readline** : `char *readline (const char *prompt);` will read a line from the terminal and return it, using prompt as a prompt +- **rl_clear_history** : ` ` +- **rl_on_new_line** : ` ` +- **rl_replace_line** : ` ` +- **rl_redisplay** : ` ` +- **add_history** : ` ` +### files : +- **access** : `int access(const char *pathname, int mode);` checks whether the calling process can access the file pathname +- **open** : `int open(const char *pathname, int flags, [mode_t mode]);` system call opens the file specified by pathname +- **read** : `ssize_t read(int fd, void *buf, size_t count);` attempts to read up to count bytes from file descriptor fd into the buffer starting at buf +- **close** : `int close(int fd);` closes a file descriptor, so that it no longer refers to any file and may be reused +- **dup** : `int dup(int oldfd);` creates a copy of the file descriptor oldfd, using the lowest-numbered unused file descriptor for the new descriptor +- **dup2** : `int dup2(int oldfd, int newfd);` performs the same task as dup(), but instead of using the lowest-numbered unused file descriptor, it uses the file descriptor number specified in newfd +- **pipe** : `int pipe(int pipefd[2]);` creates a pipe, a unidirectional data channel that can be used for interprocess communication. The array pipefd is used to return two file descriptors referring to the ends of the pipe. pipefd[0] refers to the read end of the pipe. pipefd[1] refers to the write end of the pipe +- **stat** : `int stat(const char *pathname, struct stat *statbuf);` returns information about a file, in the buffer pointed to by statbuf +- **lstat** : `int fstat(int fd, struct stat *statbuf);` lstat() is identical to stat(), except that if pathname is a symbolic link, then it returns information about the link itself, not the file that it refers to +- **fstat** : `int lstat(const char *pathname, struct stat *statbuf);` fstat() is identical to stat(), except that the file about which information is to be retrieved is specified by the file descriptor fd +- **unlink** : `int unlink(const char *pathname);` unlink() deletes a name from the filesystem +### process : +- **fork** : `pid_t fork(void);` creates a new process by duplicating the calling process. The new process is referred to as the child process. The calling process is referred to as the parent process +- **wait** : `pid_t wait(int *wstatus);` suspends execution of the calling process until one of its children terminates. The call wait(&wstatus) is equivalent to: waitpid(-1, &wstatus, 0); +- **waitpid** : `pid_t waitpid(pid_t pid, int *wstatus, int options);` suspends execution of the calling process until a child specified by pid argument has changed state +- **wait3** : `pid_t wait3(int *wstatus, int options, struct rusage *rusage);` obsolete; use waitpid(2). similar to waitpid(2), but additionally return resource usage information about the child in the structure pointed to by rusage +- **wait4** : `pid_t wait4(pid_t pid, int *wstatus, int options, struct rusage *rusage);` like wait3() but additionally can be used to select a specific child +- **exit** : `void exit(int status);` causes normal process termination and the value of status & 0377 is returned to the parent (see wait()) +### signals : +- **signal** : `sighandler_t signal(int signum, sighandler_t handler(int));` sets the disposition of the signal signum to handler, which is either SIG_IGN, SIG_DFL, or the address of a programmer-defined function (a "signal handler") +- **sigaction** : `int sigaction(int signum, const struct sigaction *act, struct sigaction *oldact);` change the action taken by a process on receipt of a specific signal. +- **kill** : `int kill(pid_t pid, int sig);` send any signal to any process group or process +### directories : +- **getcwd** : `char *getcwd(char *buf, size_t size);` returns a null-terminated string containing an absolute pathname that is the current working directory of the calling process +- **chdir** : `int chdir(const char *path);` changes the current working directory of the calling process to the directory specified in path +- **execve** : `int execve(const char *filename, char *const argv[], char *const envp[]);` executes the program pointed to by filename +- **opendir** : `DIR *opendir(const char *name);` opens a directory stream corresponding to the directory name, and returns a pointer to the directory stream +- **readdir** : `struct dirent *readdir(DIR *dirp);` returns a pointer to a dirent structure representing the next directory entry in the directory stream pointed to by dirp +- **closedir** : `int closedir(DIR *dirp);` closes the directory stream associated with dirp +### errors : +- **strerror** : `char *strerror(int errnum);` returns a pointer to a string that describes the error code passed in the argument errnum +- **perror** : `void perror(const char *s);` produces a message on standard error describing the last error encountered during a call to a system or library function +### other : +- **printf** : `int printf(const char *format, ...);` produce output to stdout according to a specified format +- **malloc** : `void *malloc(size_t size);` allocates size bytes and returns a pointer to the allocated memory. The memory is not initialized +- **free** : `void free(void *ptr);` frees the memory space pointed to by ptr, which must have been returned by a previous call to malloc() +- **write** : `ssize_t write(int fd, const void *buf, size_t count);` writes up to bytes from the buffer starting at to the file referred to by the file descriptor + +- **isatty** : ` ` +- **ttyname** : ` ` +- **ttyslot** : ` ` +- **ioctl** : ` ` +- **getenv** : ` ` +- **tcsetattr** : ` ` +- **tcgetattr** : ` ` +- **tgetent** : ` ` +- **tgetflag** : ` ` +- **tgetnum** : ` ` +- **tgetstr** : ` ` +- **tgoto** : ` ` +- **tputs** : ` ` + + ## 3. parsing : ---