diff --git a/man-pages-posix-2013-a/README b/man-pages-posix-2013-a/README deleted file mode 100644 index 8e1ccb8..0000000 --- a/man-pages-posix-2013-a/README +++ /dev/null @@ -1,22 +0,0 @@ -These are pages from POSIX.1-2008, Technical Corrigendum 1. -Since TC1 appeared in 2013, it is also known as POSIX.1-2013. - -This package contains the POSIX man pages (pages in sections -except 0p, 1p, and 3p). Some more information is given in the -`Announce' file. Some background on UNIX standards, including -POSIX, can be found in the standards(7) page provide as part -of the separate Linux man-pages package. - -Install by copying to your favourite location. -"make install" will just copy them to /usr/share/man/man[013]p. -"make" will move the pages from this package that are older than -the already installed ones to a subdirectory `not_installed', -then remove old versions (compressed or not), -compress the pages, and copy them to /usr/share/man/man[013]p. - -Note that you may have to remove preformatted pages. - -Copyrights: see the file POSIX-COPYRIGHT. - -If you have corrections and additions to suggest, then visit -https://www.kernel.org/doc/man-pages/reporting_bugs.html diff --git a/man-pages-posix-2013-a/man-pages-posix-2013-a.README b/man-pages-posix-2013-a/man-pages-posix-2013-a.README new file mode 100644 index 0000000..8e1ccb8 --- /dev/null +++ b/man-pages-posix-2013-a/man-pages-posix-2013-a.README @@ -0,0 +1,22 @@ +These are pages from POSIX.1-2008, Technical Corrigendum 1. +Since TC1 appeared in 2013, it is also known as POSIX.1-2013. + +This package contains the POSIX man pages (pages in sections +except 0p, 1p, and 3p). Some more information is given in the +`Announce' file. Some background on UNIX standards, including +POSIX, can be found in the standards(7) page provide as part +of the separate Linux man-pages package. + +Install by copying to your favourite location. +"make install" will just copy them to /usr/share/man/man[013]p. +"make" will move the pages from this package that are older than +the already installed ones to a subdirectory `not_installed', +then remove old versions (compressed or not), +compress the pages, and copy them to /usr/share/man/man[013]p. + +Note that you may have to remove preformatted pages. + +Copyrights: see the file POSIX-COPYRIGHT. + +If you have corrections and additions to suggest, then visit +https://www.kernel.org/doc/man-pages/reporting_bugs.html diff --git a/man-pages-posix-2013-a/man1p/admin.1p b/man-pages-posix-2013-a/man1p/admin.1p deleted file mode 100644 index 485769e..0000000 --- a/man-pages-posix-2013-a/man1p/admin.1p +++ /dev/null @@ -1,510 +0,0 @@ -'\" et -.TH ADMIN "1P" 2013 "IEEE/The Open Group" "POSIX Programmer's Manual" -.SH PROLOG -This manual page is part of the POSIX Programmer's Manual. -The Linux implementation of this interface may differ (consult -the corresponding Linux manual page for details of Linux behavior), -or the interface may not be implemented on Linux. - -.SH NAME -admin -\(em create and administer SCCS files (\fBDEVELOPMENT\fP) -.SH SYNOPSIS -.LP -.nf -admin \(mii\fB[\fIname\fB] [\fR\(min\fB] [\fR\(mia \fIlogin\fB] [\fR\(mid \fIflag\fB] [\fR\(mie \fIlogin\fB] [\fR\(mif \fIflag\fB] - [\fR\(mim \fImrlist\fB] [\fR\(mir \fIrel\fB] [\fR\(mit\fB[\fIname\fB] [\fR\(miy\fB[\fIcomment\fB]] \fInewfile\fR -.P -admin \(min\fB [\fR\(mia \fIlogin\fB] [\fR\(mid \fIflag\fB] [\fR\(mie \fIlogin\fB] [\fR\(mif \fIflag\fB] [\fR\(mim \fImrlist\fB] - [\fR\(mit\fB[\fIname\fB]] [\fR\(miy\fB[\fIcomment\fB]] \fInewfile\fR... -.P -admin \fB[\fR\(mia \fIlogin\fB] [\fR\(mid \fIflag\fB] [\fR\(mim \fImrlist\fB] [\fR\(mir \fIrel\fB] [\fR\(mit\fB[\fIname\fB]]\fR \fIfile\fR... -.P -admin \(mih \fIfile\fR... -.P -admin \(miz \fIfile\fR... -.fi -.SH DESCRIPTION -The -.IR admin -utility shall create new SCCS files or change parameters of existing -ones. If a named file does not exist, it shall be created, and its -parameters shall be initialized according to the specified options. -Parameters not initialized by an option shall be assigned a default -value. If a named file does exist, parameters corresponding to -specified options shall be changed, and other parameters shall be left -as is. -.P -All SCCS filenames supplied by the application shall be of the form -s.\fIfilename\fP. New SCCS files shall be given read-only permission -mode. Write permission in the parent directory is required to create a -file. All writing done by -.IR admin -shall be to a temporary -.IR x-file , -named x.\fIfilename\fP (see -.IR "\fIget\fR\^") -created with read-only mode if -.IR admin -is creating a new SCCS file, or created with the same mode as that of -the SCCS file if the file already exists. After successful execution of -.IR admin , -the SCCS file shall be removed (if it exists), and the -.IR x-file -shall be renamed with the name of the SCCS file. This ensures that -changes are made to the SCCS file only if no errors occur. -.P -The -.IR admin -utility shall also use a transient lock file (named z.\fIfilename\fP), -which is used to prevent simultaneous updates to the SCCS file; see -.IR "\fIget\fR\^". -.SH OPTIONS -The -.IR admin -utility shall conform to the Base Definitions volume of POSIX.1\(hy2008, -.IR "Section 12.2" ", " "Utility Syntax Guidelines", -except that the -.BR \(mii , -.BR \(mit , -and -.BR \(miy -options have optional option-arguments. These optional option-arguments -shall not be presented as separate arguments. The following options are -supported: -.IP "\fB\(min\fP" 10 -Create a new SCCS file. When -.BR \(min -is used without -.BR \(mii , -the SCCS file shall be created with control information but without any -file data. -.IP "\fB\(mii[\fIname\fB]\fR" 10 -Specify the -.IR name -of a file from which the text for a new SCCS file shall be taken. The -text constitutes the first delta of the file (see the -.BR \(mir -option for the delta numbering scheme). If the -.BR \(mii -option is used, but the -.IR name -option-argument is omitted, the text shall be obtained by reading the -standard input. If this option is omitted, the SCCS file shall be -created with control information but without any file data. The -.BR \(mii -option implies the -.BR \(min -option. -.IP "\fB\(mir\ \fISID\fR" 10 -Specify the SID of the initial delta to be inserted. This SID shall be -a trunk SID; that is, the branch and sequence numbers shall be zero or -missing. The level number is optional, and defaults to 1. -.IP "\fB\(mit[\fIname\fB]\fR" 10 -Specify the -.IR name -of a file from which descriptive text for the SCCS file shall be taken. -In the case of existing SCCS files (neither -.BR \(mii -nor -.BR \(min -is specified): -.RS 10 -.IP " *" 4 -A -.BR \(mit -option without a -.IR name -option-argument shall cause the removal of descriptive text (if any) -currently in the SCCS file. -.IP " *" 4 -A -.BR \(mit -option with a -.IR name -option-argument shall cause the text (if any) in the named file to -replace the descriptive text (if any) currently in the SCCS file. -.RE -.IP "\fB\(mif\ \fIflag\fR" 10 -Specify a -.IR flag , -and, possibly, a value for the -.IR flag , -to be placed in the SCCS file. Several -.BR \(mif -options may be supplied on a single -.IR admin -command line. Implementations shall recognize the following flags -and associated values: -.RS 10 -.IP "\fBb\fP" 8 -Allow use of the -.BR \(mib -option on a -.IR get -command to create branch deltas. -.IP "\fBc\fIceil\fR" 8 -Specify the highest release (that is, ceiling), a number less than or -equal to 9\|999, which may be retrieved by a -.IR get -command for editing. The default value for an unspecified -.BR c -flag shall be 9\|999. -.IP "\fBf\fIfloor\fR" 8 -Specify the lowest release (that is, floor), a number greater than 0 -but less than 9\|999, which may be retrieved by a -.IR get -command for editing. The default value for an unspecified -.BR f -flag shall be 1. -.IP "\fBd\fISID\fR" 8 -Specify the default delta number (SID) to be used by a -.IR get -command. -.IP "\fBi\fIstr\fR" 8 -Treat the ``No ID keywords'' message issued by -.IR get -or -.IR delta -as a fatal error. In the absence of this flag, the message is only a -warning. The message is issued if no SCCS identification keywords (see -.IR "\fIget\fR\^") -are found in the text retrieved or stored in the SCCS file. If a value -is supplied, the application shall ensure that the keywords exactly -match the given string; however, the string shall contain a keyword, -and no embedded - -characters. -.IP "\fBj\fP" 8 -Allow concurrent -.IR get -commands for editing on the same SID of an SCCS file. This allows -multiple concurrent updates to the same version of the SCCS file. -.IP "\fBl\fIlist\fR" 8 -Specify a -.IR list -of releases to which deltas can no longer be made (that is, -.IR get -.BR \(mie -against one of these locked releases fails). Conforming applications -shall use the following syntax to specify a -.IR list . -Implementations may accept additional forms as an extension: -.RS 8 -.sp -.RS 4 -.nf -\fB - ::= a | - ::= | , - ::= -.fi \fR -.P -.RE -.P -The character -.IR a -in the -.IR list -shall be equivalent to specifying all releases for the named SCCS file. -The non-terminal <\fISID\fP> in range shall be the delta number of an -existing delta associated with the SCCS file. -.RE -.IP "\fBn\fP" 8 -Cause -.IR delta -to create a null delta in each of those releases (if any) being skipped -when a delta is made in a new release (for example, in making delta 5.1 -after delta 2.7, releases 3 and 4 are skipped). These null deltas shall -serve as anchor points so that branch deltas may later be created from -them. The absence of this flag shall cause skipped releases to be -nonexistent in the SCCS file, preventing branch deltas from being -created from them in the future. During the initial creation of an SCCS -file, the -.BR n -flag may be ignored; that is, if the -.BR \(mir -option is used to set the release number of the initial SID to a value -greater than 1, null deltas need not be created for the ``skipped'' -releases. -.IP "\fBq\fItext\fR" 8 -Substitute user-definable -.IR text -for all occurrences of the %\fBQ\fP% keyword in the SCCS file text -retrieved by -.IR get . -.IP "\fBm\fImod\fR" 8 -Specify the module name of the SCCS file substituted for all -occurrences of the %\fBM\fP% keyword in the SCCS file text retrieved by -.IR get . -If the -.BR m -flag is not specified, the value assigned shall be the name of the SCCS -file with the leading -.BR '.' -removed. -.IP "\fBt\fItype\fR" 8 -Specify the -.IR type -of module in the SCCS file substituted for all occurrences of the -%\fBY\fP% keyword in the SCCS file text retrieved by -.IR get . -.IP "\fBv\fIpgm\fR" 8 -Cause -.IR delta -to prompt for modification request (MR) numbers as the reason for -creating a delta. The optional value specifies the name of an MR -number validation program. (If this flag is set when creating an SCCS -file, the application shall ensure that the -.BR m -option is also used even if its value is null.) -.RE -.IP "\fB\(mid\ \fIflag\fR" 10 -Remove (delete) the specified -.IR flag -from an SCCS file. Several -.BR \(mid -options may be supplied on a single -.IR admin -command. See the -.BR \(mif -option for allowable -.IR flag -names. (The -.BR l \c -.IR list -flag gives a -.IR list -of releases to be unlocked. See the -.BR \(mif -option for further description of the -.BR l -flag and the syntax of a -.IR list .) -.IP "\fB\(mia\ \fIlogin\fR" 10 -Specify a -.IR login -name, or numerical group ID, to be added to the list of users who may -make deltas (changes) to the SCCS file. A group ID shall be equivalent -to specifying all -.IR login -names common to that group ID. Several -.BR \(mia -options may be used on a single -.IR admin -command line. As many -.IR login s, -or numerical group IDs, as desired may be on the list simultaneously. -If the list of users is empty, then anyone may add deltas. If -.IR login -or group ID is preceded by a -.BR '!' , -the users so specified shall be denied permission to make deltas. -.IP "\fB\(mie\ \fIlogin\fR" 10 -Specify a -.IR login -name, or numerical group ID, to be erased from the list of users -allowed to make deltas (changes) to the SCCS file. Specifying a group -ID is equivalent to specifying all -.IR login -names common to that group ID. Several -.BR \(mie -options may be used on a single -.IR admin -command line. -.IP "\fB\(miy[\fIcomment\fB]\fR" 10 -Insert the -.IR comment -text into the SCCS file as a comment for the initial delta in a manner -identical to that of -.IR delta . -In the POSIX locale, omission of the -.BR \(miy -option shall result in a default comment line being inserted in -the form: -.RS 10 -.sp -.RS 4 -.nf -\fB -"date and time created %s %s by %s", <\fIdate\fR>, <\fItime\fR>, <\fIlogin\fR> -.fi \fR -.P -.RE -.P -where <\fIdate\fP> is expressed in the format of the -.IR date -utility's -.BR %y /\c -.BR %m /\c -.BR %d -conversion specification, <\fItime\fP> in the format of the -.IR date -utility's -.BR %T -conversion specification format, and <\fIlogin\fP> is the login name of -the user creating the file. -.RE -.IP "\fB\(mim\ \fImrlist\fR" 10 -Insert the list of modification request (MR) numbers into the SCCS -file as the reason for creating the initial delta in a manner identical to -.IR delta . -The application shall ensure that the -.BR v -flag is set and the MR numbers are validated if the -.BR v -flag has a value (the name of an MR number validation program). -A diagnostic message shall be written if the -.BR v -flag is not set or MR validation fails. -.IP "\fB\(mih\fP" 10 -Check the structure of the SCCS file and compare the newly computed -checksum with the checksum that is stored in the SCCS file. If the -newly computed checksum does not match the checksum in the SCCS file, a -diagnostic message shall be written. -.IP "\fB\(miz\fR" 10 -Recompute the SCCS file checksum and store it in the first line of the -SCCS file (see the -.BR \(mih -option above). Note that use of this option on a truly corrupted -file may prevent future detection of the corruption. -.SH OPERANDS -The following operands shall be supported: -.IP "\fIfile\fR" 10 -A pathname of an existing SCCS file or a directory. If -.IR file -is a directory, the -.IR admin -utility shall behave as though each file in the directory were -specified as a named file, except that non-SCCS files (last component -of the pathname does not begin with -.BR s. ) -and unreadable files shall be silently ignored. -.IP "\fInewfile\fR" 10 -A pathname of an SCCS file to be created. -.P -If exactly one -.IR file -or -.IR newfile -operand appears, and it is -.BR '\(mi' , -the standard input shall be read; each line of the standard input shall -be taken to be the name of an SCCS file to be processed. Non-SCCS files -and unreadable files shall be silently ignored. -.SH STDIN -The standard input shall be a text file used only if -.BR \(mii -is specified without an option-argument or if a -.IR file -or -.IR newfile -operand is specified as -.BR '\(mi' . -If the first character of any standard input line is - -in the POSIX locale, the results are unspecified. -.SH "INPUT FILES" -The existing SCCS files shall be text files of an unspecified format. -.P -The application shall ensure that the file named by the -.BR \(mii -option's -.IR name -option-argument shall be a text file; if the first character of any -line in this file is - -in the POSIX locale, the results are unspecified. If this file contains -more than 99\|999 lines, the number of lines recorded in the header for -this file shall be 99\|999 for this delta. -.SH "ENVIRONMENT VARIABLES" -The following environment variables shall affect the execution of -.IR admin : -.IP "\fILANG\fP" 10 -Provide a default value for the internationalization variables that are -unset or null. (See the Base Definitions volume of POSIX.1\(hy2008, -.IR "Section 8.2" ", " "Internationalization Variables" -for the precedence of internationalization variables used to determine -the values of locale categories.) -.IP "\fILC_ALL\fP" 10 -If set to a non-empty string value, override the values of all the -other internationalization variables. -.IP "\fILC_CTYPE\fP" 10 -Determine the locale for the interpretation of sequences of bytes of -text data as characters (for example, single-byte as opposed to -multi-byte characters in arguments and input files). -.IP "\fILC_MESSAGES\fP" 10 -.br -Determine the locale that should be used to affect the format and -contents of diagnostic messages written to standard error and the -contents of the default -.BR \(miy -comment. -.IP "\fINLSPATH\fP" 10 -Determine the location of message catalogs for the processing of -.IR LC_MESSAGES . -.SH "ASYNCHRONOUS EVENTS" -Default. -.SH STDOUT -Not used. -.SH STDERR -The standard error shall be used only for diagnostic messages. -.SH "OUTPUT FILES" -Any SCCS files created shall be text files of an unspecified format. -During processing of a -.IR file , -a locking -.IR z-file , -as described in -.IR "\fIget\fR\^", -may be created and deleted. -.SH "EXTENDED DESCRIPTION" -None. -.SH "EXIT STATUS" -The following exit values shall be returned: -.IP "\00" 6 -Successful completion. -.IP >0 6 -An error occurred. -.SH "CONSEQUENCES OF ERRORS" -Default. -.LP -.IR "The following sections are informative." -.SH "APPLICATION USAGE" -It is recommended that directories containing SCCS files be writable by -the owner only, and that SCCS files themselves be read-only. The mode -of the directories should allow only the owner to modify SCCS files -contained in the directories. The mode of the SCCS files prevents any -modification at all except by SCCS commands. -.SH EXAMPLES -None. -.SH RATIONALE -None. -.SH "FUTURE DIRECTIONS" -None. -.SH "SEE ALSO" -.IR "\fIdelta\fR\^", -.IR "\fIget\fR\^", -.IR "\fIprs\fR\^", -.IR "\fIwhat\fR\^" -.P -The Base Definitions volume of POSIX.1\(hy2008, -.IR "Chapter 8" ", " "Environment Variables", -.IR "Section 12.2" ", " "Utility Syntax Guidelines" -.SH COPYRIGHT -Portions of this text are reprinted and reproduced in electronic form -from IEEE Std 1003.1, 2013 Edition, Standard for Information Technology --- Portable Operating System Interface (POSIX), The Open Group Base -Specifications Issue 7, Copyright (C) 2013 by the Institute of -Electrical and Electronics Engineers, Inc and The Open Group. -(This is POSIX.1-2008 with the 2013 Technical Corrigendum 1 applied.) In the -event of any discrepancy between this version and the original IEEE and -The Open Group Standard, the original IEEE and The Open Group Standard -is the referee document. The original Standard can be obtained online at -http://www.unix.org/online.html . - -Any typographical or formatting errors that appear -in this page are most likely -to have been introduced during the conversion of the source files to -man page format. To report such errors, see -https://www.kernel.org/doc/man-pages/reporting_bugs.html . diff --git a/man-pages-posix-2013-a/man1p/delta.1p b/man-pages-posix-2013-a/man1p/delta.1p deleted file mode 100644 index 2350903..0000000 --- a/man-pages-posix-2013-a/man1p/delta.1p +++ /dev/null @@ -1,342 +0,0 @@ -'\" et -.TH DELTA "1P" 2013 "IEEE/The Open Group" "POSIX Programmer's Manual" -.SH PROLOG -This manual page is part of the POSIX Programmer's Manual. -The Linux implementation of this interface may differ (consult -the corresponding Linux manual page for details of Linux behavior), -or the interface may not be implemented on Linux. - -.SH NAME -delta -\(em make a delta (change) to an SCCS file (\fBDEVELOPMENT\fP) -.SH SYNOPSIS -.LP -.nf -delta \fB[\fR\(minps\fB] [\fR\(mig \fIlist\fB] [\fR\(mim \fImrlist\fB] [\fR\(mir \fISID\fB] [\fR\(miy\fB[\fIcomment\fB]] \fIfile\fR... -.fi -.SH DESCRIPTION -The -.IR delta -utility shall be used to permanently introduce into the named SCCS -files changes that were made to the files retrieved by -.IR get -(called the -.IR g-files , -or generated files). -.SH OPTIONS -The -.IR delta -utility shall conform to the Base Definitions volume of POSIX.1\(hy2008, -.IR "Section 12.2" ", " "Utility Syntax Guidelines", -except that the -.BR \(miy -option has an optional option-argument. This optional option-argument -shall not be presented as a separate argument. -.P -The following options shall be supported: -.IP "\fB\(mir\ \fISID\fR" 10 -Uniquely identify which delta is to be made to the SCCS file. The use -of this option shall be necessary only if two or more outstanding -.IR get -commands for editing (\c -.IR get -.BR \(mie ) -on the same SCCS file were done by the same person (login name). The -SID value specified with the -.BR \(mir -option can be either the SID specified on the -.IR get -command line or the SID to be made as reported by the -.IR get -utility; see -.IR "\fIget\fR\^". -.IP "\fB\(mis\fP" 10 -Suppress the report to standard output of the activity associated with -each -.IR file . -See the STDOUT section. -.IP "\fB\(min\fP" 10 -Specify retention of the edited -.IR g-file -(normally removed at completion of delta processing). -.IP "\fB\(mig\ \fIlist\fR" 10 -Specify a -.IR list -(see -.IR "\fIget\fR\^" -for the definition of -.IR list ) -of deltas that shall be ignored when the file is accessed at the -change level (SID) created by this delta. -.IP "\fB\(mim\ \fImrlist\fR" 10 -Specify a modification request (MR) number that the application shall -supply as the reason for creating the new delta. This shall be used if -the SCCS file has the -.BR v -flag set; see -.IR "\fIadmin\fR\^". -.RS 10 -.P -If -.BR \(mim -is not used and -.BR '\(mi' -is not specified as a file argument, and the standard input is a -terminal, the prompt described in the STDOUT section shall be written -to standard output before the standard input is read; if the standard -input is not a terminal, no prompt shall be issued. -.P -MRs in a list shall be separated by - -characters or escaped - -characters. An unescaped - -shall terminate the MR list. The escape character is -. -.P -If the -.BR v -flag has a value, it shall be taken to be the name of a program which -validates the correctness of the MR numbers. If a non-zero exit status -is returned from the MR number validation program, the -.IR delta -utility shall terminate. (It is assumed that the MR numbers were not -all valid.) -.RE -.IP "\fB\(miy\fB[\fIcomment\fB]\fR" 10 -Describe the reason for making the delta. The -.IR comment -shall be an arbitrary group of lines that would meet the definition of -a text file. Implementations shall support -.IR comment s -from zero to 512 bytes and may support longer values. A null string -(specified as either -.BR \(miy , -.BR \(miy \c -.BR \(dq\^\(dq , -or in response to a prompt for a comment) shall be considered a valid -.IR comment . -.RS 10 -.P -If -.BR \(miy -is not specified and -.BR '\(mi' -is not specified as a file argument, and the standard input is a -terminal, the prompt described in the STDOUT section shall be written -to standard output before the standard input is read; if the standard -input is not a terminal, no prompt shall be issued. An unescaped - -shall terminate the comment text. The escape character is -. -.P -The -.BR \(miy -option shall be required if the -.IR file -operand is specified as -.BR '\(mi' . -.RE -.IP "\fB\(mip\fP" 10 -Write (to standard output) the SCCS file differences before and after -the delta is applied in -.IR diff -format; see -.IR "\fIdiff\fR\^". -.SH OPERANDS -The following operand shall be supported: -.IP "\fIfile\fR" 10 -A pathname of an existing SCCS file or a directory. If -.IR file -is a directory, the -.IR delta -utility shall behave as though each file in the directory were -specified as a named file, except that non-SCCS files (last component -of the pathname does not begin with -.BR s. ) -and unreadable files shall be silently ignored. -.RS 10 -.P -If exactly one -.IR file -operand appears, and it is -.BR '\(mi' , -the standard input shall be read; each line of the standard input shall -be taken to be the name of an SCCS file to be processed. Non-SCCS files -and unreadable files shall be silently ignored. -.RE -.SH STDIN -The standard input shall be a text file used only in the following -cases: -.IP " *" 4 -To read an -.IR mrlist -or a -.IR comment -(see the -.BR \(mim -and -.BR \(miy -options). -.IP " *" 4 -A -.IR file -operand shall be specified as -.BR '\(mi' . -In this case, the -.BR \(miy -option must be used to specify the comment, and if the SCCS file has -the -.BR v -flag set, the -.BR \(mim -option must also be used to specify the MR list. -.SH "INPUT FILES" -Input files shall be text files whose data is to be included in the -SCCS files. If the first character of any line of an input file is - -in the POSIX locale, the results are unspecified. If this file contains -more than 99\|999 lines, the number of lines recorded in the header for -this file shall be 99\|999 for this delta. -.SH "ENVIRONMENT VARIABLES" -The following environment variables shall affect the execution of -.IR delta : -.IP "\fILANG\fP" 10 -Provide a default value for the internationalization variables that are -unset or null. (See the Base Definitions volume of POSIX.1\(hy2008, -.IR "Section 8.2" ", " "Internationalization Variables" -for the precedence of internationalization variables used to determine -the values of locale categories.) -.IP "\fILC_ALL\fP" 10 -If set to a non-empty string value, override the values of all the -other internationalization variables. -.IP "\fILC_CTYPE\fP" 10 -Determine the locale for the interpretation of sequences of bytes of -text data as characters (for example, single-byte as opposed to -multi-byte characters in arguments and input files). -.IP "\fILC_MESSAGES\fP" 10 -.br -Determine the locale that should be used to affect the format and -contents of diagnostic messages written to standard error, and -informative messages written to standard output. -.IP "\fINLSPATH\fP" 10 -Determine the location of message catalogs for the processing of -.IR LC_MESSAGES . -.IP "\fITZ\fP" 10 -Determine the timezone in which the time and date are written in the -SCCS file. If the -.IR TZ -variable is unset or NULL, an unspecified system default timezone is -used. -.SH "ASYNCHRONOUS EVENTS" -If SIGINT is caught, temporary files shall be cleaned up and -.IR delta -shall exit with a non-zero exit code. The standard action shall -be taken for all other signals; see -.IR "Section 1.4" ", " "Utility Description Defaults". -.SH STDOUT -The standard output shall be used only for the following messages in -the POSIX locale: -.IP " *" 4 -Prompts (see the -.BR \(mim -and -.BR \(miy -options) in the following formats: -.RS 4 -.sp -.RS 4 -.nf -\fB -"MRs? " -.P -"comments? " -.fi \fR -.P -.RE -.P -The MR prompt, if written, shall always precede the comments prompt. -.RE -.IP " *" 4 -A report of each file's activities (unless the -.BR \(mis -option is specified) in the following format: -.RS 4 -.sp -.RS 4 -.nf -\fB -"%s\en%d inserted\en%d deleted\en%d unchanged\en", <\fINew SID\fR>, - <\fInumber of lines inserted\fR>, <\fInumber of lines deleted\fR>, - <\fInumber of lines unchanged\fR> -.fi \fR -.P -.RE -.RE -.SH STDERR -The standard error shall be used only for diagnostic messages. -.SH "OUTPUT FILES" -Any SCCS files updated shall be files of an unspecified format. -.SH "EXTENDED DESCRIPTION" -.SS "System Date and Time" -.P -When a delta is added to an SCCS file, the system date and time shall -be recorded for the new delta. If a -.IR get -is performed using an SCCS file with a date recorded apparently in the -future, the behavior is unspecified. -.SH "EXIT STATUS" -The following exit values shall be returned: -.IP "\00" 6 -Successful completion. -.IP >0 6 -An error occurred. -.SH "CONSEQUENCES OF ERRORS" -Default. -.LP -.IR "The following sections are informative." -.SH "APPLICATION USAGE" -Problems can arise if the system date and time have been modified (for -example, put forward and then back again, or unsynchronized clocks -across a network) and can also arise when different values of the -.IR TZ -environment variable are used. -.P -Problems of a similar nature can also arise for the operation of the -.IR get -utility, which records the date and time in the file body. -.SH EXAMPLES -None. -.SH RATIONALE -None. -.SH "FUTURE DIRECTIONS" -None. -.SH "SEE ALSO" -.IR "Section 1.4" ", " "Utility Description Defaults", -.IR "\fIadmin\fR\^", -.IR "\fIdiff\fR\^", -.IR "\fIget\fR\^", -.IR "\fIprs\fR\^", -.IR "\fIrmdel\fR\^" -.P -The Base Definitions volume of POSIX.1\(hy2008, -.IR "Chapter 8" ", " "Environment Variables", -.IR "Section 12.2" ", " "Utility Syntax Guidelines" -.SH COPYRIGHT -Portions of this text are reprinted and reproduced in electronic form -from IEEE Std 1003.1, 2013 Edition, Standard for Information Technology --- Portable Operating System Interface (POSIX), The Open Group Base -Specifications Issue 7, Copyright (C) 2013 by the Institute of -Electrical and Electronics Engineers, Inc and The Open Group. -(This is POSIX.1-2008 with the 2013 Technical Corrigendum 1 applied.) In the -event of any discrepancy between this version and the original IEEE and -The Open Group Standard, the original IEEE and The Open Group Standard -is the referee document. The original Standard can be obtained online at -http://www.unix.org/online.html . - -Any typographical or formatting errors that appear -in this page are most likely -to have been introduced during the conversion of the source files to -man page format. To report such errors, see -https://www.kernel.org/doc/man-pages/reporting_bugs.html . diff --git a/man-pages-posix-2013-a/man1p/get.1p b/man-pages-posix-2013-a/man1p/get.1p deleted file mode 100644 index c1f1e81..0000000 --- a/man-pages-posix-2013-a/man1p/get.1p +++ /dev/null @@ -1,848 +0,0 @@ -'\" et -.TH GET "1P" 2013 "IEEE/The Open Group" "POSIX Programmer's Manual" -.SH PROLOG -This manual page is part of the POSIX Programmer's Manual. -The Linux implementation of this interface may differ (consult -the corresponding Linux manual page for details of Linux behavior), -or the interface may not be implemented on Linux. - -.SH NAME -get -\(em get a version of an SCCS file (\fBDEVELOPMENT\fP) -.SH SYNOPSIS -.LP -.nf -get \fB[\fR\(mibegkmnlLpst\fB] [\fR\(mic \fIcutoff\fB] [\fR\(mii \fIlist\fB] [\fR\(mir \fISID\fB] [\fR\(mix \fIlist\fB] \fIfile\fR... -.fi -.SH DESCRIPTION -The -.IR get -utility shall generate a text file from each named SCCS -.IR file -according to the specifications given by its options. -.P -The generated text shall normally be written into a file called the -.BR g-file -whose name is derived from the SCCS filename by simply removing the -leading -.BR \(dqs.\(dq . -.SH OPTIONS -The -.IR get -utility shall conform to the Base Definitions volume of POSIX.1\(hy2008, -.IR "Section 12.2" ", " "Utility Syntax Guidelines". -.P -The following options shall be supported: -.IP "\fB\(mir\ \fISID\fR" 10 -Indicate the SCCS Identification String (SID) of the version (delta) -of an SCCS file to be retrieved. The table shows, for the most useful -cases, what version of an SCCS file is retrieved (as well as the SID of -the version to be eventually created by -.IR delta -if the -.BR \(mie -option is also used), as a function of the SID specified. -.IP "\fB\(mic\ \fIcutoff\fR" 10 -Indicate the -.IR cutoff -date-time, in the form: -.RS 10 -.sp -.RS 4 -.nf -\fB -\fIYY\fB[\fIMM\fB[\fIDD\fB[\fIHH\fB[\fIMM\fB[\fISS\fB]]]]]\fR -.fi \fR -.P -.RE -.P -For the -.IR YY -component, values in the range [69,99] shall refer to years 1969 to -1999 inclusive, and values in the range [00,68] shall refer to years -2000 to 2068 inclusive. -.TP 10 -.BR Note: -It is expected that in a future version of this standard the default -century inferred from a 2-digit year will change. (This would apply -to all commands accepting a 2-digit year as input.) -.P -.P -No changes (deltas) to the SCCS file that were created after the -specified -.IR cutoff -date-time shall be included in the generated text file. Units omitted -from the date-time default to their maximum possible values; for -example, -.BR \(mic -7502 is equivalent to -.BR \(mic -750228235959. -.P -Any number of non-numeric characters may separate the various 2-digit -pieces of the -.IR cutoff -date-time. This feature allows the user to specify a -.IR cutoff -date in the form: -.BR \(mic -"77/2/2\09:22:25". -.RE -.IP "\fB\(mie\fR" 10 -Indicate that the -.IR get -is for the purpose of editing or making a change (delta) to the SCCS -file via a subsequent use of -.IR delta . -The -.BR \(mie -option used in a -.IR get -for a particular version (SID) of the SCCS file shall prevent further -.IR get -commands from editing on the same SID until -.IR delta -is executed or the -.BR j -(joint edit) flag is set in the SCCS file. Concurrent use of -.IR get -.BR \(mie -for different SIDs is always allowed. -.RS 10 -.P -If the -.BR g-file -generated by -.IR get -with a -.BR \(mie -option is accidentally ruined in the process of editing, it may be -regenerated by re-executing the -.IR get -command with the -.BR \(mik -option in place of the -.BR \(mie -option. -.P -SCCS file protection specified via the ceiling, floor, and authorized -user list stored in the SCCS file shall be enforced when the -.BR \(mie -option is used. -.RE -.IP "\fB\(mib\fR" 10 -Use with the -.BR \(mie -option to indicate that the new delta should have an SID in a new -branch as shown in the table below. This option shall be ignored if the -.BR b -flag is not present in the file or if the retrieved delta is not a leaf -delta. (A leaf delta is one that has no successors on the SCCS file tree.) -.RS 10 -.TP 10 -.BR Note: -A branch delta may always be created from a non-leaf delta. -.P -.RE -.IP "\fB\(mii\ \fIlist\fR" 10 -Indicate a -.IR list -of deltas to be included (forced to be applied) in the creation of the -generated file. The -.IR list -has the following syntax: -.RS 10 -.sp -.RS 4 -.nf -\fB - ::= | , - ::= SID | SID \(mi SID -.fi \fR -.P -.RE -.P -SID, the SCCS Identification of a delta, may be in any form shown in -the ``SID Specified'' column of the table in the EXTENDED DESCRIPTION -section, except that the result of supplying a partial SID is -unspecified. A diagnostic message shall be written if the first SID in -the range is not an ancestor of the second SID in the range. -.RE -.IP "\fB\(mix\ \fIlist\fR" 10 -Indicate a -.IR list -of deltas to be excluded (forced not to be applied) in the creation of -the generated file. See the -.BR \(mii -option for the -.IR list -format. -.IP "\fB\(mik\fR" 10 -Suppress replacement of identification keywords (see below) in the -retrieved text by their value. The -.BR \(mik -option shall be implied by the -.BR \(mie -option. -.IP "\fB\(mil\fR" 10 -Write a delta summary into an -.BR l-file . -.IP "\fB\(miL\fR" 10 -Write a delta summary to standard output. All informative output that -normally is written to standard output shall be written to standard -error instead, unless the -.BR \(mis -option is used, in which case it shall be suppressed. -.IP "\fB\(mip\fR" 10 -Write the text retrieved from the SCCS file to the standard output. No -.BR g-file -shall be created. All informative output that normally goes to the -standard output shall go to standard error instead, unless the -.BR \(mis -option is used, in which case it shall disappear. -.IP "\fB\(mis\fR" 10 -Suppress all informative output normally written to standard output. -However, fatal error messages (which shall always be written to the -standard error) shall remain unaffected. -.IP "\fB\(mim\fR" 10 -Precede each text line retrieved from the SCCS file by the SID of the -delta that inserted the text line in the SCCS file. The format shall be: -.RS 10 -.sp -.RS 4 -.nf -\fB -"%s\et%s", <\fISID\fR>, <\fItext line\fR> -.fi \fR -.P -.RE -.RE -.IP "\fB\(min\fR" 10 -Precede each generated text line with the %\fBM\fP% identification -keyword value (see below). The format shall be: -.RS 10 -.sp -.RS 4 -.nf -\fB -"%s\et%s", <\fI%M% value\fR>, <\fItext line\fR> -.fi \fR -.P -.RE -.P -When both the -.BR \(mim -and -.BR \(min -options are used, the <\fItext\ line\fP> shall be replaced by the -.BR \(mim -option-generated format. -.RE -.IP "\fB\(mig\fR" 10 -Suppress the actual retrieval of text from the SCCS file. It is -primarily used to generate an -.BR l-file , -or to verify the existence of a particular SID. -.IP "\fB\(mit\fR" 10 -Use to access the most recently created (top) delta in a given release -(for example, -.BR "\(mir 1" ), -or release and level (for example, -.BR "\(mir 1.2" ). -.br -.SH OPERANDS -The following operands shall be supported: -.IP "\fIfile\fR" 10 -A pathname of an existing SCCS file or a directory. If -.IR file -is a directory, the -.IR get -utility shall behave as though each file in the directory were -specified as a named file, except that non-SCCS files (last component -of the pathname does not begin with -.BR s. ) -and unreadable files shall be silently ignored. -.RS 10 -.P -If exactly one -.IR file -operand appears, and it is -.BR '\(mi' , -the standard input shall be read; each line of the standard input is -taken to be the name of an SCCS file to be processed. Non-SCCS files -and unreadable files shall be silently ignored. -.RE -.SH STDIN -The standard input shall be a text file used only if the -.IR file -operand is specified as -.BR '\(mi' . -Each line of the text file shall be interpreted as an SCCS pathname. -.SH "INPUT FILES" -The SCCS files shall be files of an unspecified format. -.SH "ENVIRONMENT VARIABLES" -The following environment variables shall affect the execution of -.IR get : -.IP "\fILANG\fP" 10 -Provide a default value for the internationalization variables that are -unset or null. (See the Base Definitions volume of POSIX.1\(hy2008, -.IR "Section 8.2" ", " "Internationalization Variables" -for the precedence of internationalization variables used to determine -the values of locale categories.) -.IP "\fILC_ALL\fP" 10 -If set to a non-empty string value, override the values of all the -other internationalization variables. -.IP "\fILC_CTYPE\fP" 10 -Determine the locale for the interpretation of sequences of bytes of -text data as characters (for example, single-byte as opposed to -multi-byte characters in arguments and input files). -.IP "\fILC_MESSAGES\fP" 10 -.br -Determine the locale that should be used to affect the format and -contents of diagnostic messages written to standard error, and -informative messages written to standard output (or standard error, if -the -.BR \(mip -option is used). -.IP "\fINLSPATH\fP" 10 -Determine the location of message catalogs for the processing of -.IR LC_MESSAGES . -.IP "\fITZ\fR" 10 -Determine the timezone in which the times and dates written in the -SCCS file are evaluated. If the -.IR TZ -variable is unset or NULL, an unspecified system default timezone is -used. -.SH "ASYNCHRONOUS EVENTS" -Default. -.SH STDOUT -For each file processed, -.IR get -shall write to standard output the SID being accessed and the number of -lines retrieved from the SCCS file, in the following format: -.sp -.RS 4 -.nf -\fB -"%s\en%d lines\en", <\fISID\fR>, <\fInumber of lines\fR> -.fi \fR -.P -.RE -.P -If the -.BR \(mie -option is used, the SID of the delta to be made shall appear after the -SID accessed and before the number of lines generated, in the POSIX -locale: -.sp -.RS 4 -.nf -\fB -"%s\ennew delta %s\en%d lines\en", <\fISID accessed\fR>, - <\fISID to be made\fR>, <\fInumber of lines\fR> -.fi \fR -.P -.RE -.P -If there is more than one named file or if a directory or standard -input is named, each pathname shall be written before each of the lines -shown in one of the preceding formats: -.sp -.RS 4 -.nf -\fB -"\en%s:\en", <\fIpathname\fR> -.fi \fR -.P -.RE -.P -If the -.BR \(miL -option is used, a delta summary shall be written following the format -specified below for -.BR l-files . -.P -If the -.BR \(mii -option is used, included deltas shall be listed following the notation, -in the POSIX locale: -.sp -.RS 4 -.nf -\fB -"Included:\en" -.fi \fR -.P -.RE -.P -If the -.BR \(mix -option is used, excluded deltas shall be listed following the notation, -in the POSIX locale: -.sp -.RS 4 -.nf -\fB -"Excluded:\en" -.fi \fR -.P -.RE -.P -If the -.BR \(mip -or -.BR \(miL -options are specified, the standard output shall consist of the text -retrieved from the SCCS file. -.SH STDERR -The standard error shall be used only for diagnostic messages, except -if the -.BR \(mip -or -.BR \(miL -options are specified, it shall include all informative messages -normally sent to standard output. -.SH "OUTPUT FILES" -Several auxiliary files may be created by -.IR get . -These files are known generically as the -.BR g-file , -.BR l-file , -.BR p-file , -and -.BR z-file . -The letter before the - -is called the -.IR tag . -An auxiliary filename shall be formed from the SCCS filename: the -application shall ensure that the last component of all SCCS filenames -is of the form -.BR s. \c -.IR module-name ; -the auxiliary files shall be named by replacing the leading -.BR s -with the tag. The -.BR g-file -shall be an exception to this scheme: the -.BR g-file -is named by removing the -.BR s. -prefix. For example, for -.BR s.xyz.c , -the auxiliary filenames would be -.BR xyz.c , -.BR l.xyz.c , -.BR p.xyz.c , -and -.BR z.xyz.c , -respectively. -.P -The -.BR g-file , -which contains the generated text, shall be created in the current -directory (unless the -.BR \(mip -option is used). A -.BR g-file -shall be created in all cases, whether or not any lines of text were -generated by the -.IR get . -It shall be owned by the real user. If the -.BR \(mik -option is used or implied, the -.BR g-file -shall be writable by the owner only (read-only for everyone else); -otherwise, it shall be read-only. Only the real user need have write -permission in the current directory. -.P -The -.BR l-file -shall contain a table showing which deltas were applied in generating -the retrieved text. The -.BR l-file -shall be created in the current directory if the -.BR \(mil -option is used; it shall be read-only and it is owned by the real user. -Only the real user need have write permission in the current -directory. -.P -Lines in the -.BR l-file -shall have the following format: -.sp -.RS 4 -.nf -\fB -"%c%c%c %s\et%s %s\en", <\fIcode1\fR>, <\fIcode2\fR>, <\fIcode3\fR>, - <\fISID\fR>, <\fIdate-time\fR>, <\fIlogin\fR> -.fi \fR -.P -.RE -.P -where the entries are: -.IP "<\fIcode1\fP>" 10 -A - -if the delta was applied; -.BR '*' -otherwise. -.IP "<\fIcode2\fP>" 10 -A - -if the delta was applied or was not applied and ignored; -.BR '*' -if the delta was not applied and was not ignored. -.IP "<\fIcode3\fP>" 10 -A character indicating a special reason why the delta was or was not -applied: -.RS 10 -.IP "\fBI\fP" 6 -Included. -.IP "\fBX\fP" 6 -Excluded. -.IP "\fBC\fP" 6 -Cut off (by a -.BR \(mic -option). -.RE -.IP "<\fIdate-time\fP>" 10 -Date and time (using the format of the -.IR date -utility's -.BR %y /\c -.BR %m /\c -.BR %d -.BR %T -conversion specification format) of creation. -.IP "<\fIlogin\fP>" 10 -Login name of person who created -.IR delta . -.P -The comments and MR data shall follow on subsequent lines, indented one -. -A blank line shall terminate each entry. -.P -The -.BR p-file -shall be used to pass information resulting from a -.IR get -with a -.BR \(mie -option along to -.IR delta . -Its contents shall also be used to prevent a subsequent execution of -.IR get -with a -.BR \(mie -option for the same SID until -.IR delta -is executed or the joint edit flag, -.BR j , -is set in the SCCS file. The -.BR p-file -shall be created in the directory containing the SCCS file and the -application shall ensure that the effective user has write permission -in that directory. It shall be writable by owner only, and owned -by the effective user. Each line in the -.BR p-file -shall have the following format: -.sp -.RS 4 -.nf -\fB -"%s %s %s %s%s%s\en", <\fIg-file SID\fR>, - <\fISID of new delta\fR>, <\fIlogin-name of real user\fR>, - <\fIdate-time\fR>, <\fIi-value\fR>, <\fIx-value\fR> -.fi \fR -.P -.RE -.P -where <\fIi\(hyvalue\fP> uses the format -.BR \(dq\^\(dq -if no -.BR \(mii -option was specified, and shall use the format: -.sp -.RS 4 -.nf -\fB -" \(mii%s", <\(mii option \fIoption-argument\fR> -.fi \fR -.P -.RE -.P -if a -.BR \(mii -option was specified and <\fIx\(hyvalue\fP> uses the format -.BR \(dq\^\(dq -if no -.BR \(mix -option was specified, and shall use the format: -.sp -.RS 4 -.nf -\fB -" \(mix%s", <\(mix option \fIoption-argument\fR> -.fi \fR -.P -.RE -.P -if a -.BR \(mix -option was specified. There can be an arbitrary number of lines in the -.BR p-file -at any time; no two lines shall have the same new delta SID. -.P -The -.BR z-file -shall serve as a lock-out mechanism against simultaneous updates. Its -contents shall be the binary process ID of the command (that is, -.IR get ) -that created it. The -.BR z-file -shall be created in the directory containing the SCCS file for the -duration of -.IR get . -The same protection restrictions as those for the -.BR p-file -shall apply for the -.BR z-file . -The -.BR z-file -shall be created read-only. -.br -.SH "EXTENDED DESCRIPTION" -.TS -center tab(@) box; -cB s s s s -cB cB cB cB cB -cB cB cB cB cB -l c lw(4.5c) l l. -Determination of SCCS Identification String -= -SID*@\(mib Keyletter@Other@SID@SID of Delta -Specified@Used\(dg@Conditions@Retrieved@to be Created -.sp 1.5p -= -none\(dd@no@R defaults to mR@mR.mL@mR.(mL+1) -_ -none\(dd@yes@R defaults to mR@mR.mL@mR.mL.(mB+1).1 -.sp 1.5p -= -R@no@R > mR@mR.mL@R.1*** -_ -R@no@R = mR@mR.mL@mR.(mL+1) -_ -R@yes@R > mR@mR.mL@mR.mL.(mB+1).1 -_ -R@yes@R = mR@mR.mL@mR.mL.(mB+1).1 -_ -R@\(mi@T{ -R < mR and -R does not exist -T}@hR.mL**@hR.mL.(mB+1).1 -_ -R@\(mi@T{ -Trunk successor in release > R -and R exists -T}@R.mL@R.mL.(mB+1).1 -.sp 1.5p -= -R.L@no@No trunk successor@R.L@R.(L+1) -_ -R.L@yes@No trunk successor@R.L@R.L.(mB+1).1 -_ -R.L@\(mi@T{ -Trunk successor -in release \(>= R -T}@R.L@R.L.(mB+1).1 -.sp 1.5p -= -R.L.B@no@No branch successor@R.L.B.mS@R.L.B.(mS+1) -_ -R.L.B@yes@No branch successor@R.L.B.mS@R.L.(mB+1).1 -.sp 1.5p -= -R.L.B.S@no@No branch successor@R.L.B.S@R.L.B.(S+1) -_ -R.L.B.S@yes@No branch successor@R.L.B.S@R.L.(mB+1).1 -_ -R.L.B.S@\(mi@Branch successor@R.L.B.S@R.L.(mB+1).1 -.TE -.IP * 8 -R, L, B, and S are the release, level, branch, and sequence components -of the SID, respectively; m means maximum. Thus, for example, R.mL -means ``the maximum level number within release R''; R.L.(mB+1).1 means -``the first sequence number on the new branch (that is, maximum branch -number plus one) of level L within release R''. Note that if the SID -specified is of the form R.L, R.L.B, or R.L.B.S, each of the specified -components shall exist. -.IP ** 8 -hR is the highest existing release that is lower than the specified, -nonexistent, release R. -.IP *** 8 -This is used to force creation of the first delta in a new release. -.IP "\(dg" 8 -The -.BR \(mib -option is effective only if the -.BR b -flag is present in the file. An entry of -.BR '\(mi' -means ``irrelevant''. -.IP "\(dd" 8 -This case applies if the -.BR d -(default SID) flag is not present in the file. If the -.BR d -flag is present in the file, then the SID obtained from the -.BR d -flag is interpreted as if it had been specified on the command line. -Thus, one of the other cases in this table applies. -.SS "System Date and Time" -.P -When a -.BR g-file -is generated, the creation time of deltas in the SCCS file may be taken -into account. If any of these times are apparently in the future, the -behavior is unspecified. -.SS "Identification Keywords" -.P -Identifying information shall be inserted into the text retrieved from -the SCCS file by replacing identification keywords with their value -wherever they occur. The following keywords may be used in the text -stored in an SCCS file: -.IP "%\fBM\fP%" 10 -Module name: either the value of the -.BR m -flag in the file, or if absent, the name of the SCCS file with the -leading -.BR s. -removed. -.IP "%\fBI\fP%" 10 -SCCS identification (SID) (%\fBR\fR%.%\fBL\fR% or -%\fBR\fR%.%\fBL\fR%.%\fBB\fR%.%\fBS\fR%) of the retrieved text. -.IP "%\fBR\fP%" 10 -Release. -.IP "%\fBL\fP%" 10 -Level. -.IP "%\fBB\fP%" 10 -Branch. -.IP "%\fBS\fP%" 10 -Sequence. -.IP "%\fBD\fP%" 10 -Current date (\fIYY\fR/\fIMM\fR/\fIDD\fR). -.IP "%\fBH\fP%" 10 -Current date (\fIMM\fR/\fIDD\fR/\fIYY\fR). -.IP "%\fBT\fP%" 10 -Current time (\fIHH\fR:\fIMM\fR:\fISS\fR). -.IP "%\fBE\fP%" 10 -Date newest applied delta was created (\fIYY\fR/\fIMM\fR/\fIDD\fR). -.IP "%\fBG\fP%" 10 -Date newest applied delta was created (\fIMM\fR/\fIDD\fR/\fIYY\fR). -.IP "%\fBU\fP%" 10 -Time newest applied delta was created (\fIHH\fR:\fIMM\fR:\fISS\fR). -.IP "%\fBY\fP%" 10 -Module type: value of the -.BR t -flag in the SCCS file. -.IP "%\fBF\fP%" 10 -SCCS filename. -.IP "%\fBP\fP%" 10 -SCCS absolute pathname. -.IP "%\fBQ\fP%" 10 -The value of the -.BR q -flag in the file. -.IP "%\fBC\fP%" 10 -Current line number. This keyword is intended for identifying messages -output by the program, such as ``this should not have happened'' type -errors. It is not intended to be used on every line to provide -sequence numbers. -.IP "%\fBZ\fP%" 10 -The four-character string -.BR \(dq@(#)\(dq -recognizable by -.IR what . -.IP "%\fBW\fP%" 10 -A shorthand notation for constructing -.IR what -strings: -.RS 10 -.sp -.RS 4 -.nf -\fB -%\^W\^%=%\^Z\^%%\^M\^%%\^I\^% -.fi \fR -.P -.RE -.RE -.IP "%\fBA\fP%" 10 -Another shorthand notation for constructing -.IR what -strings: -.RS 10 -.sp -.RS 4 -.nf -\fB -%\^A\^%=%\^Z\^%%\^Y\^%%\^M\^%%\^I\^%%\^Z\^% -.fi \fR -.P -.RE -.RE -.SH "EXIT STATUS" -The following exit values shall be returned: -.IP "\00" 6 -Successful completion. -.IP >0 6 -An error occurred. -.SH "CONSEQUENCES OF ERRORS" -Default. -.LP -.IR "The following sections are informative." -.SH "APPLICATION USAGE" -Problems can arise if the system date and time have been modified (for -example, put forward and then back again, or unsynchronized clocks -across a network) and can also arise when different values of the -.IR TZ -environment variable are used. -.P -Problems of a similar nature can also arise for the operation of the -.IR delta -utility, which compares the previous file body against the working file -as part of its normal operation. -.SH EXAMPLES -None. -.SH RATIONALE -None. -.SH "FUTURE DIRECTIONS" -None. -.SH "SEE ALSO" -.IR "\fIadmin\fR\^", -.IR "\fIdelta\fR\^", -.IR "\fIprs\fR\^", -.IR "\fIwhat\fR\^" -.P -The Base Definitions volume of POSIX.1\(hy2008, -.IR "Chapter 8" ", " "Environment Variables", -.IR "Section 12.2" ", " "Utility Syntax Guidelines" -.SH COPYRIGHT -Portions of this text are reprinted and reproduced in electronic form -from IEEE Std 1003.1, 2013 Edition, Standard for Information Technology --- Portable Operating System Interface (POSIX), The Open Group Base -Specifications Issue 7, Copyright (C) 2013 by the Institute of -Electrical and Electronics Engineers, Inc and The Open Group. -(This is POSIX.1-2008 with the 2013 Technical Corrigendum 1 applied.) In the -event of any discrepancy between this version and the original IEEE and -The Open Group Standard, the original IEEE and The Open Group Standard -is the referee document. The original Standard can be obtained online at -http://www.unix.org/online.html . - -Any typographical or formatting errors that appear -in this page are most likely -to have been introduced during the conversion of the source files to -man page format. To report such errors, see -https://www.kernel.org/doc/man-pages/reporting_bugs.html . diff --git a/man-pages-posix-2013-a/man1p/prs.1p b/man-pages-posix-2013-a/man1p/prs.1p deleted file mode 100644 index aa268a6..0000000 --- a/man-pages-posix-2013-a/man1p/prs.1p +++ /dev/null @@ -1,445 +0,0 @@ -'\" et -.TH PRS "1P" 2013 "IEEE/The Open Group" "POSIX Programmer's Manual" -.SH PROLOG -This manual page is part of the POSIX Programmer's Manual. -The Linux implementation of this interface may differ (consult -the corresponding Linux manual page for details of Linux behavior), -or the interface may not be implemented on Linux. - -.SH NAME -prs -\(em print an SCCS file (\fBDEVELOPMENT\fP) -.SH SYNOPSIS -.LP -.nf -prs \fB[\fR\(mia\fB] [\fR\(mid \fIdataspec\fB] [\fR\(mir\fB[\fISID\fB]]\fI file\fR... -.P -prs \fB[\fR\(mie|\(mil\fB]\fR \(mic \fIcutoff \fB[\fR\(mid \fIdataspec\fB]\fI file\fR... -.P -prs \fB[\fR\(mie|\(mil\fB]\fR \(mir\fB[\fISID\fB] [\fR\(mid \fIdataspec\fB] \fIfile\fR... -.fi -.SH DESCRIPTION -The -.IR prs -utility shall write to standard output parts or all of an SCCS file in -a user-supplied format. -.SH OPTIONS -The -.IR prs -utility shall conform to the Base Definitions volume of POSIX.1\(hy2008, -.IR "Section 12.2" ", " "Utility Syntax Guidelines", -except that the -.BR \(mir -option has an optional option-argument. This optional option-argument -cannot be presented as a separate argument. The following options -shall be supported: -.IP "\fB\(mid\ \fIdataspec\fR" 10 -Specify the output data specification. The -.IR dataspec -shall be a string consisting of SCCS file -.IR data -.IR keywords -(see -.IR "Data Keywords") -interspersed with optional user-supplied text. -.IP "\fB\(mir[\fISID\fB]\fR" 10 -Specify the SCCS identification string (SID) of a delta for which -information is desired. If no -.IR SID -option-argument is specified, the SID of the most recently created -delta shall be assumed. -.IP "\fB\(mie\fP" 10 -Request information for all deltas created earlier than and including -the delta designated via the -.BR \(mir -option or the date-time given by the -.BR \(mic -option. -.IP "\fB\(mil\fP" 10 -Request information for all deltas created later than and including the -delta designated via the -.BR \(mir -option or the date-time given by the -.BR \(mic -option. -.IP "\fB\(mic\ \fIcutoff\fR" 10 -Indicate the -.IR cutoff -date-time, in the form: -.RS 10 -.sp -.RS 4 -.nf -\fB -\fIYY\fB[\fIMM\fB[\fIDD\fB[\fIHH\fB[\fIMM\fB[\fISS\fB]]]]]\fR -.fi \fR -.P -.RE -.P -For the -.IR YY -component, values in the range [69,99] shall refer to years 1969 to -1999 inclusive, and values in the range [00,68] shall refer to years -2000 to 2068 inclusive. -.TP 10 -.BR Note: -It is expected that in a future version of this standard the default -century inferred from a 2-digit year will change. (This would apply to -all commands accepting a 2-digit year as input.) -.P -.P -No changes (deltas) to the SCCS file that were created after the -specified -.IR cutoff -date-time shall be included in the output. Units omitted from the -date-time default to their maximum possible values; for example, -.BR \(mic\07502 -is equivalent to -.BR \(mic\0750228235959 . -.RE -.IP "\fB\(mia\fP" 10 -Request writing of information for both removed\(emthat is, -.IR delta -.IR type =\c -.IR R -(see -.IR "\fIrmdel\fR\^")\(em\c -and existing\(emthat is, -.IR delta -.IR type =\c -.IR D ,\(em\c -deltas. If the -.BR \(mia -option is not specified, information for existing deltas only shall be -provided. -.SH OPERANDS -The following operand shall be supported: -.IP "\fIfile\fR" 10 -A pathname of an existing SCCS file or a directory. If -.IR file -is a directory, the -.IR prs -utility shall behave as though each file in the directory were -specified as a named file, except that non-SCCS files (last component -of the pathname does not begin with -.BR s. ) -and unreadable files shall be silently ignored. -.RS 10 -.P -If exactly one -.IR file -operand appears, and it is -.BR '\(mi' , -the standard input shall be read; each line of the standard input shall -be taken to be the name of an SCCS file to be processed. Non-SCCS -files and unreadable files shall be silently ignored. -.RE -.SH STDIN -The standard input shall be a text file used only when the -.IR file -operand is specified as -.BR '\(mi' . -Each line of the text file shall be interpreted as an SCCS pathname. -.SH "INPUT FILES" -Any SCCS files displayed are files of an unspecified format. -.SH "ENVIRONMENT VARIABLES" -The following environment variables shall affect the execution of -.IR prs : -.IP "\fILANG\fP" 10 -Provide a default value for the internationalization variables that are -unset or null. (See the Base Definitions volume of POSIX.1\(hy2008, -.IR "Section 8.2" ", " "Internationalization Variables" -the precedence of internationalization variables used to determine the -values of locale categories.) -.IP "\fILC_ALL\fP" 10 -If set to a non-empty string value, override the values of all the -other internationalization variables. -.IP "\fILC_CTYPE\fP" 10 -Determine the locale for the interpretation of sequences of bytes of -text data as characters (for example, single-byte as opposed to -multi-byte characters in arguments and input files). -.IP "\fILC_MESSAGES\fP" 10 -.br -Determine the locale that should be used to affect the format and -contents of diagnostic messages written to standard error. -.IP "\fINLSPATH\fP" 10 -Determine the location of message catalogs for the processing of -.IR LC_MESSAGES . -.SH "ASYNCHRONOUS EVENTS" -Default. -.SH STDOUT -The standard output shall be a text file whose format is dependent on -the data keywords specified with the -.BR \(mid -option. -.SS "Data Keywords" -.P -Data keywords specify which parts of an SCCS file shall be retrieved -and output. All parts of an SCCS file have an associated data -keyword. A data keyword may appear in a -.IR dataspec -multiple times. -.P -The information written by -.IR prs -shall consist of: -.IP " 1." 4 -The user-supplied text -.IP " 2." 4 -Appropriate values (extracted from the SCCS file) substituted for the -recognized data keywords in the order of appearance in the -.IR dataspec -.P -The format of a data keyword value shall either be simple (\c -.BR 'S' ), -in which keyword substitution is direct, or multi-line (\c -.BR 'M' ). -.P -User-supplied text shall be any text other than recognized data -keywords. A - -shall be specified by -.BR '\et' -and - -by -.BR '\en' . -When the -.BR \(mir -option is not specified, the default -.IR dataspec -shall be: -.sp -.RS 4 -.nf -\fB -:PN::\en\en -.fi \fR -.P -.RE -.P -and the following -.IR dataspec -shall be used for each selected delta: -.sp -.RS 4 -.nf -\fB -:Dt:\et:DL:\enMRs:\en:MR:COMMENTS:\en:C: -.fi \fR -.P -.RE -.TS -center box tab(!); -cB s s s s -cB | cB | cB | cB | cB -lB | l | c | lB | c. -SCCS File Data Keywords -_ -Keyword!Data Item!File Section!Value!Format -_ -:Dt:!Delta information!Delta Table!\fRSee below*\fP!S -:DL:!Delta line statistics!"!:Li:/:Ld:/:Lu:!S -:Li:!Lines inserted by Delta!"!\fInnnnn\fR***!S -:Ld:!Lines deleted by Delta!"!\fInnnnn\fR***!S -:Lu:!Lines unchanged by Delta!"!\fInnnnn\fR***!S -:DT:!Delta type!"!D or R!S -:I:!SCCS ID string (SID)!"!\fRSee below**\fP!S -:R:!Release number!"!\fInnnn\fR!S -:L:!Level number!"!\fInnnn\fR!S -:B:!Branch number!"!\fInnnn\fR!S -:S:!Sequence number!"!\fInnnn\fR!S -:D:!Date delta created!"!:Dy:/:Dm:/:Dd:!S -:Dy:!Year delta created!"!\fInn\fR!S -:Dm:!Month delta created!"!\fInn\fR!S -:Dd:!Day delta created!"!\fInn\fR!S -:T:!Time delta created!"!:Th:::Tm:::Ts:!S -:Th:!Hour delta created!"!\fInn\fR!S -:Tm:!Minutes delta created!"!\fInn\fR!S -:Ts:!Seconds delta created!"!\fInn\fR!S -:P:!Programmer who created Delta!"!\fIlogname\fR!S -:DS:!Delta sequence number!"!\fInnnn\fR!S -:DP:!Predecessor Delta sequence!"!\fInnnn\fR!S -!number -:DI:!Sequence number of deltas!"!:Dn:/:Dx:/:Dg:!S -!included, excluded, or ignored -:Dn:!Deltas included (sequence #)!"!:DS: :DS: .\|.\|.!S -:Dx:!Deltas excluded (sequence #)!"!:DS: :DS: .\|.\|.!S -:Dg:!Deltas ignored (sequence #)!"!:DS: :DS: .\|.\|.!S -:MR:!MR numbers for delta!"!\fItext\fR!M -:C:!Comments for delta!"!\fItext\fR!M -:UN:!User names!User Names!\fItext\fR!M -:FL:!Flag list!Flags!\fItext\fP!M -:Y:!Module type flag!"!\fItext\fR!S -:MF:!MR validation flag!"!yes \fRor\fP no!S -:MP:!MR validation program name!"!\fItext\fR!S -:KF:!Keyword error, warning flag!"!yes \fRor\fP no!S -:KV:!Keyword validation string!"!\fItext\fR!S -:BF:!Branch flag!"!yes \fRor\fP no!S -:J:!Joint edit flag!"!yes \fRor\fP no!S -:LK:!Locked releases!"!:R: .\|.\|.!S -:Q:!User-defined keyword!"!\fItext\fR!S -:M:!Module name!"!\fItext\fR!S -:FB:!Floor boundary!"!:R:!S -:CB:!Ceiling boundary!"!:R:!S -:Ds:!Default SID!"!:I:!S -:ND:!Null delta flag!"!yes \fRor\fP no!S -:FD:!File descriptive text!Comments!\fItext\fR!M -:BD:!Body!Body!\fItext\fR!M -:GB:!Gotten body!"!\fItext\fR!M -:W:!A form of \fIwhat\fP string!N/A!:Z::M:\et:I:!S -:A:!A form of \fIwhat\fP string!N/A!:Z::Y: :M: :I::Z:!S -:Z:!\fIwhat\fP string delimiter!N/A!\fR@(#)\fR!S -:F:!SCCS filename!N/A!\fItext\fR!S -:PN:!SCCS file pathname!N/A!\fItext\fR!S -.TE -.IP * 6 -.BR :Dt: =\c -.BR ":DT: :I: :D: :T: :P: :DS: :DP:" -.IP ** 6 -.BR ":R:.:L:.:B:.:S:" -if the delta is a branch delta (\c -.BR :BF: =\|=\c -.BR yes ) -.br -.BR ":R:.:L:" -if the delta is not a branch delta (\c -.BR :BF: =\|=\c -.BR no ) -.IP *** 6 -The line statistics are capped at 99\|999. For example, if 100\|000 -lines were unchanged in a certain revision, -.BR :Lu: -shall produce the value 99\|999. -.SH STDERR -The standard error shall be used only for diagnostic messages. -.SH "OUTPUT FILES" -None. -.SH "EXTENDED DESCRIPTION" -None. -.SH "EXIT STATUS" -The following exit values shall be returned: -.IP "\00" 6 -Successful completion. -.IP >0 6 -An error occurred. -.SH "CONSEQUENCES OF ERRORS" -Default. -.LP -.IR "The following sections are informative." -.SH "APPLICATION USAGE" -None. -.SH EXAMPLES -.IP " 1." 4 -The following example: -.RS 4 -.sp -.RS 4 -.nf -\fB -prs \(mid "User Names for :F: are:\en:UN:" s.file -.fi \fR -.P -.RE -.P -might write to standard output: -.sp -.RS 4 -.nf -\fB -User Names for s.file are: -xyz -131 -abc -.fi \fR -.P -.RE -.RE -.IP " 2." 4 -The following example: -.RS 4 -.sp -.RS 4 -.nf -\fB -prs \(mid "Delta for pgm :M:: :I: \(mi :D: By :P:" \(mir s.file -.fi \fR -.P -.RE -.P -might write to standard output: -.sp -.RS 4 -.nf -\fB -Delta for pgm main.c: 3.7 \(mi 77/12/01 By cas -.fi \fR -.P -.RE -.RE -.IP " 3." 4 -As a special case: -.RS 4 -.sp -.RS 4 -.nf -\fB -prs s.file -.fi \fR -.P -.RE -.P -might write to standard output: -.sp -.RS 4 -.nf -\fB -s.file: -<\fIblank line\fP> -D 1.1 77/12/01 00:00:00 cas 1 000000/00000/00000 -MRs: -bl78\(mi12345 -bl79\(mi54321 -COMMENTS: -this is the comment line for s.file initial delta -<\fIblank line\fP> -.fi \fR -.P -.RE -.P -for each delta table entry of the -.BR D -type. The only option allowed to be used with this special case is the -.BR \(mia -option. -.RE -.SH RATIONALE -None. -.SH "FUTURE DIRECTIONS" -None. -.SH "SEE ALSO" -.IR "\fIadmin\fR\^", -.IR "\fIdelta\fR\^", -.IR "\fIget\fR\^", -.IR "\fIwhat\fR\^" -.P -The Base Definitions volume of POSIX.1\(hy2008, -.IR "Chapter 8" ", " "Environment Variables", -.IR "Section 12.2" ", " "Utility Syntax Guidelines" -.SH COPYRIGHT -Portions of this text are reprinted and reproduced in electronic form -from IEEE Std 1003.1, 2013 Edition, Standard for Information Technology --- Portable Operating System Interface (POSIX), The Open Group Base -Specifications Issue 7, Copyright (C) 2013 by the Institute of -Electrical and Electronics Engineers, Inc and The Open Group. -(This is POSIX.1-2008 with the 2013 Technical Corrigendum 1 applied.) In the -event of any discrepancy between this version and the original IEEE and -The Open Group Standard, the original IEEE and The Open Group Standard -is the referee document. The original Standard can be obtained online at -http://www.unix.org/online.html . - -Any typographical or formatting errors that appear -in this page are most likely -to have been introduced during the conversion of the source files to -man page format. To report such errors, see -https://www.kernel.org/doc/man-pages/reporting_bugs.html . diff --git a/man-pages-posix-2013-a/man1p/rmdel.1p b/man-pages-posix-2013-a/man1p/rmdel.1p deleted file mode 100644 index 08d0578..0000000 --- a/man-pages-posix-2013-a/man1p/rmdel.1p +++ /dev/null @@ -1,167 +0,0 @@ -'\" et -.TH RMDEL "1P" 2013 "IEEE/The Open Group" "POSIX Programmer's Manual" -.SH PROLOG -This manual page is part of the POSIX Programmer's Manual. -The Linux implementation of this interface may differ (consult -the corresponding Linux manual page for details of Linux behavior), -or the interface may not be implemented on Linux. - -.SH NAME -rmdel -\(em remove a delta from an SCCS file (\fBDEVELOPMENT\fP) -.SH SYNOPSIS -.LP -.nf -rmdel \(mir \fISID file\fR... -.fi -.SH DESCRIPTION -The -.IR rmdel -utility shall remove the delta specified by the SID from each named -SCCS file. The delta to be removed shall be the most recent delta in -its branch in the delta chain of each named SCCS file. In addition, the -application shall ensure that the SID specified is not that of a -version being edited for the purpose of making a delta; that is, if a -.IR p-file -(see -.IR "\fIget\fR\^") -exists for the named SCCS file, the SID specified shall not appear in -any entry of the -.IR p-file . -.P -Removal of a delta shall be restricted to: -.IP " 1." 4 -The user who made the delta -.IP " 2." 4 -The owner of the SCCS file -.IP " 3." 4 -The owner of the directory containing the SCCS file -.SH OPTIONS -The -.IR rmdel -utility shall conform to the Base Definitions volume of POSIX.1\(hy2008, -.IR "Section 12.2" ", " "Utility Syntax Guidelines". -.P -The following option shall be supported: -.IP "\fB\(mir\ \fISID\fR" 10 -Specify the SCCS identification string (\c -.IR SID ) -of the delta to be deleted. -.SH OPERANDS -The following operand shall be supported: -.IP "\fIfile\fR" 10 -A pathname of an existing SCCS file or a directory. If -.IR file -is a directory, the -.IR rmdel -utility shall behave as though each file in the directory were -specified as a named file, except that non-SCCS files (last component -of the pathname does not begin with -.BR s. ) -and unreadable files shall be silently ignored. -.RS 10 -.P -If exactly one -.IR file -operand appears, and it is -.BR '\(mi' , -the standard input shall be read; each line of the standard input is -taken to be the name of an SCCS file to be processed. Non-SCCS files -and unreadable files shall be silently ignored. -.RE -.SH STDIN -The standard input shall be a text file used only when the -.IR file -operand is specified as -.BR '\(mi' . -Each line of the text file shall be interpreted as an SCCS pathname. -.SH "INPUT FILES" -The SCCS files shall be files of unspecified format. -.SH "ENVIRONMENT VARIABLES" -The following environment variables shall affect the execution of -.IR rmdel : -.IP "\fILANG\fP" 10 -Provide a default value for the internationalization variables that are -unset or null. (See the Base Definitions volume of POSIX.1\(hy2008, -.IR "Section 8.2" ", " "Internationalization Variables" -for the precedence of internationalization variables used to determine -the values of locale categories.) -.IP "\fILC_ALL\fP" 10 -If set to a non-empty string value, override the values of all the -other internationalization variables. -.IP "\fILC_CTYPE\fP" 10 -Determine the locale for the interpretation of sequences of bytes of -text data as characters (for example, single-byte as opposed to -multi-byte characters in arguments and input files). -.IP "\fILC_MESSAGES\fP" 10 -.br -Determine the locale that should be used to affect the format and -contents of diagnostic messages written to standard error. -.IP "\fINLSPATH\fP" 10 -Determine the location of message catalogs for the processing of -.IR LC_MESSAGES . -.SH "ASYNCHRONOUS EVENTS" -Default. -.SH STDOUT -Not used. -.SH STDERR -The standard error shall be used only for diagnostic messages. -.SH "OUTPUT FILES" -The SCCS files shall be files of unspecified format. During processing -of a -.IR file , -a temporary -.IR x-file , -as described in -.IR "\fIadmin\fR\^", -may be created and deleted; a locking -.IR z-file , -as described in -.IR "\fIget\fR\^", -may be created and deleted. -.SH "EXTENDED DESCRIPTION" -None. -.SH "EXIT STATUS" -The following exit values shall be returned: -.IP "\00" 6 -Successful completion. -.IP >0 6 -An error occurred. -.SH "CONSEQUENCES OF ERRORS" -Default. -.LP -.IR "The following sections are informative." -.SH "APPLICATION USAGE" -None. -.SH EXAMPLES -None. -.SH RATIONALE -None. -.SH "FUTURE DIRECTIONS" -None. -.SH "SEE ALSO" -.IR "\fIadmin\fR\^", -.IR "\fIdelta\fR\^", -.IR "\fIget\fR\^", -.IR "\fIprs\fR\^" -.P -The Base Definitions volume of POSIX.1\(hy2008, -.IR "Chapter 8" ", " "Environment Variables", -.IR "Section 12.2" ", " "Utility Syntax Guidelines" -.SH COPYRIGHT -Portions of this text are reprinted and reproduced in electronic form -from IEEE Std 1003.1, 2013 Edition, Standard for Information Technology --- Portable Operating System Interface (POSIX), The Open Group Base -Specifications Issue 7, Copyright (C) 2013 by the Institute of -Electrical and Electronics Engineers, Inc and The Open Group. -(This is POSIX.1-2008 with the 2013 Technical Corrigendum 1 applied.) In the -event of any discrepancy between this version and the original IEEE and -The Open Group Standard, the original IEEE and The Open Group Standard -is the referee document. The original Standard can be obtained online at -http://www.unix.org/online.html . - -Any typographical or formatting errors that appear -in this page are most likely -to have been introduced during the conversion of the source files to -man page format. To report such errors, see -https://www.kernel.org/doc/man-pages/reporting_bugs.html . diff --git a/man-pages-posix-2013-a/man1p/sact.1p b/man-pages-posix-2013-a/man1p/sact.1p deleted file mode 100644 index fe3e7b1..0000000 --- a/man-pages-posix-2013-a/man1p/sact.1p +++ /dev/null @@ -1,186 +0,0 @@ -'\" et -.TH SACT "1P" 2013 "IEEE/The Open Group" "POSIX Programmer's Manual" -.SH PROLOG -This manual page is part of the POSIX Programmer's Manual. -The Linux implementation of this interface may differ (consult -the corresponding Linux manual page for details of Linux behavior), -or the interface may not be implemented on Linux. - -.SH NAME -sact -\(em print current SCCS file-editing activity (\fBDEVELOPMENT\fP) -.SH SYNOPSIS -.LP -.nf -sact \fIfile\fR... -.fi -.SH DESCRIPTION -The -.IR sact -utility shall inform the user of any impending deltas to a named SCCS -file by writing a list to standard output. This situation occurs when -.IR get -.BR \(mie -has been executed previously without a subsequent execution of -.IR delta , -.IR unget , -or -.IR sccs -.BR unedit . -.SH OPTIONS -None. -.SH OPERANDS -The following operand shall be supported: -.IP "\fIfile\fR" 10 -A pathname of an existing SCCS file or a directory. If -.IR file -is a directory, the -.IR sact -utility shall behave as though each file in the directory were -specified as a named file, except that non-SCCS files (last component -of the pathname does not begin with -.BR s. ) -and unreadable files shall be silently ignored. -.RS 10 -.P -If exactly one -.IR file -operand appears, and it is -.BR '\(mi' , -the standard input shall be read; each line of the standard input shall -be taken to be the name of an SCCS file to be processed. Non-SCCS files -and unreadable files shall be silently ignored. -.RE -.SH STDIN -The standard input shall be a text file used only when the -.IR file -operand is specified as -.BR '\(mi' . -Each line of the text file shall be interpreted as an SCCS pathname. -.SH "INPUT FILES" -Any SCCS files interrogated are files of an unspecified format. -.SH "ENVIRONMENT VARIABLES" -The following environment variables shall affect the execution of -.IR sact : -.IP "\fILANG\fP" 10 -Provide a default value for the internationalization variables that are -unset or null. (See the Base Definitions volume of POSIX.1\(hy2008, -.IR "Section 8.2" ", " "Internationalization Variables" -for the precedence of internationalization variables used to determine -the values of locale categories.) -.IP "\fILC_ALL\fP" 10 -If set to a non-empty string value, override the values of all the -other internationalization variables. -.IP "\fILC_CTYPE\fP" 10 -Determine the locale for the interpretation of sequences of bytes of -text data as characters (for example, single-byte as opposed to -multi-byte characters in arguments and input files). -.IP "\fILC_MESSAGES\fP" 10 -.br -Determine the locale that should be used to affect the format and -contents of diagnostic messages written to standard error. -.IP "\fINLSPATH\fP" 10 -Determine the location of message catalogs for the processing of -.IR LC_MESSAGES . -.SH "ASYNCHRONOUS EVENTS" -Default. -.SH STDOUT -The output for each named file shall consist of a line in the following -format: -.sp -.RS 4 -.nf -\fB -"%s %s %s %s %s\en", <\fISID\fR>, <\fInew SID\fR>, <\fIlogin\fR>, <\fIdate\fR>, <\fItime\fR> -.fi \fR -.P -.RE -.IP "<\fISID\fR>" 10 -Specifies the SID of a delta that currently exists in the SCCS file to -which changes are made to make the new delta. -.IP "<\fInew\ SID\fR>" 10 -Specifies the SID for the new delta to be created. -.IP "<\fIlogin\fR>" 10 -Contains the login name of the user who makes the delta (that is, who -executed a -.IR get -for editing). -.IP "<\fIdate\fR>" 10 -Contains the date that -.IR get -.BR \(mie -was executed, in the format used by the -.IR prs -.BR :D: -data keyword. -.IP "<\fItime\fR>" 10 -Contains the time that -.IR get -.BR \(mie -was executed, in the format used by the -.IR prs -.BR :T: -data keyword. -.P -If there is more than one named file or if a directory or standard -input is named, each pathname shall be written before each of the -preceding lines: -.sp -.RS 4 -.nf -\fB -"\en%s:\en", <\fIpathname\fR> -.fi \fR -.P -.RE -.SH STDERR -The standard error shall be used only for optional informative -messages concerning SCCS files with no impending deltas, and for -diagnostic messages. -.SH "OUTPUT FILES" -None. -.SH "EXTENDED DESCRIPTION" -None. -.SH "EXIT STATUS" -The following exit values shall be returned: -.IP "\00" 6 -Successful completion. -.IP >0 6 -An error occurred. -.SH "CONSEQUENCES OF ERRORS" -Default. -.LP -.IR "The following sections are informative." -.SH "APPLICATION USAGE" -None. -.SH EXAMPLES -None. -.SH RATIONALE -None. -.SH "FUTURE DIRECTIONS" -None. -.SH "SEE ALSO" -.IR "\fIdelta\fR\^", -.IR "\fIget\fR\^", -.IR "\fIsccs\fR\^", -.IR "\fIunget\fR\^" -.P -The Base Definitions volume of POSIX.1\(hy2008, -.IR "Chapter 8" ", " "Environment Variables" -.SH COPYRIGHT -Portions of this text are reprinted and reproduced in electronic form -from IEEE Std 1003.1, 2013 Edition, Standard for Information Technology --- Portable Operating System Interface (POSIX), The Open Group Base -Specifications Issue 7, Copyright (C) 2013 by the Institute of -Electrical and Electronics Engineers, Inc and The Open Group. -(This is POSIX.1-2008 with the 2013 Technical Corrigendum 1 applied.) In the -event of any discrepancy between this version and the original IEEE and -The Open Group Standard, the original IEEE and The Open Group Standard -is the referee document. The original Standard can be obtained online at -http://www.unix.org/online.html . - -Any typographical or formatting errors that appear -in this page are most likely -to have been introduced during the conversion of the source files to -man page format. To report such errors, see -https://www.kernel.org/doc/man-pages/reporting_bugs.html . diff --git a/man-pages-posix-2013-a/man1p/sccs.1p b/man-pages-posix-2013-a/man1p/sccs.1p deleted file mode 100644 index 765bf08..0000000 --- a/man-pages-posix-2013-a/man1p/sccs.1p +++ /dev/null @@ -1,542 +0,0 @@ -'\" et -.TH SCCS "1P" 2013 "IEEE/The Open Group" "POSIX Programmer's Manual" -.SH PROLOG -This manual page is part of the POSIX Programmer's Manual. -The Linux implementation of this interface may differ (consult -the corresponding Linux manual page for details of Linux behavior), -or the interface may not be implemented on Linux. - -.SH NAME -sccs -\(em front end for the SCCS subsystem (\fBDEVELOPMENT\fP) -.SH SYNOPSIS -.LP -.nf -sccs \fB[\fR\(mir\fB] [\fR\(mid \fIpath\fB] [\fR\(mip \fIpath\fB] \fIcommand \fB[\fIoptions\fR...\fB] [\fIoperands\fR...\fB]\fR -.fi -.SH DESCRIPTION -The -.IR sccs -utility is a front end to the SCCS programs. It also includes the -capability to run set-user-id to another user to provide additional -protection. -.P -The -.IR sccs -utility shall invoke the specified -.IR command -with the specified -.IR options -and -.IR operands . -By default, each of the -.IR operands -shall be modified by prefixing it with the string -.BR \(dqSCCS/s.\(dq . -.P -The -.IR command -can be the name of one of the SCCS utilities in this volume of POSIX.1\(hy2008 (\c -.IR admin , -.IR delta , -.IR get , -.IR prs , -.IR rmdel , -.IR sact , -.IR unget , -.IR val , -or -.IR what ) -or one of the pseudo-utilities listed in the EXTENDED DESCRIPTION -section. -.SH OPTIONS -The -.IR sccs -utility shall conform to the Base Definitions volume of POSIX.1\(hy2008, -.IR "Section 12.2" ", " "Utility Syntax Guidelines", -except that -.IR options -operands are actually options to be passed to the utility named by -.IR command . -When the portion of the command: -.sp -.RS 4 -.nf -\fB -\fIcommand \fB[\fIoptions\fR ... \fB] [\fIoperands\fR ... \fB]\fR -.fi \fR -.P -.RE -.P -is considered, all of the pseudo-utilities used as -.IR command -shall support the Utility Syntax Guidelines. Any of the other SCCS -utilities that can be invoked in this manner support the Guidelines to -the extent indicated by their individual OPTIONS sections. -.P -The following options shall be supported preceding the -.IR command -operand: -.IP "\fB\(mid\ \fIpath\fR" 10 -A pathname of a directory to be used as a root directory for the SCCS -files. The default shall be the current directory. The -.BR \(mid -option shall take precedence over the -.IR PROJECTDIR -variable. See -.BR \(mip . -.IP "\fB\(mip\ \fIpath\fR" 10 -A pathname of a directory in which the SCCS files are located. The -default shall be the -.BR SCCS -directory. -.RS 10 -.P -The -.BR \(mip -option differs from the -.BR \(mid -option in that the -.BR \(mid -option-argument shall be prefixed to the entire pathname and the -.BR \(mip -option-argument shall be inserted before the final component of the -pathname. For example: -.sp -.RS 4 -.nf -\fB -sccs \(mid /x \(mip y get a/b -.fi \fR -.P -.RE -.P -converts to: -.sp -.RS 4 -.nf -\fB -get /x/a/y/s.b -.fi \fR -.P -.RE -.P -This allows the creation of aliases such as: -.sp -.RS 4 -.nf -\fB -alias syssccs="sccs \(mid /usr/src" -.fi \fR -.P -.RE -.P -which is used as: -.sp -.RS 4 -.nf -\fB -syssccs get cmd/who.c -.fi \fR -.P -.RE -.RE -.IP "\fB\(mir\fP" 10 -Invoke -.IR command -with the real user ID of the process, not any effective user ID that -the -.IR sccs -utility is set to. Certain commands (\c -.IR admin , -.BR check , -.BR clean , -.BR diffs , -.BR info , -.IR rmdel , -and -.BR tell ) -cannot be run set-user-ID by all users, since this would allow anyone -to change the authorizations. These commands are always run as the -real user. -.SH OPERANDS -The following operands shall be supported: -.IP "\fIcommand\fR" 10 -An SCCS utility name or the name of one of the pseudo-utilities listed -in the EXTENDED DESCRIPTION section. -.IP "\fIoptions\fR" 10 -An option or option-argument to be passed to -.IR command . -.IP "\fIoperands\fR" 10 -An operand to be passed to -.IR command . -.SH STDIN -See the utility description for the specified -.IR command . -.SH "INPUT FILES" -See the utility description for the specified -.IR command . -.SH "ENVIRONMENT VARIABLES" -The following environment variables shall affect the execution of -.IR sccs : -.IP "\fILANG\fP" 10 -Provide a default value for the internationalization variables that are -unset or null. (See the Base Definitions volume of POSIX.1\(hy2008, -.IR "Section 8.2" ", " "Internationalization Variables" -for the precedence of internationalization variables used to determine -the values of locale categories.) -.IP "\fILC_ALL\fP" 10 -If set to a non-empty string value, override the values of all the -other internationalization variables. -.IP "\fILC_CTYPE\fP" 10 -Determine the locale for the interpretation of sequences of bytes of -text data as characters (for example, single-byte as opposed to -multi-byte characters in arguments and input files). -.IP "\fILC_MESSAGES\fP" 10 -.br -Determine the locale that should be used to affect the format and -contents of diagnostic messages written to standard error. -.IP "\fINLSPATH\fP" 10 -Determine the location of message catalogs for the processing of -.IR LC_MESSAGES . -.IP "\fIPROJECTDIR\fP" 10 -.br -Provide a default value for the -.BR \(mid -.IR path -option. If the value of -.IR PROJECTDIR -begins with a -, -it shall be considered an absolute pathname; otherwise, the value of -.IR PROJECTDIR -is treated as a user name and that user's initial working directory -shall be examined for a subdirectory -.BR src -or -.BR source . -If such a directory is found, it shall be used. Otherwise, the value -shall be used as a relative pathname. -.P -Additional environment variable effects may be found in the utility -description for the specified -.IR command . -.SH "ASYNCHRONOUS EVENTS" -Default. -.SH STDOUT -See the utility description for the specified -.IR command . -.SH STDERR -See the utility description for the specified -.IR command . -.SH "OUTPUT FILES" -See the utility description for the specified -.IR command . -.SH "EXTENDED DESCRIPTION" -The following pseudo-utilities shall be supported as -.IR command -operands. All options referred to in the following list are values -given in the -.IR options -operands following -.IR command . -.IP "\fBcheck\fR" 8 -Equivalent to -.BR info , -except that nothing shall be printed if nothing is being edited, and a -non-zero exit status shall be returned if anything is being edited. The -intent is to have this included in an ``install'' entry in a makefile -to ensure that everything is included into the SCCS file before a -version is installed. -.IP "\fBclean\fR" 8 -Remove everything from the current directory that can be recreated from -SCCS files, but do not remove any files being edited. If the -.BR \(mib -option is given, branches shall be ignored in the determination of -whether they are being edited; this is dangerous if branches are kept -in the same directory. -.IP "\fBcreate\fR" 8 -Create an SCCS file, taking the initial contents from the file of the -same name. Any options to -.IR admin -are accepted. If the creation is successful, the original files shall -be renamed by prefixing the basenames with a comma. These renamed files -should be removed after it has been verified that the SCCS files have -been created successfully. -.IP "\fBdelget\fR" 8 -Perform a -.IR delta -on the named files and then -.IR get -new versions. The new versions shall have ID keywords expanded and -shall not be editable. Any -.BR \(mim , -.BR \(mip , -.BR \(mir , -.BR \(mis , -and -.BR \(miy -options shall be passed to -.IR delta , -and any -.BR \(mib , -.BR \(mic , -.BR \(mie , -.BR \(mii , -.BR \(mik , -.BR \(mil , -.BR \(mis , -and -.BR \(mix -options shall be passed to -.IR get . -.IP "\fBdeledit\fR" 8 -Equivalent to -.BR delget , -except that the -.IR get -phase shall include the -.BR \(mie -option. This option is useful for making a checkpoint of the current -editing phase. The same options shall be passed to -.IR delta -as described above, and all the options listed for -.IR get -above except -.BR \(mie -shall be passed to -.BR edit . -.IP "\fBdiffs\fR" 8 -Write a difference listing between the current version of the files -checked out for editing and the versions in SCCS format. Any -.BR \(mir , -.BR \(mic , -.BR \(mii , -.BR \(mix , -and -.BR \(mit -options shall be passed to -.IR get ; -any -.BR \(mil , -.BR \(mis , -.BR \(mie , -.BR \(mif , -.BR \(mih , -and -.BR \(mib -options shall be passed to -.IR diff . -A -.BR \(miC -option shall be passed to -.IR diff -as -.BR \(mic . -.IP "\fBedit\fR" 8 -Equivalent to -.IR get -.BR \(mie . -.IP "\fBfix\fR" 8 -Remove the named delta, but leave a copy of the delta with the changes -that were in it. It is useful for fixing small compiler bugs, and so -on. The application shall ensure that it is followed by a -.BR \(mir -.IR SID -option. Since -.BR fix -does not leave audit trails, it should be used carefully. -.IP "\fBinfo\fR" 8 -Write a listing of all files being edited. If the -.BR \(mib -option is given, branches (that is, SIDs with two or fewer components) -shall be ignored. If a -.BR \(miu -.IR user -option is given, then only files being edited by the named user shall -be listed. A -.BR \(miU -option shall be equivalent to -.BR \(miu <\c -.IR "current\ user" >. -.IP "\fBprint\fR" 8 -Write out verbose information about the named files, equivalent to -.IR sccs -.IR prs . -.IP "\fBtell\fR" 8 -Write a --separated -list of the files being edited to standard output. Takes the -.BR \(mib , -.BR \(miu , -and -.BR \(miU -options like -.BR info -and -.BR check . -.IP "\fBunedit\fR" 8 -This is the opposite of an -.BR edit -or a -.IR get -.BR \(mie . -It should be used with caution, since any changes made since the -.IR get -are lost. -.br -.SH "EXIT STATUS" -The following exit values shall be returned: -.IP "\00" 6 -Successful completion. -.IP >0 6 -An error occurred. -.SH "CONSEQUENCES OF ERRORS" -Default. -.LP -.IR "The following sections are informative." -.SH "APPLICATION USAGE" -Many of the SCCS utilities take directory names as operands as well as -specific filenames. The pseudo-utilities supported by -.IR sccs -are not described as having this capability, but are not prohibited -from doing so. -.SH EXAMPLES -.IP " 1." 4 -To get a file for editing, edit it and produce a new delta: -.RS 4 -.sp -.RS 4 -.nf -\fB -sccs get \(mie file.c -ex file.c -sccs delta file.c -.fi \fR -.P -.RE -.RE -.IP " 2." 4 -To get a file from another directory: -.RS 4 -.sp -.RS 4 -.nf -\fB -sccs \(mip /usr/src/sccs/s. get cc.c -.fi \fR -.P -.RE -.P -or: -.sp -.RS 4 -.nf -\fB -sccs get /usr/src/sccs/s.cc.c -.fi \fR -.P -.RE -.RE -.IP " 3." 4 -To make a delta of a large number of files in the current directory: -.RS 4 -.sp -.RS 4 -.nf -\fB -sccs delta *.c -.fi \fR -.P -.RE -.RE -.IP " 4." 4 -To get a list of files being edited that are not on branches: -.RS 4 -.sp -.RS 4 -.nf -\fB -sccs info \(mib -.fi \fR -.P -.RE -.RE -.IP " 5." 4 -To delta everything being edited by the current user: -.RS 4 -.sp -.RS 4 -.nf -\fB -sccs delta $(sccs tell \(miU) -.fi \fR -.P -.RE -.RE -.IP " 6." 4 -In a makefile, to get source files from an SCCS file if it does not -already exist: -.RS 4 -.sp -.RS 4 -.nf -\fB -SRCS = <\fIlist of source files\fP> -$(SRCS): - sccs get $(REL) $@ -.fi \fR -.P -.RE -.RE -.SH RATIONALE -.IR sccs -and its associated utilities are part of the XSI Development -Utilities option within the XSI option. -.P -SCCS is an abbreviation for Source Code Control System. It is a -maintenance and enhancement tracking tool. When a file is put under -SCCS, the source code control system maintains the file and, when -changes are made, identifies and stores them in the file with the -original source code and/or documentation. As other changes are made, -they too are identified and retained in the file. -.P -Retrieval of the original and any set of changes is possible. Any -version of the file as it develops can be reconstructed for inspection -or additional modification. History data can be stored with each -version, documenting why the changes were made, who made them, and when -they were made. -.SH "FUTURE DIRECTIONS" -None. -.SH "SEE ALSO" -.IR "\fIadmin\fR\^", -.IR "\fIdelta\fR\^", -.IR "\fIget\fR\^", -.IR "\fImake\fR\^", -.IR "\fIprs\fR\^", -.IR "\fIrmdel\fR\^", -.IR "\fIsact\fR\^", -.IR "\fIunget\fR\^", -.IR "\fIval\fR\^", -.IR "\fIwhat\fR\^" -.P -The Base Definitions volume of POSIX.1\(hy2008, -.IR "Chapter 8" ", " "Environment Variables", -.IR "Section 12.2" ", " "Utility Syntax Guidelines" -.SH COPYRIGHT -Portions of this text are reprinted and reproduced in electronic form -from IEEE Std 1003.1, 2013 Edition, Standard for Information Technology --- Portable Operating System Interface (POSIX), The Open Group Base -Specifications Issue 7, Copyright (C) 2013 by the Institute of -Electrical and Electronics Engineers, Inc and The Open Group. -(This is POSIX.1-2008 with the 2013 Technical Corrigendum 1 applied.) In the -event of any discrepancy between this version and the original IEEE and -The Open Group Standard, the original IEEE and The Open Group Standard -is the referee document. The original Standard can be obtained online at -http://www.unix.org/online.html . - -Any typographical or formatting errors that appear -in this page are most likely -to have been introduced during the conversion of the source files to -man page format. To report such errors, see -https://www.kernel.org/doc/man-pages/reporting_bugs.html . diff --git a/man-pages-posix-2013-a/man1p/unget.1p b/man-pages-posix-2013-a/man1p/unget.1p deleted file mode 100644 index 7a0a579..0000000 --- a/man-pages-posix-2013-a/man1p/unget.1p +++ /dev/null @@ -1,189 +0,0 @@ -'\" et -.TH UNGET "1P" 2013 "IEEE/The Open Group" "POSIX Programmer's Manual" -.SH PROLOG -This manual page is part of the POSIX Programmer's Manual. -The Linux implementation of this interface may differ (consult -the corresponding Linux manual page for details of Linux behavior), -or the interface may not be implemented on Linux. - -.SH NAME -unget -\(em undo a previous get of an SCCS file (\fBDEVELOPMENT\fP) -.SH SYNOPSIS -.LP -.nf -unget \fB[\fR\(mins\fB] [\fR\(mir \fISID\fB] \fIfile\fR... -.fi -.SH DESCRIPTION -The -.IR unget -utility shall reverse the effect of a -.IR get -.BR \(mie -done prior to creating the intended new delta. -.SH OPTIONS -The -.IR unget -utility shall conform to the Base Definitions volume of POSIX.1\(hy2008, -.IR "Section 12.2" ", " "Utility Syntax Guidelines". -.P -The following options shall be supported: -.IP "\fB\(mir\ \fISID\fR" 10 -Uniquely identify which delta is no longer intended. (This would have -been specified by -.IR get -as the new delta.) The use of this option is necessary only if two or -more outstanding -.IR get -commands for editing on the same SCCS file were done by the same person -(login name). -.IP "\fB\(mis\fP" 10 -Suppress the writing to standard output of the intended delta's SID. -.IP "\fB\(min\fP" 10 -Retain the file that was obtained by -.IR get , -which would normally be removed from the current directory. -.SH OPERANDS -The following operands shall be supported: -.IP "\fIfile\fR" 10 -A pathname of an existing SCCS file or a directory. If -.IR file -is a directory, the -.IR unget -utility shall behave as though each file in the directory were specified as a named -file, except that non-SCCS files (last component of the pathname does -not begin with -.BR s. ) -and unreadable files shall be silently ignored. -.RS 10 -.P -If exactly one -.IR file -operand appears, and it is -.BR '\(mi' , -the standard input shall be read; each line of the standard input shall -be taken to be the name of an SCCS file to be processed. Non-SCCS files -and unreadable files shall be silently ignored. -.RE -.SH STDIN -The standard input shall be a text file used only when the -.IR file -operand is specified as -.BR '\(mi' . -Each line of the text file shall be interpreted as an SCCS pathname. -.SH "INPUT FILES" -Any SCCS files processed shall be files of an unspecified format. -.SH "ENVIRONMENT VARIABLES" -The following environment variables shall affect the execution of -.IR unget : -.IP "\fILANG\fP" 10 -Provide a default value for the internationalization variables that are -unset or null. (See the Base Definitions volume of POSIX.1\(hy2008, -.IR "Section 8.2" ", " "Internationalization Variables" -for the precedence of internationalization variables used to determine -the values of locale categories.) -.IP "\fILC_ALL\fP" 10 -If set to a non-empty string value, override the values of all the -other internationalization variables. -.IP "\fILC_CTYPE\fP" 10 -Determine the locale for the interpretation of sequences of bytes of -text data as characters (for example, single-byte as opposed to -multi-byte characters in arguments and input files). -.IP "\fILC_MESSAGES\fP" 10 -.br -Determine the locale that should be used to affect the format and -contents of diagnostic messages written to standard error. -.IP "\fINLSPATH\fP" 10 -Determine the location of message catalogs for the processing of -.IR LC_MESSAGES . -.SH "ASYNCHRONOUS EVENTS" -Default. -.SH STDOUT -The standard output shall consist of a line for each file, in the -following format: -.sp -.RS 4 -.nf -\fB -"%s\en", <\fISID removed from file\fR> -.fi \fR -.P -.RE -.P -If there is more than one named file or if a directory or standard -input is named, each pathname shall be written before each of the -preceding lines: -.sp -.RS 4 -.nf -\fB -"\en%s:\en", <\fIpathname\fR> -.fi \fR -.P -.RE -.SH STDERR -The standard error shall be used only for diagnostic messages. -.SH "OUTPUT FILES" -Any SCCS files updated shall be files of an unspecified format. -During processing of a -.IR file , -a locking -.IR z-file , -as described in -.IR get , -and a -.IR q-file -(a working copy of the -.IR p-file ), -may be created and deleted. The -.IR p-file -and -.IR g-file , -as described in -.IR get , -shall be deleted. -.SH "EXTENDED DESCRIPTION" -None. -.SH "EXIT STATUS" -The following exit values shall be returned: -.IP "\00" 6 -Successful completion. -.IP >0 6 -An error occurred. -.SH "CONSEQUENCES OF ERRORS" -Default. -.LP -.IR "The following sections are informative." -.SH "APPLICATION USAGE" -None. -.SH EXAMPLES -None. -.SH RATIONALE -None. -.SH "FUTURE DIRECTIONS" -None. -.SH "SEE ALSO" -.IR "\fIdelta\fR\^", -.IR "\fIget\fR\^", -.IR "\fIsact\fR\^" -.P -The Base Definitions volume of POSIX.1\(hy2008, -.IR "Chapter 8" ", " "Environment Variables", -.IR "Section 12.2" ", " "Utility Syntax Guidelines" -.SH COPYRIGHT -Portions of this text are reprinted and reproduced in electronic form -from IEEE Std 1003.1, 2013 Edition, Standard for Information Technology --- Portable Operating System Interface (POSIX), The Open Group Base -Specifications Issue 7, Copyright (C) 2013 by the Institute of -Electrical and Electronics Engineers, Inc and The Open Group. -(This is POSIX.1-2008 with the 2013 Technical Corrigendum 1 applied.) In the -event of any discrepancy between this version and the original IEEE and -The Open Group Standard, the original IEEE and The Open Group Standard -is the referee document. The original Standard can be obtained online at -http://www.unix.org/online.html . - -Any typographical or formatting errors that appear -in this page are most likely -to have been introduced during the conversion of the source files to -man page format. To report such errors, see -https://www.kernel.org/doc/man-pages/reporting_bugs.html . diff --git a/man-pages-posix-2013-a/man1p/val.1p b/man-pages-posix-2013-a/man1p/val.1p deleted file mode 100644 index 0a83f4d..0000000 --- a/man-pages-posix-2013-a/man1p/val.1p +++ /dev/null @@ -1,248 +0,0 @@ -'\" et -.TH VAL "1P" 2013 "IEEE/The Open Group" "POSIX Programmer's Manual" -.SH PROLOG -This manual page is part of the POSIX Programmer's Manual. -The Linux implementation of this interface may differ (consult -the corresponding Linux manual page for details of Linux behavior), -or the interface may not be implemented on Linux. - -.SH NAME -val -\(em validate SCCS files (\fBDEVELOPMENT\fP) -.SH SYNOPSIS -.LP -.nf -val \(mi -.P -val \fB[\fR\(mis\fB] [\fR\(mim \fIname\fB] [\fR\(mir \fISID\fB] [\fR\(miy \fItype\fB] \fIfile\fR... -.fi -.SH DESCRIPTION -The -.IR val -utility shall determine whether the specified -.IR file -is an SCCS file meeting the characteristics specified by the options. -.SH OPTIONS -The -.IR val -utility shall conform to the Base Definitions volume of POSIX.1\(hy2008, -.IR "Section 12.2" ", " "Utility Syntax Guidelines", -except that the usage of the -.BR '\(mi' -operand is not strictly as intended by the guidelines (that is, reading -options and operands from standard input). -.P -The following options shall be supported: -.IP "\fB\(mim\ \fIname\fR" 10 -Specify a -.IR name , -which is compared with the SCCS %\fBM\fP% keyword in -.IR file ; -see -.IR "\fIget\fR\^". -.IP "\fB\(mir\ \fISID\fR" 10 -Specify a -.IR SID -(SCCS Identification String), an SCCS delta number. A check shall be -made to determine whether the -.IR SID -is ambiguous (for example, -.BR "\(mir\ 1" -is ambiguous because it physically does not exist but implies 1.1, 1.2, -and so on, which may exist) or invalid (for example, -.BR "\(mir\ 1.0" -or -.BR "\(mir\ 1.1.0" -are invalid because neither case can exist as a valid delta number). -If the -.IR SID -is valid and not ambiguous, a check shall be made to determine whether -it actually exists. -.IP "\fB\(mis\fP" 10 -Silence the diagnostic message normally written to standard output for -any error that is detected while processing each named file on a given -command line. -.IP "\fB\(miy\ \fItype\fR" 10 -Specify a -.IR type , -which shall be compared with the SCCS %\fBY\fP% keyword in -.IR file ; -see -.IR "\fIget\fR\^". -.SH OPERANDS -The following operands shall be supported: -.IP "\fIfile\fR" 10 -A pathname of an existing SCCS file. If exactly one -.IR file -operand appears, and it is -.BR '\(mi' , -the standard input shall be read: each line shall be independently -processed as if it were a command line argument list. (However, the -line is not subjected to any of the shell word expansions, such as -parameter expansion or quote removal.) -.SH STDIN -The standard input shall be a text file used only when the -.IR file -operand is specified as -.BR '\(mi' . -.SH "INPUT FILES" -Any SCCS files processed shall be files of an unspecified format. -.SH "ENVIRONMENT VARIABLES" -The following environment variables shall affect the execution of -.IR val : -.IP "\fILANG\fP" 10 -Provide a default value for the internationalization variables that are -unset or null. (See the Base Definitions volume of POSIX.1\(hy2008, -.IR "Section 8.2" ", " "Internationalization Variables" -for the precedence of internationalization variables used to determine -the values of locale categories.) -.IP "\fILC_ALL\fP" 10 -If set to a non-empty string value, override the values of all the -other internationalization variables. -.IP "\fILC_CTYPE\fP" 10 -Determine the locale for the interpretation of sequences of bytes of -text data as characters (for example, single-byte as opposed to -multi-byte characters in arguments and input files). -.IP "\fILC_MESSAGES\fP" 10 -.br -Determine the locale that should be used to affect the format and -contents of diagnostic messages written to standard error, and -informative messages written to standard output. -.IP "\fINLSPATH\fP" 10 -Determine the location of message catalogs for the processing of -.IR LC_MESSAGES . -.SH "ASYNCHRONOUS EVENTS" -Default. -.SH STDOUT -The standard output shall consist of informative messages about either: -.IP " 1." 4 -Each file processed -.IP " 2." 4 -Each command line read from standard input -.P -If the standard input is not used, for each -.IR file -operand yielding a discrepancy, the output line shall have the -following format: -.sp -.RS 4 -.nf -\fB -"%s: %s\en", <\fIpathname\fR>, <\fIunspecified string\fR> -.fi \fR -.P -.RE -.P -If the standard input is used, for each input line yielding a discrepancy, -the output shall have the following format: -.sp -.RS 4 -.nf -\fB -"%s\en\en %s: %s\en", <\fIinput\fR>, <\fIpathname\fR>, <\fIunspecified string\fR> -.fi \fR -.P -.RE -.P -where <\fIinput\fP> is the input line minus its terminating -. -.SH STDERR -Not used. -.SH "OUTPUT FILES" -None. -.SH "EXTENDED DESCRIPTION" -None. -.SH "EXIT STATUS" -The 8-bit code returned by -.IR val -shall be a disjunction of the possible errors; that is, it can be -interpreted as a bit string where set bits are interpreted as follows: -.TS -tab(@); -l c l. -0x80@\&=@Missing file argument. -0x40@\&=@Unknown or duplicate option. -0x20@\&=@Corrupted SCCS file. -0x10@\&=@Cannot open file or file not SCCS. -0x08@\&=@\fISID\fR is invalid or ambiguous. -0x04@\&=@\fISID\fR does not exist. -0x02@\&=@%\fBY\fR%, \fB\(miy\fR mismatch. -0x01@\&=@%\fBM\fR%, \fB\(mim\fR mismatch. -.TE -.P -Note that -.IR val -can process two or more files on a given command line and can process -multiple command lines (when reading the standard input). In these -cases an aggregate code shall be returned: a logical OR of the codes -generated for each command line and file processed. -.SH "CONSEQUENCES OF ERRORS" -Default. -.LP -.IR "The following sections are informative." -.SH "APPLICATION USAGE" -Since the -.IR val -exit status sets the 0x80 bit, shell applications checking -.BR \(dq$?\(dq -cannot tell if it terminated due to a missing file argument or receipt -of a signal. -.SH EXAMPLES -In a directory with three SCCS files\(em\c -.BR s.x -(of -.BR t -type ``text''), -.BR s.y , -and -.BR s.z -(a corrupted file)\(emthe following command could produce the output -shown: -.sp -.RS 4 -.nf -\fB -val \(mi < newline \e NUL -.fi \fR -.P -.RE -.SH OPTIONS -The -.IR what -utility shall conform to the Base Definitions volume of POSIX.1\(hy2008, -.IR "Section 12.2" ", " "Utility Syntax Guidelines". -.P -The following option shall be supported: -.IP "\fB\(mis\fP" 10 -Quit after finding the first occurrence of the pattern in each file. -.SH OPERANDS -The following operands shall be supported: -.IP "\fIfile\fR" 10 -A pathname of a file to search. -.SH STDIN -Not used. -.SH "INPUT FILES" -The input files shall be of any file type. -.SH "ENVIRONMENT VARIABLES" -The following environment variables shall affect the execution of -.IR what : -.IP "\fILANG\fP" 10 -Provide a default value for the internationalization variables that are -unset or null. (See the Base Definitions volume of POSIX.1\(hy2008, -.IR "Section 8.2" ", " "Internationalization Variables" -for the precedence of internationalization variables used to determine -the values of locale categories.) -.IP "\fILC_ALL\fP" 10 -If set to a non-empty string value, override the values of all the -other internationalization variables. -.IP "\fILC_CTYPE\fP" 10 -Determine the locale for the interpretation of sequences of bytes of -text data as characters (for example, single-byte as opposed to -multi-byte characters in arguments and input files). -.IP "\fILC_MESSAGES\fP" 10 -.br -Determine the locale that should be used to affect the format and -contents of diagnostic messages written to standard error. -.IP "\fINLSPATH\fP" 10 -Determine the location of message catalogs for the processing of -.IR LC_MESSAGES . -.SH "ASYNCHRONOUS EVENTS" -Default. -.SH STDOUT -The standard output shall consist of the following for each -.IR file -operand: -.sp -.RS 4 -.nf -\fB -"%s:\en\et%s\en", <\fIpathname\fR>, <\fIidentification string\fR> -.fi \fR -.P -.RE -.SH STDERR -The standard error shall be used only for diagnostic messages. -.SH "OUTPUT FILES" -None. -.SH "EXTENDED DESCRIPTION" -None. -.SH "EXIT STATUS" -The following exit values shall be returned: -.IP 0 6 -Any matches were found. -.IP 1 6 -Otherwise. -.SH "CONSEQUENCES OF ERRORS" -Default. -.LP -.IR "The following sections are informative." -.SH "APPLICATION USAGE" -The -.IR what -utility is intended to be used in conjunction with the SCCS command -.IR get , -which automatically inserts identifying information, but it can also be -used where the information is inserted by any other means. -.P -When the string -.BR \(dq@(#)\(dq -is included in a library routine in a shared library, it might not be -found in an -.BR a.out -file using that library routine. -.SH EXAMPLES -If the C-language program in file -.BR f.c -contains: -.sp -.RS 4 -.nf -\fB -char ident[] = "@(#)identification information"; -.fi \fR -.P -.RE -.P -and -.BR f.c -is compiled to yield -.BR f.o -and -.BR a.out , -then the command: -.sp -.RS 4 -.nf -\fB -what f.c f.o a.out -.fi \fR -.P -.RE -.P -writes: -.sp -.RS 4 -.nf -\fB -f.c: - identification information - ... -f.o: - identification information - ... -a.out: - identification information - ... -.fi \fR -.P -.RE -.SH RATIONALE -None. -.SH "FUTURE DIRECTIONS" -None. -.SH "SEE ALSO" -.IR "\fIget\fR\^" -.P -The Base Definitions volume of POSIX.1\(hy2008, -.IR "Chapter 8" ", " "Environment Variables", -.IR "Section 12.2" ", " "Utility Syntax Guidelines" -.SH COPYRIGHT -Portions of this text are reprinted and reproduced in electronic form -from IEEE Std 1003.1, 2013 Edition, Standard for Information Technology --- Portable Operating System Interface (POSIX), The Open Group Base -Specifications Issue 7, Copyright (C) 2013 by the Institute of -Electrical and Electronics Engineers, Inc and The Open Group. -(This is POSIX.1-2008 with the 2013 Technical Corrigendum 1 applied.) In the -event of any discrepancy between this version and the original IEEE and -The Open Group Standard, the original IEEE and The Open Group Standard -is the referee document. The original Standard can be obtained online at -http://www.unix.org/online.html . - -Any typographical or formatting errors that appear -in this page are most likely -to have been introduced during the conversion of the source files to -man page format. To report such errors, see -https://www.kernel.org/doc/man-pages/reporting_bugs.html . diff --git a/man2/pciconfig_iobase.2 b/man2/pciconfig_iobase.2 deleted file mode 100644 index 5ab2995..0000000 --- a/man2/pciconfig_iobase.2 +++ /dev/null @@ -1 +0,0 @@ -.so man2/pciconfig_read.2 diff --git a/man2/pciconfig_read.2 b/man2/pciconfig_read.2 deleted file mode 100644 index 176cf0e..0000000 --- a/man2/pciconfig_read.2 +++ /dev/null @@ -1,124 +0,0 @@ -.\" Contributed by Niki A. Rahimi, LTC Security Development -.\" narahimi@us.ibm.com -.\" -.\" %%%LICENSE_START(FREELY_REDISTRIBUTABLE) -.\" May be freely distributed and modified. -.\" %%%LICENSE_END -.\" -.TH PCICONFIG_READ 2 2016-07-17 "Linux" "Linux Programmer's Manual" -.SH NAME -pciconfig_read, pciconfig_write, pciconfig_iobase \- pci device information handling -.SH SYNOPSIS -.nf -.B #include -.PP -.BI "int pciconfig_read(unsigned long " bus ", unsigned long " dfn , -.BI " unsigned long " off ", unsigned long " len ", void *" buf ); -.BI "int pciconfig_write(unsigned long " bus ", unsigned long " dfn , -.BI " unsigned long " off ", unsigned long " len ", void *" buf ); -.BI "int pciconfig_iobase(long " which ", unsigned long " bus , -.BI " unsigned long " devfn ); -.fi -.SH DESCRIPTION -.PP -Most of the interaction with PCI devices is already handled by the -kernel PCI layer, -and thus these calls should not normally need to be accessed from user space. -.TP -.BR pciconfig_read () -Reads to -.I buf -from device -.I dev -at offset -.I off -value. -.TP -.BR pciconfig_write () -Writes from -.I buf -to device -.I dev -at offset -.I off -value. -.TP -.BR pciconfig_iobase () -You pass it a bus/devfn pair and get a physical address for either the -memory offset (for things like prep, this is 0xc0000000), -the IO base for PIO cycles, or the ISA holes if any. -.SH RETURN VALUE -.TP -.BR pciconfig_read () -On success, zero is returned. -On error, \-1 is returned and -.I errno -is set appropriately. -.TP -.BR pciconfig_write () -On success, zero is returned. -On error, \-1 is returned and -.I errno -is set appropriately. -.TP -.BR pciconfig_iobase () -Returns information on locations of various I/O -regions in physical memory according to the -.I which -value. -Values for -.I which -are: -.BR IOBASE_BRIDGE_NUMBER , -.BR IOBASE_MEMORY , -.BR IOBASE_IO , -.BR IOBASE_ISA_IO , -.BR IOBASE_ISA_MEM . -.SH ERRORS -.TP -.B EINVAL -.I len -value is invalid. -This does not apply to -.BR pciconfig_iobase (). -.TP -.B EIO -I/O error. -.TP -.B ENODEV -For -.BR pciconfig_iobase (), -"hose" value is NULL. -For the other calls, could not find a slot. -.TP -.B ENOSYS -The system has not implemented these calls -.RB ( CONFIG_PCI -not defined). -.TP -.B EOPNOTSUPP -This return value is valid only for -.BR pciconfig_iobase (). -It is returned if the value for -.I which -is invalid. -.TP -.B EPERM -User does not have the -.B CAP_SYS_ADMIN -capability. -This does not apply to -.BR pciconfig_iobase (). -.SH CONFORMING TO -These calls are Linux-specific, available since Linux 2.0.26/2.1.11. -.SH SEE ALSO -.BR capabilities (7) -.SH COLOPHON -This page is part of release 4.15 of the Linux -.I man-pages -project. -A description of the project, -information about reporting bugs, -and the latest version of this page, -can be found at -\%https://www.kernel.org/doc/man\-pages/. diff --git a/man2/pciconfig_write.2 b/man2/pciconfig_write.2 deleted file mode 100644 index 5ab2995..0000000 --- a/man2/pciconfig_write.2 +++ /dev/null @@ -1 +0,0 @@ -.so man2/pciconfig_read.2 diff --git a/man3/btree.3 b/man3/btree.3 deleted file mode 100644 index 66c7bea..0000000 --- a/man3/btree.3 +++ /dev/null @@ -1,263 +0,0 @@ -.\" Copyright (c) 1990, 1993 -.\" The Regents of the University of California. All rights reserved. -.\" -.\" %%%LICENSE_START(BSD_4_CLAUSE_UCB) -.\" Redistribution and use in source and binary forms, with or without -.\" modification, are permitted provided that the following conditions -.\" are met: -.\" 1. Redistributions of source code must retain the above copyright -.\" notice, this list of conditions and the following disclaimer. -.\" 2. Redistributions in binary form must reproduce the above copyright -.\" notice, this list of conditions and the following disclaimer in the -.\" documentation and/or other materials provided with the distribution. -.\" 3. All advertising materials mentioning features or use of this software -.\" must display the following acknowledgement: -.\" This product includes software developed by the University of -.\" California, Berkeley and its contributors. -.\" 4. Neither the name of the University nor the names of its contributors -.\" may be used to endorse or promote products derived from this software -.\" without specific prior written permission. -.\" -.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND -.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE -.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE -.\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE -.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL -.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS -.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) -.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT -.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY -.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF -.\" SUCH DAMAGE. -.\" %%%LICENSE_END -.\" -.\" @(#)btree.3 8.4 (Berkeley) 8/18/94 -.\" -.TH BTREE 3 2017-09-15 "" "Linux Programmer's Manual" -.\".UC 7 -.SH NAME -btree \- btree database access method -.SH SYNOPSIS -.nf -.ft B -#include -#include -.ft R -.fi -.SH DESCRIPTION -.IR "Note well" : -This page documents interfaces provided in glibc up until version 2.1. -Since version 2.2, glibc no longer provides these interfaces. -Probably, you are looking for the APIs provided by the -.I libdb -library instead. -.PP -The routine -.BR dbopen (3) -is the library interface to database files. -One of the supported file formats is btree files. -The general description of the database access methods is in -.BR dbopen (3), -this manual page describes only the btree-specific information. -.PP -The btree data structure is a sorted, balanced tree structure storing -associated key/data pairs. -.PP -The btree access-method-specific data structure provided to -.BR dbopen (3) -is defined in the -.I -include file as follows: -.PP -.in +4n -.EX -typedef struct { - unsigned long flags; - unsigned int cachesize; - int maxkeypage; - int minkeypage; - unsigned int psize; - int (*compare)(const DBT *key1, const DBT *key2); - size_t (*prefix)(const DBT *key1, const DBT *key2); - int lorder; -} BTREEINFO; -.EE -.in -.PP -The elements of this structure are as follows: -.TP -.I flags -The flag value is specified by ORing any of the following values: -.RS -.TP -.B R_DUP -Permit duplicate keys in the tree, that is, -permit insertion if the key to be -inserted already exists in the tree. -The default behavior, as described in -.BR dbopen (3), -is to overwrite a matching key when inserting a new key or to fail if -the -.B R_NOOVERWRITE -flag is specified. -The -.B R_DUP -flag is overridden by the -.B R_NOOVERWRITE -flag, and if the -.B R_NOOVERWRITE -flag is specified, attempts to insert duplicate keys into -the tree will fail. -.IP -If the database contains duplicate keys, the order of retrieval of -key/data pairs is undefined if the -.I get -routine is used, however, -.I seq -routine calls with the -.B R_CURSOR -flag set will always return the logical -"first" of any group of duplicate keys. -.RE -.TP -.I cachesize -A suggested maximum size (in bytes) of the memory cache. -This value is -.I only -advisory, and the access method will allocate more memory rather than fail. -Since every search examines the root page of the tree, caching the most -recently used pages substantially improves access time. -In addition, physical writes are delayed as long as possible, so a moderate -cache can reduce the number of I/O operations significantly. -Obviously, using a cache increases (but only increases) the likelihood of -corruption or lost data if the system crashes while a tree is being modified. -If -.I cachesize -is 0 (no size is specified), a default cache is used. -.TP -.I maxkeypage -The maximum number of keys which will be stored on any single page. -Not currently implemented. -.\" The maximum number of keys which will be stored on any single page. -.\" Because of the way the btree data structure works, -.\" .I maxkeypage -.\" must always be greater than or equal to 2. -.\" If -.\" .I maxkeypage -.\" is 0 (no maximum number of keys is specified), the page fill factor is -.\" made as large as possible (which is almost invariably what is wanted). -.TP -.I minkeypage -The minimum number of keys which will be stored on any single page. -This value is used to determine which keys will be stored on overflow -pages, that is, if a key or data item is longer than the pagesize divided -by the minkeypage value, it will be stored on overflow pages instead -of in the page itself. -If -.I minkeypage -is 0 (no minimum number of keys is specified), a value of 2 is used. -.TP -.I psize -Page size is the size (in bytes) of the pages used for nodes in the tree. -The minimum page size is 512 bytes and the maximum page size is 64\ KiB. -If -.I psize -is 0 (no page size is specified), a page size is chosen based on the -underlying filesystem I/O block size. -.TP -.I compare -Compare is the key comparison function. -It must return an integer less than, equal to, or greater than zero if the -first key argument is considered to be respectively less than, equal to, -or greater than the second key argument. -The same comparison function must be used on a given tree every time it -is opened. -If -.I compare -is NULL (no comparison function is specified), the keys are compared -lexically, with shorter keys considered less than longer keys. -.TP -.I prefix -Prefix is the prefix comparison function. -If specified, this routine must return the number of bytes of the second key -argument which are necessary to determine that it is greater than the first -key argument. -If the keys are equal, the key length should be returned. -Note, the usefulness of this routine is very data-dependent, but, in some -data sets can produce significantly reduced tree sizes and search times. -If -.I prefix -is NULL (no prefix function is specified), -.I and -no comparison function is specified, a default lexical comparison routine -is used. -If -.I prefix -is NULL and a comparison routine is specified, no prefix comparison is -done. -.TP -.I lorder -The byte order for integers in the stored database metadata. -The number should represent the order as an integer; for example, -big endian order would be the number 4,321. -If -.I lorder -is 0 (no order is specified), the current host order is used. -.PP -If the file already exists (and the -.B O_TRUNC -flag is not specified), the -values specified for the arguments -.IR flags , -.I lorder -and -.I psize -are ignored -in favor of the values used when the tree was created. -.PP -Forward sequential scans of a tree are from the least key to the greatest. -.PP -Space freed up by deleting key/data pairs from the tree is never reclaimed, -although it is normally made available for reuse. -This means that the btree storage structure is grow-only. -The only solutions are to avoid excessive deletions, or to create a fresh -tree periodically from a scan of an existing one. -.PP -Searches, insertions, and deletions in a btree will all complete in -O lg base N where base is the average fill factor. -Often, inserting ordered data into btrees results in a low fill factor. -This implementation has been modified to make ordered insertion the best -case, resulting in a much better than normal page fill factor. -.SH ERRORS -The -.I btree -access method routines may fail and set -.I errno -for any of the errors specified for the library routine -.BR dbopen (3). -.SH BUGS -Only big and little endian byte order is supported. -.SH SEE ALSO -.BR dbopen (3), -.BR hash (3), -.BR mpool (3), -.BR recno (3) -.PP -.IR "The Ubiquitous B-tree" , -Douglas Comer, ACM Comput. Surv. 11, 2 (June 1979), 121-138. -.PP -.IR "Prefix B-trees" , -Bayer and Unterauer, ACM Transactions on Database Systems, Vol. 2, 1 -(March 1977), 11-26. -.PP -.IR "The Art of Computer Programming Vol. 3: Sorting and Searching" , -D.E. Knuth, 1968, pp 471-480. -.SH COLOPHON -This page is part of release 4.15 of the Linux -.I man-pages -project. -A description of the project, -information about reporting bugs, -and the latest version of this page, -can be found at -\%https://www.kernel.org/doc/man\-pages/. diff --git a/man3/crypt.3 b/man3/crypt.3 deleted file mode 100644 index c742b0c..0000000 --- a/man3/crypt.3 +++ /dev/null @@ -1,289 +0,0 @@ -.\" Michael Haardt (michael@cantor.informatik.rwth.aachen.de) -.\" Sat Sep 3 22:00:30 MET DST 1994 -.\" -.\" %%%LICENSE_START(GPLv2+_DOC_FULL) -.\" This is free documentation; 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 2 of -.\" the License, or (at your option) any later version. -.\" -.\" The GNU General Public License's references to "object code" -.\" and "executables" are to be interpreted as the output of any -.\" document formatting or typesetting system, including -.\" intermediate and printed output. -.\" -.\" This manual 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 this manual; if not, see -.\" . -.\" %%%LICENSE_END -.\" -.\" Sun Feb 19 21:32:25 1995, faith@cs.unc.edu edited details away -.\" -.\" TO DO: This manual page should go more into detail how DES is perturbed, -.\" which string will be encrypted, and what determines the repetition factor. -.\" Is a simple repetition using ECB used, or something more advanced? I hope -.\" the presented explanations are at least better than nothing, but by no -.\" means enough. -.\" -.\" added _XOPEN_SOURCE, aeb, 970705 -.\" added GNU MD5 stuff, aeb, 011223 -.\" -.TH CRYPT 3 2017-09-15 "" "Linux Programmer's Manual" -.SH NAME -crypt, crypt_r \- password and data encryption -.SH SYNOPSIS -.nf -.BR "#define _XOPEN_SOURCE" " /* See feature_test_macros(7) */" -.B #include -.PP -.BI "char *crypt(const char *" key ", const char *" salt ); - -.BR "#define _GNU_SOURCE" " /* See feature_test_macros(7) */" -.B #include -.PP -.BI "char *crypt_r(const char *" key ", const char *" salt , -.BI " struct crypt_data *" data ); -.fi -.PP -Link with \fI\-lcrypt\fP. -.SH DESCRIPTION -.BR crypt () -is the password encryption function. -It is based on the Data Encryption -Standard algorithm with variations intended (among other things) to -discourage use of hardware implementations of a key search. -.PP -.I key -is a user's typed password. -.PP -.I salt -is a two-character string chosen from the set -[\fBa\-zA\-Z0\-9./\fP]. -This string is used to -perturb the algorithm in one of 4096 different ways. -.PP -By taking the lowest 7 bits of each of the first eight characters of the -.IR key , -a 56-bit key is obtained. -This 56-bit key is used to encrypt repeatedly a -constant string (usually a string consisting of all zeros). -The returned -value points to the encrypted password, a series of 13 printable ASCII -characters (the first two characters represent the salt itself). -The return value points to static data whose content is -overwritten by each call. -.PP -Warning: the key space consists of -.if t 2\s-2\u56\s0\d -.if n 2**56 -equal 7.2e16 possible values. -Exhaustive searches of this key space are -possible using massively parallel computers. -Software, such as -.BR crack (1), -is available which will search the portion of this key space that is -generally used by humans for passwords. -Hence, password selection should, -at minimum, avoid common words and names. -The use of a -.BR passwd (1) -program that checks for crackable passwords during the selection process is -recommended. -.PP -The DES algorithm itself has a few quirks which make the use of the -.BR crypt () -interface a very poor choice for anything other than password -authentication. -If you are planning on using the -.BR crypt () -interface for a cryptography project, don't do it: get a good book on -encryption and one of the widely available DES libraries. -.PP -.BR crypt_r () -is a reentrant version of -.BR crypt (). -The structure pointed to by -.I data -is used to store result data and bookkeeping information. -Other than allocating it, -the only thing that the caller should do with this structure is to set -.I data->initialized -to zero before the first call to -.BR crypt_r (). -.SH RETURN VALUE -On success, a pointer to the encrypted password is returned. -On error, NULL is returned. -.SH ERRORS -.TP -.B EINVAL -.I salt -has the wrong format. -.TP -.B ENOSYS -The -.BR crypt () -function was not implemented, probably because of U.S.A. export restrictions. -.\" This level of detail is not necessary in this man page. . . -.\" .PP -.\" When encrypting a plain text P using DES with the key K results in the -.\" encrypted text C, then the complementary plain text P' being encrypted -.\" using the complementary key K' will result in the complementary encrypted -.\" text C'. -.\" .PP -.\" Weak keys are keys which stay invariant under the DES key transformation. -.\" The four known weak keys 0101010101010101, fefefefefefefefe, -.\" 1f1f1f1f0e0e0e0e and e0e0e0e0f1f1f1f1 must be avoided. -.\" .PP -.\" There are six known half weak key pairs, which keys lead to the same -.\" encrypted data. Keys which are part of such key clusters should be -.\" avoided. -.\" Sorry, I could not find out what they are. -.\"" -.\" .PP -.\" Heavily redundant data causes trouble with DES encryption, when used in the -.\" .I codebook -.\" mode that -.\" .BR crypt () -.\" implements. The -.\" .BR crypt () -.\" interface should be used only for its intended purpose of password -.\" verification, and should not be used as part of a data encryption tool. -.\" .PP -.\" The first and last three output bits of the fourth S-box can be -.\" represented as function of their input bits. Empiric studies have -.\" shown that S-boxes partially compute the same output for similar input. -.\" It is suspected that this may contain a back door which could allow the -.\" NSA to decrypt DES encrypted data. -.\" .PP -.\" Making encrypted data computed using crypt() publicly available has -.\" to be considered insecure for the given reasons. -.TP -.B EPERM -.I /proc/sys/crypto/fips_enabled -has a nonzero value, -and an attempt was made to use a weak encryption type, such as DES. -.SH ATTRIBUTES -For an explanation of the terms used in this section, see -.BR attributes (7). -.TS -allbox; -lb lb lb -l l l. -Interface Attribute Value -T{ -.BR crypt () -T} Thread safety MT-Unsafe race:crypt -T{ -.BR crypt_r () -T} Thread safety MT-Safe -.TE -.SH CONFORMING TO -.BR crypt (): -POSIX.1-2001, POSIX.1-2008, SVr4, 4.3BSD. -.BR crypt_r () -is a GNU extension. -.SH NOTES -.SS Glibc notes -The glibc2 version of this function supports additional -encryption algorithms. -.PP -If -.I salt -is a character string starting with the characters "$\fIid\fP$" -followed by a string optionally terminated by "$", -then the result has the form: -.RS -.PP -$\fIid\fP$\fIsalt\fP$\fIencrypted\fP -.PP -.RE -.I id -identifies the encryption method used instead of DES and this then determines how the rest -of the password string is interpreted. -The following values of -.I id -are supported: -.RS -.TS -l l. -ID | Method -_ -1 | MD5 -2a | Blowfish (not in mainline glibc; added in some - | Linux distributions) -.\" openSUSE has Blowfish, but AFAICS, this option is not supported -.\" natively by glibc -- mtk, Jul 08 -.\" -.\" md5 | Sun MD5 -.\" glibc doesn't appear to natively support Sun MD5; I don't know -.\" if any distros add the support. -5 | SHA-256 (since glibc 2.7) -6 | SHA-512 (since glibc 2.7) -.TE -.RE -.PP -Thus, $5$\fIsalt\fP$\fIencrypted\fP and $6$\fIsalt\fP$\fIencrypted\fP -contain the password encrypted with, respectively, functions -based on SHA-256 and SHA-512. -.PP -"\fIsalt\fP" stands for the up to 16 characters -following "$\fIid\fP$" in the salt. -The "\fIencrypted\fP" -part of the password string is the actual computed password. -The size of this string is fixed: -.TS -l l. -MD5 | 22 characters -SHA-256 | 43 characters -SHA-512 | 86 characters -.TE -.sp 1 -The characters in "\fIsalt\fP" and "\fIencrypted\fP" are drawn from the set -[\fBa\-zA\-Z0\-9./\fP]. -In the MD5 and SHA implementations the entire -.I key -is significant (instead of only the first -8 bytes in DES). -.PP -Since glibc 2.7, -.\" glibc commit 9425cb9eea6a62fc21d99aafe8a60f752b934b05 -the SHA-256 and SHA-512 implementations support a user-supplied number of -hashing rounds, defaulting to 5000. -If the "$\fIid\fP$" characters in the salt are -followed by "rounds=\fIxxx\fP$", where \fIxxx\fP is an integer, then the -result has the form -.RS -.PP -$\fIid\fP$\fIrounds=yyy\fP$\fIsalt\fP$\fIencrypted\fP -.PP -.RE -where \fIyyy\fP is the number of hashing rounds actually used. -The number of rounds actually used is 1000 if -.I xxx -is less than -1000, 999999999 if -.I xxx -is greater than 999999999, and -is equal to -.I xxx -otherwise. -.SH SEE ALSO -.BR login (1), -.BR passwd (1), -.BR encrypt (3), -.BR getpass (3), -.BR passwd (5) -.SH COLOPHON -This page is part of release 4.15 of the Linux -.I man-pages -project. -A description of the project, -information about reporting bugs, -and the latest version of this page, -can be found at -\%https://www.kernel.org/doc/man\-pages/. diff --git a/man3/crypt_r.3 b/man3/crypt_r.3 deleted file mode 100644 index 3944ebd..0000000 --- a/man3/crypt_r.3 +++ /dev/null @@ -1 +0,0 @@ -.so man3/crypt.3 diff --git a/man3/db.3 b/man3/db.3 deleted file mode 100644 index 03ede66..0000000 --- a/man3/db.3 +++ /dev/null @@ -1 +0,0 @@ -.so man3/dbopen.3 diff --git a/man3/dbopen.3 b/man3/dbopen.3 deleted file mode 100644 index bad6045..0000000 --- a/man3/dbopen.3 +++ /dev/null @@ -1,570 +0,0 @@ -.\" Copyright (c) 1990, 1993 -.\" The Regents of the University of California. All rights reserved. -.\" -.\" %%%LICENSE_START(BSD_4_CLAUSE_UCB) -.\" Redistribution and use in source and binary forms, with or without -.\" modification, are permitted provided that the following conditions -.\" are met: -.\" 1. Redistributions of source code must retain the above copyright -.\" notice, this list of conditions and the following disclaimer. -.\" 2. Redistributions in binary form must reproduce the above copyright -.\" notice, this list of conditions and the following disclaimer in the -.\" documentation and/or other materials provided with the distribution. -.\" 3. All advertising materials mentioning features or use of this software -.\" must display the following acknowledgement: -.\" This product includes software developed by the University of -.\" California, Berkeley and its contributors. -.\" 4. Neither the name of the University nor the names of its contributors -.\" may be used to endorse or promote products derived from this software -.\" without specific prior written permission. -.\" -.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND -.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE -.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE -.\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE -.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL -.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS -.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) -.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT -.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY -.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF -.\" SUCH DAMAGE. -.\" %%%LICENSE_END -.\" -.\" @(#)dbopen.3 8.5 (Berkeley) 1/2/94 -.\" -.TH DBOPEN 3 2017-09-15 "" "Linux Programmer's Manual" -.UC 7 -.SH NAME -dbopen \- database access methods -.SH SYNOPSIS -.nf -.B #include -.B #include -.B #include -.B #include -.PP -.BI "DB *dbopen(const char *" file ", int " flags ", int " mode \ -", DBTYPE " type , -.BI " const void *" openinfo ); -.fi -.SH DESCRIPTION -.IR "Note well" : -This page documents interfaces provided in glibc up until version 2.1. -Since version 2.2, glibc no longer provides these interfaces. -Probably, you are looking for the APIs provided by the -.I libdb -library instead. -.PP -.BR dbopen () -is the library interface to database files. -The supported file formats are btree, hashed and UNIX file oriented. -The btree format is a representation of a sorted, balanced tree structure. -The hashed format is an extensible, dynamic hashing scheme. -The flat-file format is a byte stream file with fixed or variable length -records. -The formats and file-format-specific information are described in detail -in their respective manual pages -.BR btree (3), -.BR hash (3), -and -.BR recno (3). -.PP -.BR dbopen () -opens -.I file -for reading and/or writing. -Files never intended to be preserved on disk may be created by setting -the -.I file -argument to NULL. -.PP -The -.I flags -and -.I mode -arguments are as specified to the -.BR open (2) -routine, however, only the -.BR O_CREAT , -.BR O_EXCL , -.BR O_EXLOCK , -.BR O_NONBLOCK , -.BR O_RDONLY , -.BR O_RDWR , -.BR O_SHLOCK , -and -.B O_TRUNC -flags are meaningful. -(Note, opening a database file -.B O_WRONLY -is not possible.) -.\"Three additional options may be specified by ORing -.\"them into the -.\".I flags -.\"argument. -.\".TP -.\"DB_LOCK -.\"Do the necessary locking in the database to support concurrent access. -.\"If concurrent access isn't needed or the database is read-only this -.\"flag should not be set, as it tends to have an associated performance -.\"penalty. -.\".TP -.\"DB_SHMEM -.\"Place the underlying memory pool used by the database in shared -.\"memory. -.\"Necessary for concurrent access. -.\".TP -.\"DB_TXN -.\"Support transactions in the database. -.\"The DB_LOCK and DB_SHMEM flags must be set as well. -.PP -The -.I type -argument is of type -.I DBTYPE -(as defined in the -.I -include file) and -may be set to -.BR DB_BTREE , -.BR DB_HASH , -or -.BR DB_RECNO . -.PP -The -.I openinfo -argument is a pointer to an access-method-specific structure described -in the access method's manual page. -If -.I openinfo -is NULL, each access method will use defaults appropriate for the system -and the access method. -.PP -.BR dbopen () -returns a pointer to a -.I DB -structure on success and NULL on error. -The -.I DB -structure is defined in the -.I -include file, and contains at -least the following fields: -.PP -.in +4n -.EX -typedef struct { - DBTYPE type; - int (*close)(const DB *db); - int (*del)(const DB *db, const DBT *key, unsigned int flags); - int (*fd)(const DB *db); - int (*get)(const DB *db, DBT *key, DBT *data, - unsigned int flags); - int (*put)(const DB *db, DBT *key, const DBT *data, - unsigned int flags); - int (*sync)(const DB *db, unsigned int flags); - int (*seq)(const DB *db, DBT *key, DBT *data, - unsigned int flags); -} DB; -.EE -.in -.PP -These elements describe a database type and a set of functions performing -various actions. -These functions take a pointer to a structure as returned by -.BR dbopen (), -and sometimes one or more pointers to key/data structures and a flag value. -.TP -.I type -The type of the underlying access method (and file format). -.TP -.I close -A pointer to a routine to flush any cached information to disk, free any -allocated resources, and close the underlying file(s). -Since key/data pairs may be cached in memory, failing to sync the file -with a -.I close -or -.I sync -function may result in inconsistent or lost information. -.I close -routines return \-1 on error (setting -.IR errno ) -and 0 on success. -.TP -.I del -A pointer to a routine to remove key/data pairs from the database. -.IP -The argument -.I flag -may be set to the following value: -.RS -.TP -.B R_CURSOR -Delete the record referenced by the cursor. -The cursor must have previously been initialized. -.RE -.IP -.I delete -routines return \-1 on error (setting -.IR errno ), -0 on success, and 1 if the specified -.I key -was not in the file. -.TP -.I fd -A pointer to a routine which returns a file descriptor representative -of the underlying database. -A file descriptor referencing the same file will be returned to all -processes which call -.BR dbopen () -with the same -.I file -name. -This file descriptor may be safely used as an argument to the -.BR fcntl (2) -and -.BR flock (2) -locking functions. -The file descriptor is not necessarily associated with any of the -underlying files used by the access method. -No file descriptor is available for in memory databases. -.I fd -routines return \-1 on error (setting -.IR errno ), -and the file descriptor on success. -.TP -.I get -A pointer to a routine which is the interface for keyed retrieval from -the database. -The address and length of the data associated with the specified -.I key -are returned in the structure referenced by -.IR data . -.I get -routines return \-1 on error (setting -.IR errno ), -0 on success, and 1 if the -.I key -was not in the file. -.TP -.I put -A pointer to a routine to store key/data pairs in the database. -.IP -The argument -.I flag -may be set to one of the following values: -.RS -.TP -.B R_CURSOR -Replace the key/data pair referenced by the cursor. -The cursor must have previously been initialized. -.TP -.B R_IAFTER -Append the data immediately after the data referenced by -.IR key , -creating a new key/data pair. -The record number of the appended key/data pair is returned in the -.I key -structure. -(Applicable only to the -.B DB_RECNO -access method.) -.TP -.B R_IBEFORE -Insert the data immediately before the data referenced by -.IR key , -creating a new key/data pair. -The record number of the inserted key/data pair is returned in the -.I key -structure. -(Applicable only to the -.B DB_RECNO -access method.) -.TP -.B R_NOOVERWRITE -Enter the new key/data pair only if the key does not previously exist. -.TP -.B R_SETCURSOR -Store the key/data pair, setting or initializing the position of the -cursor to reference it. -(Applicable only to the -.B DB_BTREE -and -.B DB_RECNO -access methods.) -.RE -.IP -.B R_SETCURSOR -is available only for the -.B DB_BTREE -and -.B DB_RECNO -access -methods because it implies that the keys have an inherent order -which does not change. -.IP -.B R_IAFTER -and -.B R_IBEFORE -are available only for the -.B DB_RECNO -access method because they each imply that the access method is able to -create new keys. -This is true only if the keys are ordered and independent, record numbers -for example. -.IP -The default behavior of the -.I put -routines is to enter the new key/data pair, replacing any previously -existing key. -.IP -.I put -routines return \-1 on error (setting -.IR errno ), -0 on success, and 1 if the -.B R_NOOVERWRITE -.I flag -was set and the key already exists in the file. -.TP -.I seq -A pointer to a routine which is the interface for sequential -retrieval from the database. -The address and length of the key are returned in the structure -referenced by -.IR key , -and the address and length of the data are returned in the -structure referenced -by -.IR data . -.IP -Sequential key/data pair retrieval may begin at any time, and the -position of the "cursor" is not affected by calls to the -.IR del , -.IR get , -.IR put , -or -.I sync -routines. -Modifications to the database during a sequential scan will be reflected -in the scan, that is, -records inserted behind the cursor will not be returned -while records inserted in front of the cursor will be returned. -.IP -The flag value -.B must -be set to one of the following values: -.RS -.TP -.B R_CURSOR -The data associated with the specified key is returned. -This differs from the -.I get -routines in that it sets or initializes the cursor to the location of -the key as well. -(Note, for the -.B DB_BTREE -access method, the returned key is not necessarily an -exact match for the specified key. -The returned key is the smallest key greater than or equal to the specified -key, permitting partial key matches and range searches.) -.TP -.B R_FIRST -The first key/data pair of the database is returned, and the cursor -is set or initialized to reference it. -.TP -.B R_LAST -The last key/data pair of the database is returned, and the cursor -is set or initialized to reference it. -(Applicable only to the -.B DB_BTREE -and -.B DB_RECNO -access methods.) -.TP -.B R_NEXT -Retrieve the key/data pair immediately after the cursor. -If the cursor is not yet set, this is the same as the -.B R_FIRST -flag. -.TP -.B R_PREV -Retrieve the key/data pair immediately before the cursor. -If the cursor is not yet set, this is the same as the -.B R_LAST -flag. -(Applicable only to the -.B DB_BTREE -and -.B DB_RECNO -access methods.) -.RE -.IP -.B R_LAST -and -.B R_PREV -are available only for the -.B DB_BTREE -and -.B DB_RECNO -access methods because they each imply that the keys have an inherent -order which does not change. -.IP -.I seq -routines return \-1 on error (setting -.IR errno ), -0 on success and 1 if there are no key/data pairs less than or greater -than the specified or current key. -If the -.B DB_RECNO -access method is being used, and if the database file -is a character special file and no complete key/data pairs are currently -available, the -.I seq -routines return 2. -.TP -.I sync -A pointer to a routine to flush any cached information to disk. -If the database is in memory only, the -.I sync -routine has no effect and will always succeed. -.IP -The flag value may be set to the following value: -.RS -.TP -.B R_RECNOSYNC -If the -.B DB_RECNO -access method is being used, this flag causes -the sync routine to apply to the btree file which underlies the -recno file, not the recno file itself. -(See the -.I bfname -field of the -.BR recno (3) -manual page for more information.) -.RE -.IP -.I sync -routines return \-1 on error (setting -.IR errno ) -and 0 on success. -.SS Key/data pairs -Access to all file types is based on key/data pairs. -Both keys and data are represented by the following data structure: -.PP -.in +4n -.EX -typedef struct { - void *data; - size_t size; -} DBT; -.EE -.in -.PP -The elements of the -.I DBT -structure are defined as follows: -.TP -.I data -A pointer to a byte string. -.TP -.I size -The length of the byte string. -.PP -Key and data byte strings may reference strings of essentially unlimited -length although any two of them must fit into available memory at the same -time. -It should be noted that the access methods provide no guarantees about -byte string alignment. -.SH ERRORS -The -.BR dbopen () -routine may fail and set -.I errno -for any of the errors specified for the library routines -.BR open (2) -and -.BR malloc (3) -or the following: -.TP -.B EFTYPE -A file is incorrectly formatted. -.TP -.B EINVAL -A parameter has been specified (hash function, pad byte, etc.) that is -incompatible with the current file specification or which is not -meaningful for the function (for example, use of the cursor without -prior initialization) or there is a mismatch between the version -number of file and the software. -.PP -The -.I close -routines may fail and set -.I errno -for any of the errors specified for the library routines -.BR close (2), -.BR read (2), -.BR write (2), -.BR free (3), -or -.BR fsync (2). -.PP -The -.IR del , -.IR get , -.IR put , -and -.I seq -routines may fail and set -.I errno -for any of the errors specified for the library routines -.BR read (2), -.BR write (2), -.BR free (3) -or -.BR malloc (3). -.PP -The -.I fd -routines will fail and set -.I errno -to -.B ENOENT -for in memory databases. -.PP -The -.I sync -routines may fail and set -.I errno -for any of the errors specified for the library routine -.BR fsync (2). -.SH BUGS -The typedef -.I DBT -is a mnemonic for "data base thang", and was used -because no one could think of a reasonable name that wasn't already used. -.PP -The file descriptor interface is a kludge and will be deleted in a -future version of the interface. -.PP -None of the access methods provide any form of concurrent access, -locking, or transactions. -.SH SEE ALSO -.BR btree (3), -.BR hash (3), -.BR mpool (3), -.BR recno (3) -.PP -.IR "LIBTP: Portable, Modular Transactions for UNIX" , -Margo Seltzer, Michael Olson, USENIX proceedings, Winter 1992. -.SH COLOPHON -This page is part of release 4.15 of the Linux -.I man-pages -project. -A description of the project, -information about reporting bugs, -and the latest version of this page, -can be found at -\%https://www.kernel.org/doc/man\-pages/. diff --git a/man3/hash.3 b/man3/hash.3 deleted file mode 100644 index 5f08bca..0000000 --- a/man3/hash.3 +++ /dev/null @@ -1,179 +0,0 @@ -.\" Copyright (c) 1990, 1993 -.\" The Regents of the University of California. All rights reserved. -.\" -.\" %%%LICENSE_START(BSD_4_CLAUSE_UCB) -.\" Redistribution and use in source and binary forms, with or without -.\" modification, are permitted provided that the following conditions -.\" are met: -.\" 1. Redistributions of source code must retain the above copyright -.\" notice, this list of conditions and the following disclaimer. -.\" 2. Redistributions in binary form must reproduce the above copyright -.\" notice, this list of conditions and the following disclaimer in the -.\" documentation and/or other materials provided with the distribution. -.\" 3. All advertising materials mentioning features or use of this software -.\" must display the following acknowledgement: -.\" This product includes software developed by the University of -.\" California, Berkeley and its contributors. -.\" 4. Neither the name of the University nor the names of its contributors -.\" may be used to endorse or promote products derived from this software -.\" without specific prior written permission. -.\" -.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND -.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE -.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE -.\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE -.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL -.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS -.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) -.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT -.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY -.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF -.\" SUCH DAMAGE. -.\" %%%LICENSE_END -.\" -.\" @(#)hash.3 8.6 (Berkeley) 8/18/94 -.\" -.TH HASH 3 2017-09-15 "" "Linux Programmer's Manual" -.UC 7 -.SH NAME -hash \- hash database access method -.SH SYNOPSIS -.nf -.ft B -#include -#include -.ft R -.fi -.SH DESCRIPTION -.IR "Note well" : -This page documents interfaces provided in glibc up until version 2.1. -Since version 2.2, glibc no longer provides these interfaces. -Probably, you are looking for the APIs provided by the -.I libdb -library instead. -.PP -The routine -.BR dbopen (3) -is the library interface to database files. -One of the supported file formats is hash files. -The general description of the database access methods is in -.BR dbopen (3), -this manual page describes only the hash-specific information. -.PP -The hash data structure is an extensible, dynamic hashing scheme. -.PP -The access-method-specific data structure provided to -.BR dbopen (3) -is defined in the -.I -include file as follows: -.PP -.in +4n -.EX -typedef struct { - unsigned int bsize; - unsigned int ffactor; - unsigned int nelem; - unsigned int cachesize; - uint32_t (*hash)(const void *, size_t); - int lorder; -} HASHINFO; -.EE -.in -.PP -The elements of this structure are as follows: -.TP 10 -.I bsize -defines the hash table bucket size, and is, by default, 256 bytes. -It may be preferable to increase the page size for disk-resident tables -and tables with large data items. -.TP -.I ffactor -indicates a desired density within the hash table. -It is an approximation of the number of keys allowed to accumulate in any -one bucket, determining when the hash table grows or shrinks. -The default value is 8. -.TP -.I nelem -is an estimate of the final size of the hash table. -If not set or set too low, hash tables will expand gracefully as keys -are entered, although a slight performance degradation may be noticed. -The default value is 1. -.TP -.I cachesize -is the suggested maximum size, in bytes, of the memory cache. -This value is -.IR "only advisory" , -and the access method will allocate more memory rather than fail. -.TP -.I hash -is a user-defined hash function. -Since no hash function performs equally well on all possible data, the -user may find that the built-in hash function does poorly on a particular -data set. -A user-specified hash functions must take two arguments (a pointer to a byte -string and a length) and return a 32-bit quantity to be used as the hash -value. -.TP -.I lorder -is the byte order for integers in the stored database metadata. -The number should represent the order as an integer; for example, -big endian order would be the number 4,321. -If -.I lorder -is 0 (no order is specified), the current host order is used. -If the file already exists, the specified value is ignored and the -value specified when the tree was created is used. -.PP -If the file already exists (and the -.B O_TRUNC -flag is not specified), the -values specified for -.IR bsize , -.IR ffactor , -.IR lorder , -and -.I nelem -are -ignored and the values specified when the tree was created are used. -.PP -If a hash function is specified, -.I hash_open -attempts to determine if the hash function specified is the same as -the one with which the database was created, and fails if it is not. -.PP -Backward-compatible interfaces to the routines described in -.BR dbm (3), -and -.BR ndbm (3) -are provided, however these interfaces are not compatible with -previous file formats. -.SH ERRORS -The -.I hash -access method routines may fail and set -.I errno -for any of the errors specified for the library routine -.BR dbopen (3). -.SH BUGS -Only big and little endian byte order are supported. -.SH SEE ALSO -.BR btree (3), -.BR dbopen (3), -.BR mpool (3), -.BR recno (3) -.PP -.IR "Dynamic Hash Tables" , -Per-Ake Larson, Communications of the ACM, April 1988. -.PP -.IR "A New Hash Package for UNIX" , -Margo Seltzer, USENIX Proceedings, Winter 1991. -.SH COLOPHON -This page is part of release 4.15 of the Linux -.I man-pages -project. -A description of the project, -information about reporting bugs, -and the latest version of this page, -can be found at -\%https://www.kernel.org/doc/man\-pages/. diff --git a/man3/mpool.3 b/man3/mpool.3 deleted file mode 100644 index fa76ef9..0000000 --- a/man3/mpool.3 +++ /dev/null @@ -1,243 +0,0 @@ -.\" Copyright (c) 1990, 1993 -.\" The Regents of the University of California. All rights reserved. -.\" -.\" %%%LICENSE_START(BSD_4_CLAUSE_UCB) -.\" Redistribution and use in source and binary forms, with or without -.\" modification, are permitted provided that the following conditions -.\" are met: -.\" 1. Redistributions of source code must retain the above copyright -.\" notice, this list of conditions and the following disclaimer. -.\" 2. Redistributions in binary form must reproduce the above copyright -.\" notice, this list of conditions and the following disclaimer in the -.\" documentation and/or other materials provided with the distribution. -.\" 3. All advertising materials mentioning features or use of this software -.\" must display the following acknowledgement: -.\" This product includes software developed by the University of -.\" California, Berkeley and its contributors. -.\" 4. Neither the name of the University nor the names of its contributors -.\" may be used to endorse or promote products derived from this software -.\" without specific prior written permission. -.\" -.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND -.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE -.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE -.\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE -.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL -.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS -.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) -.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT -.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY -.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF -.\" SUCH DAMAGE. -.\" %%%LICENSE_END -.\" -.\" @(#)mpool.3 8.1 (Berkeley) 6/4/93 -.\" -.TH MPOOL 3 2017-09-15 "" "Linux Programmer's Manual" -.UC 7 -.SH NAME -mpool \- shared memory buffer pool -.SH SYNOPSIS -.nf -.B #include -.B #include -.PP -.BI "MPOOL *mpool_open(DBT *" key ", int " fd ", pgno_t " pagesize \ -", pgno_t " maxcache ); -.PP -.BI "void mpool_filter(MPOOL *" mp ", void (*pgin)(void *, pgno_t, void *)," -.BI " void (*" pgout ")(void *, pgno_t, void *)," -.BI " void *" pgcookie ); -.PP -.BI "void *mpool_new(MPOOL *" mp ", pgno_t *" pgnoaddr ); -.PP -.BI "void *mpool_get(MPOOL *" mp ", pgno_t " pgno ", unsigned int " flags ); -.PP -.BI "int mpool_put(MPOOL *" mp ", void *" pgaddr ", unsigned int " flags ); -.PP -.BI "int mpool_sync(MPOOL *" mp ); -.PP -.BI "int mpool_close(MPOOL *" mp ); -.fi -.SH DESCRIPTION -.IR "Note well" : -This page documents interfaces provided in glibc up until version 2.1. -Since version 2.2, glibc no longer provides these interfaces. -Probably, you are looking for the APIs provided by the -.I libdb -library instead. -.PP -.I Mpool -is the library interface intended to provide page oriented buffer management -of files. -The buffers may be shared between processes. -.PP -The function -.BR mpool_open () -initializes a memory pool. -The -.I key -argument is the byte string used to negotiate between multiple -processes wishing to share buffers. -If the file buffers are mapped in shared memory, all processes using -the same key will share the buffers. -If -.I key -is NULL, the buffers are mapped into private memory. -The -.I fd -argument is a file descriptor for the underlying file, which must be seekable. -If -.I key -is non-NULL and matches a file already being mapped, the -.I fd -argument is ignored. -.PP -The -.I pagesize -argument is the size, in bytes, of the pages into which the file is broken up. -The -.I maxcache -argument is the maximum number of pages from the underlying file to cache -at any one time. -This value is not relative to the number of processes which share a file's -buffers, but will be the largest value specified by any of the processes -sharing the file. -.PP -The -.BR mpool_filter () -function is intended to make transparent input and output processing of the -pages possible. -If the -.I pgin -function is specified, it is called each time a buffer is read into the memory -pool from the backing file. -If the -.I pgout -function is specified, it is called each time a buffer is written into the -backing file. -Both functions are called with the -.I pgcookie -pointer, the page number and a pointer to the page to being read or written. -.PP -The function -.BR mpool_new () -takes an -.I MPOOL -pointer and an address as arguments. -If a new page can be allocated, a pointer to the page is returned and -the page number is stored into the -.I pgnoaddr -address. -Otherwise, NULL is returned and -.I errno -is set. -.PP -The function -.BR mpool_get () -takes an -.I MPOOL -pointer and a page number as arguments. -If the page exists, a pointer to the page is returned. -Otherwise, NULL is returned and -.I errno -is set. -The -.I flags -argument is not currently used. -.PP -The function -.BR mpool_put () -unpins the page referenced by -.IR pgaddr . -.I pgaddr -must be an address previously returned by -.BR mpool_get () -or -.BR mpool_new (). -The flag value is specified by ORing -any of the following values: -.TP -.B MPOOL_DIRTY -The page has been modified and needs to be written to the backing file. -.PP -.BR mpool_put () -returns 0 on success and \-1 if an error occurs. -.PP -The function -.BR mpool_sync () -writes all modified pages associated with the -.I MPOOL -pointer to the -backing file. -.BR mpool_sync () -returns 0 on success and \-1 if an error occurs. -.PP -The -.BR mpool_close () -function free's up any allocated memory associated with the memory pool -cookie. -Modified pages are -.B not -written to the backing file. -.BR mpool_close () -returns 0 on success and \-1 if an error occurs. -.SH ERRORS -The -.BR mpool_open () -function may fail and set -.I errno -for any of the errors specified for the library routine -.BR malloc (3). -.PP -The -.BR mpool_get () -function may fail and set -.I errno -for the following: -.TP 15 -.B EINVAL -The requested record doesn't exist. -.PP -The -.BR mpool_new () -and -.BR mpool_get () -functions may fail and set -.I errno -for any of the errors specified for the library routines -.BR read (2), -.BR write (2), -and -.BR malloc (3). -.PP -The -.BR mpool_sync () -function may fail and set -.I errno -for any of the errors specified for the library routine -.BR write (2). -.PP -The -.BR mpool_close () -function may fail and set -.I errno -for any of the errors specified for the library routine -.BR free (3). -.SH CONFORMING TO -Not in POSIX.1. -Present on the BSDs. -.SH SEE ALSO -.BR btree (3), -.BR dbopen (3), -.BR hash (3), -.BR recno (3) -.SH COLOPHON -This page is part of release 4.15 of the Linux -.I man-pages -project. -A description of the project, -information about reporting bugs, -and the latest version of this page, -can be found at -\%https://www.kernel.org/doc/man\-pages/. diff --git a/man3/recno.3 b/man3/recno.3 deleted file mode 100644 index 680ffb5..0000000 --- a/man3/recno.3 +++ /dev/null @@ -1,241 +0,0 @@ -.\" Copyright (c) 1990, 1993 -.\" The Regents of the University of California. All rights reserved. -.\" -.\" %%%LICENSE_START(BSD_4_CLAUSE_UCB) -.\" Redistribution and use in source and binary forms, with or without -.\" modification, are permitted provided that the following conditions -.\" are met: -.\" 1. Redistributions of source code must retain the above copyright -.\" notice, this list of conditions and the following disclaimer. -.\" 2. Redistributions in binary form must reproduce the above copyright -.\" notice, this list of conditions and the following disclaimer in the -.\" documentation and/or other materials provided with the distribution. -.\" 3. All advertising materials mentioning features or use of this software -.\" must display the following acknowledgement: -.\" This product includes software developed by the University of -.\" California, Berkeley and its contributors. -.\" 4. Neither the name of the University nor the names of its contributors -.\" may be used to endorse or promote products derived from this software -.\" without specific prior written permission. -.\" -.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND -.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE -.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE -.\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE -.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL -.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS -.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) -.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT -.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY -.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF -.\" SUCH DAMAGE. -.\" %%%LICENSE_END -.\" -.\" @(#)recno.3 8.5 (Berkeley) 8/18/94 -.\" -.TH RECNO 3 2017-09-15 "" "Linux Programmer's Manual" -.UC 7 -.SH NAME -recno \- record number database access method -.SH SYNOPSIS -.nf -.ft B -#include -#include -.ft R -.fi -.SH DESCRIPTION -.IR "Note well" : -This page documents interfaces provided in glibc up until version 2.1. -Since version 2.2, glibc no longer provides these interfaces. -Probably, you are looking for the APIs provided by the -.I libdb -library instead. -.PP -The routine -.BR dbopen (3) -is the library interface to database files. -One of the supported file formats is record number files. -The general description of the database access methods is in -.BR dbopen (3), -this manual page describes only the recno-specific information. -.PP -The record number data structure is either variable or fixed-length -records stored in a flat-file format, accessed by the logical record -number. -The existence of record number five implies the existence of records -one through four, and the deletion of record number one causes -record number five to be renumbered to record number four, as well -as the cursor, if positioned after record number one, to shift down -one record. -.PP -The recno access-method-specific data structure provided to -.BR dbopen (3) -is defined in the -.I -include file as follows: -.PP -.in +4n -.EX -typedef struct { - unsigned long flags; - unsigned int cachesize; - unsigned int psize; - int lorder; - size_t reclen; - unsigned char bval; - char *bfname; -} RECNOINFO; -.EE -.in -.PP -The elements of this structure are defined as follows: -.TP -.I flags -The flag value is specified by ORing -any of the following values: -.RS -.TP -.B R_FIXEDLEN -The records are fixed-length, not byte delimited. -The structure element -.I reclen -specifies the length of the record, and the structure element -.I bval -is used as the pad character. -Any records, inserted into the database, that are less than -.I reclen -bytes long are automatically padded. -.TP -.B R_NOKEY -In the interface specified by -.BR dbopen (3), -the sequential record retrieval fills in both the caller's key and -data structures. -If the -.B R_NOKEY -flag is specified, the -.I cursor -routines are not required to fill in the key structure. -This permits applications to retrieve records at the end of files without -reading all of the intervening records. -.TP -.B R_SNAPSHOT -This flag requires that a snapshot of the file be taken when -.BR dbopen (3) -is called, instead of permitting any unmodified records to be read from -the original file. -.RE -.TP -.I cachesize -A suggested maximum size, in bytes, of the memory cache. -This value is -.B only -advisory, and the access method will allocate more memory rather than fail. -If -.I cachesize -is 0 (no size is specified), a default cache is used. -.TP -.I psize -The recno access method stores the in-memory copies of its records -in a btree. -This value is the size (in bytes) of the pages used for nodes in that tree. -If -.I psize -is 0 (no page size is specified), a page size is chosen based on the -underlying filesystem I/O block size. -See -.BR btree (3) -for more information. -.TP -.I lorder -The byte order for integers in the stored database metadata. -The number should represent the order as an integer; for example, -big endian order would be the number 4,321. -If -.I lorder -is 0 (no order is specified), the current host order is used. -.TP -.I reclen -The length of a fixed-length record. -.TP -.I bval -The delimiting byte to be used to mark the end of a record for -variable-length records, and the pad character for fixed-length -records. -If no value is specified, newlines ("\en") are used to mark the end -of variable-length records and fixed-length records are padded with -spaces. -.TP -.I bfname -The recno access method stores the in-memory copies of its records -in a btree. -If -.I bfname -is non-NULL, it specifies the name of the btree file, -as if specified as the filename for a -.BR dbopen (3) -of a btree file. -.PP -The data part of the key/data pair used by the -.I recno -access method -is the same as other access methods. -The key is different. -The -.I data -field of the key should be a pointer to a memory location of type -.IR recno_t , -as defined in the -.I -include file. -This type is normally the largest unsigned integral type available to -the implementation. -The -.I size -field of the key should be the size of that type. -.PP -Because there can be no metadata associated with the underlying -recno access method files, any changes made to the default values -(e.g., fixed record length or byte separator value) must be explicitly -specified each time the file is opened. -.PP -In the interface specified by -.BR dbopen (3), -using the -.I put -interface to create a new record will cause the creation of multiple, -empty records if the record number is more than one greater than the -largest record currently in the database. -.SH ERRORS -The -.I recno -access method routines may fail and set -.I errno -for any of the errors specified for the library routine -.BR dbopen (3) -or the following: -.TP -.B EINVAL -An attempt was made to add a record to a fixed-length database that -was too large to fit. -.SH BUGS -Only big and little endian byte order is supported. -.SH SEE ALSO -.BR btree (3), -.BR dbopen (3), -.BR hash (3), -.BR mpool (3) -.PP -.IR "Document Processing in a Relational Database System" , -Michael Stonebraker, Heidi Stettner, Joseph Kalash, Antonin Guttman, -Nadene Lynn, Memorandum No. UCB/ERL M82/32, May 1982. -.SH COLOPHON -This page is part of release 4.15 of the Linux -.I man-pages -project. -A description of the project, -information about reporting bugs, -and the latest version of this page, -can be found at -\%https://www.kernel.org/doc/man\-pages/. diff --git a/man7/boot.7 b/man7/boot.7 deleted file mode 100644 index 52a9b9f..0000000 --- a/man7/boot.7 +++ /dev/null @@ -1,238 +0,0 @@ -.\" Written by Oron Peled . -.\" -.\" %%%LICENSE_START(GPL_NOVERSION_ONELINE) -.\" May be distributed subject to the GPL. -.\" %%%LICENSE_END -.\" -.\" I tried to be as much generic in the description as possible: -.\" - General boot sequence is applicable to almost any -.\" OS/Machine (DOS/PC, Linux/PC, Solaris/SPARC, CMS/S390) -.\" - kernel and init(1) is applicable to almost any UNIX/Linux -.\" - boot scripts are applicable to SYSV-R4 based UNIX/Linux -.\" -.\" Modified 2004-11-03 patch from Martin Schulze -.\" -.TH BOOT 7 2015-03-11 "Linux" "Linux Programmer's Manual" -.SH NAME -boot \- System bootup process based on UNIX System V Release 4 -.SH DESCRIPTION -.PP -The \fBbootup process\fR (or "\fBboot sequence\fR") varies in details -among systems, but can be roughly divided into phases controlled by -the following components: -.IP 1. 4 -hardware -.IP 2. 4 -operating system (OS) loader -.IP 3. 4 -kernel -.IP 4. 4 -root user-space process (\fIinit\fR and \fIinittab\fR) -.IP 5. 4 -boot scripts -.PP -Each of these is described below in more detail. -.SS Hardware -After power-on or hard reset, control is given -to a program stored in read-only memory (normally -PROM); for historical reasons involving the personal -computer, this program is often called "the \fBBIOS\fR". -.PP -This program normally performs a basic self-test of the -machine and accesses nonvolatile memory to read -further parameters. -This memory in the PC is -battery-backed CMOS memory, so most people -refer to it as "the \fBCMOS\fR"; outside -of the PC world, it is usually called "the \fBNVRAM\fR" -(nonvolatile RAM). -.PP -The parameters stored in the NVRAM vary among -systems, but as a minimum, they should specify -which device can supply an OS loader, or at least which -devices may be probed for one; such a device is known as "the -\fBboot device\fR". -The hardware boot stage loads the OS loader from a fixed position on -the boot device, and then transfers control to it. -.TP -Note: -The device from which the OS loader is read may be attached via a network, in which -case the details of booting are further specified by protocols such as -DHCP, TFTP, PXE, Etherboot, etc. -.SS OS loader -The main job of the OS loader is to locate the kernel -on some device, load it, and run it. -Most OS loaders allow -interactive use, in order to enable specification of an alternative -kernel (maybe a backup in case the one last compiled -isn't functioning) and to pass optional parameters -to the kernel. -.PP -In a traditional PC, the OS loader is located in the initial 512-byte block -of the boot device; this block is known as "the \fBMBR\fR" -(Master Boot Record). -.PP -In most systems, the OS loader is very -limited due to various constraints. -Even on non-PC systems, -there are some limitations on the size and complexity -of this loader, but the size limitation of the PC MBR -(512 bytes, including the partition table) makes it -almost impossible to squeeze much functionality into it. -.PP -Therefore, most systems split the role of loading the OS between -a primary OS loader and a secondary OS loader; this secondary -OS loader may be located within a larger portion of persistent -storage, such as a disk partition. -.PP -In Linux, the OS loader is often either -.BR lilo (8) -or -.BR grub (8). -.SS Kernel -When the kernel is loaded, it initializes various components of -the computer and operating system; each portion of software -responsible for such a task is usually consider "a \fBdriver\fR" for -the applicable component. -The kernel starts the virtual memory -swapper (it is a kernel process, called "kswapd" in a modern Linux -kernel), and mounts some filesystem at the root path, -.IR / . -.PP -Some of the parameters that may be passed to the kernel -relate to these activities (for example, the default root filesystem -can be overridden); for further information -on Linux kernel parameters, read -.BR bootparam (7). -.PP -Only then does the kernel create the initial userland -process, which is given the number 1 as its -.B PID -(process ID). -Traditionally, this process executes the -program -.IR /sbin/init , -to which are passed the parameters that haven't already been -handled by the kernel. -.SS Root user-space process -.TP -Note: -The following description applies to an OS based on UNIX System V Release 4. -However, a number of widely used systems have adopted a related but -fundamentally different approach known as -.BR systemd (1), -for which the bootup process is detailed in its associated -.BR bootup (7). -.PP -When -.I /sbin/init -starts, it reads -.I /etc/inittab -for further instructions. -This file defines what should be run when the -.I /sbin/init -program is instructed to enter a particular \fIrun-level\fR, giving -the administrator an easy way to establish an environment -for some usage; each run-level is associated with a set of services -(for example, run-level \fBS\fR is \fIsingle-user\fR mode, -and run-level \fB2\fR entails running most network services). -.PP -The administrator may change the current -run-level via -.BR init (1), -and query the current run-level via -.BR runlevel (8). -.PP -However, since it is not convenient to manage individual services -by editing this file, -.I /etc/inittab -only bootstraps a set of scripts -that actually start/stop the individual services. -.SS Boot scripts -.TP -Note: -The following description applies to an OS based on UNIX System V Release 4. -However, a number of widely used systems (Slackware Linux, FreeBSD, OpenBSD) -have a somewhat different scheme for boot scripts. -.PP -For each managed service (mail, nfs server, cron, etc.), there is -a single startup script located in a specific directory -.RI ( /etc/init.d -in most versions of Linux). -Each of these scripts accepts as a single argument -the word "start" (causing it to start the service) or the word -\&"stop" (causing it to stop the service). -The script may optionally -accept other "convenience" parameters (e.g., "restart" to stop and then -start, "status" to display the service status, etc.). -Running the script -without parameters displays the possible arguments. -.SS Sequencing directories -To make specific scripts start/stop at specific run-levels and in a -specific order, there are \fIsequencing directories\fR, normally -of the form \fI/etc/rc[0\-6S].d\fR. -In each of these directories, -there are links (usually symbolic) to the scripts in the \fI/etc/init.d\fR -directory. -.PP -A primary script (usually \fI/etc/rc\fR) is called from -.BR inittab (5); -this primary script calls each service's script via a link in the -relevant sequencing directory. -Each link whose name begins with \(aqS\(aq is called with -the argument "start" (thereby starting the service). -Each link whose name begins with \(aqK\(aq is called with -the argument "stop" (thereby stopping the service). -.PP -To define the starting or stopping order within the same run-level, -the name of a link contains an \fBorder-number\fR. -Also, for clarity, the name of a link usually -ends with the name of the service to which it refers. -For example, -the link \fI/etc/rc2.d/S80sendmail\fR starts the sendmail service on -runlevel 2. -This happens after \fI/etc/rc2.d/S12syslog\fR is run -but before \fI/etc/rc2.d/S90xfs\fR is run. -.PP -To manage these links is to manage the boot order and run-levels; -under many systems, there are tools to help with this task -(e.g., -.BR chkconfig (8)). -.SS Boot configuration -A program that provides a service is often called a "\fBdaemon\fR". -Usually, a daemon may receive various command-line options -and parameters. -To allow a system administrator to change these -inputs without editing an entire boot script, -some separate configuration file is used, and is located in a specific -directory where an associated boot script may find it -(\fI/etc/sysconfig\fR on older Red Hat systems). -.PP -In older UNIX systems, such a file contained the actual command line -options for a daemon, but in modern Linux systems (and also -in HP-UX), it just contains shell variables. -A boot script in \fI/etc/init.d\fR reads and includes its configuration -file (that is, it "\fBsources\fR" its configuration file) and then uses -the variable values. -.SH FILES -.PP -.IR /etc/init.d/ , -.IR /etc/rc[S0\-6].d/ , -.I /etc/sysconfig/ -.SH SEE ALSO -.BR init (1), -.BR systemd (1), -.BR inittab (5), -.BR bootparam (7), -.BR bootup (7), -.BR runlevel (8), -.BR shutdown (8) -.SH COLOPHON -This page is part of release 4.15 of the Linux -.I man-pages -project. -A description of the project, -information about reporting bugs, -and the latest version of this page, -can be found at -\%https://www.kernel.org/doc/man\-pages/.