MySQL User Guide Part VII Appendixes
[edit] Part VII. Appendixes
[edit] Appendix A. Date Format Specifiers Table
[edit] Appendix B. Functions and Operators Tables *Complete*
This appendix contains a listing of all the MySQL functions and operators.
| Name | Description |
|---|---|
| Return the absolute value | |
| Return the arc cosine | |
|
| Add dates |
|
| Add time |
| Decrypt using AES | |
| Encrypt using AES | |
| Logical AND | |
| Return numeric value of left-most character | |
| Return the arc sine | |
| Return the arc tangent of the two arguments | |
| Return the arc tangent | |
| Return the average value of the argument | |
| Repeatedly execute an expression | |
| Check whether a value is within a range of values | |
| Return a string representation of the argument | |
| Cast a string to a binary string | |
| Return bitwise and | |
| Return the number of bits that are set | |
| Return length of argument in bits | |
| Return bitwise or | |
|
| Return bitwise xor |
| Bitwise AND | |
| Invert bits | |
| Bitwise OR | |
| Bitwise XOR | |
| Case operator | |
| Cast a value as a certain type | |
| Return the smallest integer value not less than the argument | |
| Return the smallest integer value not less than the argument | |
| Return number of characters in argument | |
| Return the character for each integer passed | |
| A synonym for CHAR_LENGTH() | |
|
| Return the character set of the argument |
| Return the first non-NULL argument | |
|
| Return the collation coercibility value of the string argument |
|
| Return the collation of the string argument |
|
| Return result as a binary string |
| Return concatenate with separator | |
| Return concatenated string | |
| Return the connection ID (thread ID) for the connection | |
| Convert numbers between different number bases | |
|
| Convert from one timezone to another |
| Cast a value as a certain type | |
| Return the cosine | |
| Return the cotangent | |
| Return the count of a number of different values | |
| Return a count of the number of rows returned | |
|
| Compute a cyclic redundancy check value |
| Return the current date | |
| Synonyms for CURDATE() | |
| Synonyms for CURTIME() | |
| Synonyms for NOW() | |
| Return the username and hostname combination | |
| Return the current time | |
| Return the default (current) database name | |
| Add two dates | |
| Format date as specified | |
| Subtract two dates | |
|
| Extract the date part of a date or datetime expression |
|
| Subtract two dates |
|
| Synonym for DAYOFMONTH() |
|
| Return the name of the weekday |
| Return the day of the month (1-31) | |
| Return the weekday index of the argument | |
| Return the day of the year (1-366) | |
| Decodes a string encrypted using ENCODE() | |
| Return the default value for a table column | |
| Convert radians to degrees | |
| Decrypt a string | |
| Encrypt a string | |
|
| Integer division |
| Division operator | |
| Return string at index number | |
| Encode a string | |
| Encrypt a string | |
| NULL-safe equal to operator | |
| Equal operator | |
| Raise to the power of | |
| Return a string such that for every bit set in the value bits, you get an on string and for every unset bit, you get an off string | |
| Extract part of a date | |
|
| Extracts a value from an XML string using XPath notation |
| Return the index (position) of the first argument in the subsequent arguments | |
| Return the index position of the first argument within the second argument | |
| Return the largest integer value not greater than the argument | |
| Return a number formatted to specified number of decimal places | |
| For a SELECT with a LIMIT clause, the number of rows that would be returned were there no LIMIT clause | |
| Convert a day number to a date | |
| Format date as a UNIX timestamp | |
|
| Return a date format string |
| Get a named lock | |
| Greater than or equal operator | |
| Greater than operator | |
| Return the largest argument | |
|
| Return a concatenated string |
| Return a hexadecimal representation of a decimal or string value | |
| Extract the hour | |
| If/else construct | |
| Null if/else construct | |
| Check whether a value is within a set of values | |
| Return the numeric value of an IP address | |
| Return the IP address from a numeric value | |
| Insert a substring at the specified position up to the specified number of characters | |
| Return the index of the first occurrence of substring | |
| Return the index of the argument that is less than the first argument | |
| Checks whether the named lock is free | |
| NOT NULL value test | |
| Test a value against a boolean | |
| NULL value test | |
|
| Checks whether the named lock is in use. Return connection identifier if true. |
| Test a value against a boolean | |
| Test whether the argument is NULL | |
|
| Return the last day of the month for the argument |
| Value of the AUTOINCREMENT column for the last INSERT | |
| Synonym for LOWER() | |
| Return the smallest argument | |
| Left shift | |
| Return the leftmost number of characters as specified | |
| Return the length of a string in bytes | |
| Less than or equal operator | |
| Less than operator | |
| Simple pattern matching | |
| Return the natural logarithm of the argument | |
| Load the named file | |
| Synonym for NOW() | |
|
| Synonym for NOW() |
| Return the position of the first occurrence of substring | |
| Return the base-10 logarithm of the argument | |
| Return the base-2 logarithm of the argument | |
| Return the natural logarithm of the first argument | |
| Return the argument in lowercase | |
| Return the string argument, left-padded with the specified string | |
| Remove leading spaces | |
| Return a set of comma-separated strings that have the corresponding bit in bits set | |
|
| Create a date from the year and day of year |
|
| MAKETIME() |
| Block until the slave has read and applied all updates up to the specified position | |
| Perform full-text search | |
| Return the maximum value | |
| Calculate MD5 checksum | |
|
| Return the microseconds from argument |
| Return a substring starting from the specified position | |
| Return the minimum value | |
| Minus operator | |
| Return the minute from the argument | |
| Return the remainder | |
| Modulo operator | |
| Return the month from the date passed | |
|
| Return the name of the month |
|
| Causes the column to have the given name |
| Check whether a value is not within a range of values | |
| Not equal operator | |
| Check whether a value is not within a set of values | |
| Negation of simple pattern matching | |
| Negation of REGEXP | |
| Negates value | |
| Return the current date and time | |
| Return NULL if expr1 = expr2 | |
| Return an octal representation of a decimal number | |
| A synonym for LENGTH() | |
|
| Return the value of the old (pre-4.1) implementation of PASSWORD |
| Logical OR | |
| If the leftmost character of the argument is a multi-byte character, returns the code for that character | |
| Calculate and return a password string | |
| Add a period to a year-month | |
| Return the number of months between periods | |
| Return the value of pi | |
| Addition operator | |
| A synonym for LOCATE() | |
| Return the argument raised to the specified power | |
| Return the argument raised to the specified power | |
| Analyze the results of a query | |
| Return the quarter from a date argument | |
| Escape the argument for use in an SQL statement | |
| Return argument converted to radians | |
| Return a random floating-point value | |
| Pattern matching using regular expressions | |
| Releases the named lock | |
| Repeat a string the specified number of times | |
| Replace occurrences of a specified string | |
| Reverse the characters in a string | |
| Right shift | |
| Return the specified rightmost number of characters | |
| Synonym for REGEXP | |
| Round the argument | |
|
| The number of rows updated |
| Append string the specified number of times | |
| Remove trailing spaces | |
|
| A synonym for DATABASE() |
| Converts seconds to 'HH:MM:SS' format | |
| Return the second (0-59) | |
| Synonym for USER() | |
| Calculate an SHA-1 160-bit checksum | |
| Return the sign of the argument | |
| Return the sine of the argument | |
|
| Sleep for a number of seconds |
| Return a soundex string | |
|
| Compare sounds |
| Return a string of the specified number of spaces | |
| Return the square root of the argument | |
| Return the population standard deviation | |
|
| Return the population standard deviation |
|
| Return the sample standard deviation |
| Return the population standard deviation | |
|
| Convert a string to a date |
| Compare two strings | |
| When invoked with three arguments a synonym for DATE_SUB() | |
| Return the substring as specified | |
| Return a substring from a string before the specified number of occurrences of the delimiter | |
| Return the substring as specified | |
|
| Subtract times |
| Return the sum | |
| Return the time at which the function executes | |
| Synonym for USER() | |
| Return the tangent of the argument | |
| Format as time | |
| Return the argument converted to seconds | |
|
| Extract the time portion of the expression passed |
|
| Subtract time |
| Times operator | |
|
| With a single argument, this function returns the date or datetime expression. With two arguments, the sum of the arguments |
|
| Add an interval to a datetime expression |
|
| Subtract an interval from a datetime expression |
| Return the date argument converted to days | |
| Remove leading and trailing spaces | |
| Truncate to specified number of decimal places | |
| Synonym for UPPER() | |
| Change the sign of the argument | |
|
| Uncompress a string compressed |
|
| Return the length of a string before compression |
|
| Convert each pair of hexadecimal digits to a character |
| Return a UNIX timestamp | |
|
| Return replaced XML fragment |
| Convert to uppercase | |
| Return the current username and hostname | |
|
| Return the current UTC date |
|
| Return the current UTC time |
|
| Return the current UTC date and time |
|
| Return a Universal Unique Identifier (UUID) |
|
| Defines the values to be used during an INSERT |
|
| Return the population standard variance |
|
| Return the sample variance |
|
| Return the population standard variance |
| Returns a string that indicates the MySQL server version | |
| Return the week number | |
| Return the weekday index | |
|
| Return the calendar week of the date (1-53) |
| Logical XOR | |
| Return the year | |
| Return the year and week |
[edit] Appendix C. Options Tables *Complete*
This appendix contains listings of options for the most-used MySQL programs. These tables contain brief descriptions along with hyperlinks to the manual. Where applicable, listings of commands are also supplied.
[edit] C.1. mysql Options *Complete*
Table C.1. mysql Option Reference
| Format | Config File | Description | Introduced |
|---|---|---|---|
| Enable automatic rehashing | |||
| Don't use history file | |||
| --bind-address=host_name | Determine which client network interface (IP address or hostname) to use when connecting to the MySQL Server | 5.1.22-ndb-6.3.4 | |
| Set the default character set | |||
| Write column names in results | |||
| Display result set metadata | 5.1.14 | ||
| Whether to retain or strip comments in statements sent to the server | 5.1.23 | ||
| Compress all information sent between the client and the server | |||
| The number of seconds before connection timeout | |||
| The database to use | |||
| Write a debugging log | |||
| Print debugging information when the program exits | 5.1.21 | ||
| Print debugging information, memory and CPU statistics when the program exits | |||
| Use charset_name as the default character set | |||
| Set the statement delimiter | |||
| Execute the statement and quit | |||
| Continue even if an SQL error occurs | |||
| Display help message and exit | |||
| Connect to the MySQL server on the given host | |||
| Produce HTML output | |||
| Ignore spaces after function names | |||
| Write line numbers for errors | |||
| Enable or disable for LOCAL capability for LOAD DATA INFILE | |||
| The maximum packet length to send to or receive from the server | |||
| The automatic limit for rows in a join when using --safe-updates | |||
| Enable named mysql commands | |||
| --net_buffer_length=value | net_buffer_length | The buffer size for TCP/IP and socket communication | |
| Disable automatic rehashing | |||
| Do not beep when errors occur | |||
| Disable named mysql commands | |||
| Deprecated form of --skip-pager | |||
| Do not copy output to a file | |||
| Ignore statements except those for the default database named on the command line | |||
| Use the given command for paging query output | |||
| The password to use when connecting to the server | |||
| The TCP/IP port number to use for the connection | |||
| Set the prompt to the specified format | |||
| The connection protocol to use | |||
| Do not cache each query result | |||
| Write column values without escape conversion | |||
| If the connection to the server is lost, automatically try to reconnect | |||
| Allow only UPDATE and DELETE statements that specify key values | |||
| --secure-auth | secure-auth | Do not send passwords to the server in old (pre-4.1.1) format | |
| The automatic limit for SELECT statements when using --safe-updates | |||
| Show warnings after each statement if there are any | |||
| Ignore SIGINT signals (typically the result of typing Control-C) | |||
| Silent mode | |||
| --skip-auto-rehash | skip-auto-rehash | Disable automatic rehashing | |
| Do not write column names in results | |||
| Skip line numbers for errors | |||
| --skip-named-commands | skip-named-commands | Disable named mysql commands | |
| --skip-pager | skip-pager | Disable paging | |
| --skip-reconnect | skip-reconnect | Disable reconnecting | |
| For connections to localhost | |||
| The path to a file that contains a list of trusted SSL CAs | |||
| The path to a directory that contains trusted SSL CA certificates in PEM format | |||
| The name of the SSL certificate file to use for establishing a secure connection | |||
| A list of allowable ciphers to use for SSL encryption | |||
| The name of the SSL key file to use for establishing a secure connection | |||
| The server's Common Name value in its certificate is verified against the hostname used when connecting to the server | |||
| Display output in tabular format | |||
| Append a copy of output to the given file | |||
| Flush the buffer after each query | |||
| The MySQL username to use when connecting to the server | |||
| Verbose mode | |||
| Display version information and exit | |||
| Print query output rows vertically (one line per column value) | |||
| If the connection cannot be established, wait and retry instead of aborting | |||
| Produce XML output | |||
[edit] C.2. mysql Commands
[edit] C.3. mysqladmin Options *Complete*
Table C.2. mysqladmin Option Reference
| Format | Config File | Description | Introduced |
|---|---|---|---|
| Compress all information sent between the client and the server | |||
| The number of seconds before connection timeout | |||
| The number of iterations to make for repeated command execution | |||
| Write a debugging log | |||
| Print debugging information when the program exits | 5.1.21 | ||
| Print debugging information, memory and CPU statistics when the program exits | 5.1.14 | ||
| Use charset_name as the default character set | |||
| Continue even if an SQL error occurs | |||
| Display help message and exit | |||
| Connect to the MySQL server on the given host | |||
| Do not beep when errors occur | 5.1.17 | ||
| The password to use when connecting to the server | |||
| The TCP/IP port number to use for the connection | |||
| The connection protocol to use | |||
| Show the difference between the current and previous values when used with the --sleep option | |||
| The maximum number of seconds to wait for server shutdown | |||
| Silent mode | |||
| Execute commands repeatedly, sleeping for delay seconds in between | |||
| For connections to localhost | |||
| The path to a file that contains a list of trusted SSL CAs | |||
| The path to a directory that contains trusted SSL CA certificates in PEM format | |||
| The name of the SSL certificate file to use for establishing a secure connection | |||
| A list of allowable ciphers to use for SSL encryption | |||
| The name of the SSL key file to use for establishing a secure connection | |||
| The server's Common Name value in its certificate is verified against the hostname used when connecting to the server | |||
| The MySQL username to use when connecting to the server | |||
| Verbose mode | |||
| Display version information and exit | |||
| Print query output rows vertically (one line per column value) | |||
| If the connection cannot be established, wait and retry instead of aborting | |||
[edit] C.4. mysqldump Options *Complete*
Table C.3. mysqldump Option Reference
| Format | Config File | Description | Introduced |
|---|---|---|---|
| Add a DROP DATABASE statement before each CREATE DATABASE statement | |||
| Add a DROP TABLE statement before each CREATE TABLE statement | |||
| Surround each table dump with LOCK TABLES and UNLOCK TABLES statements | |||
| Dump all tables in all databases | |||
| Allow creation of column names that are keywords | |||
| Adds to a table dump all SQL statements needed to create any tablespaces used by an NDB Cluster table | 5.1.6 | ||
| Add comments to the dump file | |||
| Produce less verbose output | |||
| Produce output that is more compatible with other database systems or with older MySQL servers | |||
| --complete-insert | complete-insert | Use complete INSERT statements that include column names | |
| -c | |||
| Include all MySQL-specific table options in the CREATE TABLE statements | |||
| Dump several databases | |||
| Write a debugging log | |||
| --debug-check | debug-check | Print debugging information when the program exits | 5.1.21 |
| --debug-info | debug-info | Print debugging information, memory and CPU statistics when the program exits | 5.1.14 |
| Write INSERT DELAYED statements rather than INSERT statements | |||
| On a master replication server, delete the binary logs after performing the dump operation | |||
| For each table, surround the INSERT statements with disable and enable keys statements | |||
| Include dump date in "Dump completed on" comment if --comments is given | 5.1.23 | ||
| Dump events from the dumped databases | |||
| Use multiple-row INSERT syntax that include several VALUES lists | |||
| This option is used with the -T option and has the same meaning as the corresponding clause for LOAD DATA INFILE | |||
| This option is used with the -T option and has the same meaning as the corresponding clause for LOAD DATA INFILE | |||
| This option is used with the -T option and has the same meaning as the corresponding clause for LOAD DATA INFILE | |||
| This option is used with the -T option and has the same meaning as the corresponding clause for LOAD DATA INFILE | |||
| Deprecated. Now renamed to --lock-all-tables | |||
| Flush the MySQL server log files before starting the dump | |||
| Emit a FLUSH PRIVILEGES statement after dumping the mysql database | |||
| Display help message and exit | |||
| Dump binary columns using hexadecimal notation (for example, 'abc' becomes 0x616263) | |||
| Do not dump the given table | |||
| Write INSERT statements with the IGNORE option | |||
| This option is used with the -T option and has the same meaning as the corresponding clause for LOAD DATA INFILE | |||
| Lock all tables across all databases | |||
| Lock all tables before dumping them | |||
| Append warnings and errors to the named file | 5.1.18 | ||
| Write the binary log filename and position to the output | |||
| --max_allowed_packet=value | max_allowed_packet | The maximum packet length to send to or receive from the server | |
| The buffer size for TCP/IP and socket communication | |||
| Enclose the INSERT statements for each dumped table within SET AUTOCOMMIT=0 and COMMIT statements | |||
| This option suppresses the CREATE DATABASE statements | |||
| Do not write CREATE TABLE statements that re-create each dumped table | |||
| --no-set-names | no-set-names | Turn off complete-insert | |
| This option is shorthand; it is the same as specifying --add-drop-table --add-locks --create-options --disable-keys --extended-insert --lock-tables --quick --set-charset. | |||
| Sorts each table's rows by its primary key, or by its first unique index | |||
| Retrieve rows for a table from the server a row at a time | |||
| Quote database, table, and column names within backtick characters | |||
| Write REPLACE statements rather than INSERT statements | |||
| Direct output to a given file | |||
| Dump stored routines (functions and procedures) from the dumped databases | |||
| Add SET NAMES default_character_set to the output | |||
| This option issues a BEGIN SQL statement before dumping data from the server | |||
| --skip-add-drop-table | skip-add-drop-table | Do not add | |
| --skip-add-locks | skip-add-locks | Do not add locks | |
| Do not add comments to the dump file | |||
| --skip-compact | skip-compact | Turn off compact | |
| --skip-disable-keys | skip-disable-keys | Do not disable keys | |
| --skip-extended-insert | skip-extended-insert | Turn off extended-insert | |
| Turn off the options set by opt | |||
| --skip-quick | skip-quick | Do not retrieve rows for a table from the server a row at a time | |
| --skip-quote-names | skip-quote-names | Turn off quote names | |
| -skip-charset | skip-set-charset | Suppress the SET NAMES statement | |
| --skip-triggers | skip-triggers | Turn off triggers | |
| --skip-tz-utc | skip-tz-utc | Turn off tz-utc | |
| The path to a file that contains a list of trusted SSL CAs | |||
| The path to a directory that contains trusted SSL CA certificates in PEM format | |||
| The name of the SSL certificate file to use for establishing a secure connection | |||
| A list of allowable ciphers to use for SSL encryption | |||
| The name of the SSL key file to use for establishing a secure connection | |||
| The server's Common Name value in its certificate is verified against the hostname used when connecting to the server | |||
| Produce tab-separated data files | |||
| Override the --databases or -B option | |||
| --triggers | triggers | Dump triggers for each dumped table | |
| Add SET TIME_ZONE='+00:00' to the dump file | |||
| Verbose mode | |||
| Display version information and exit | |||
| Dump only rows selected by the given WHERE condition | |||
| Produce XML output | |||
[edit] GNU Free Documentation License *Complete*
Version 1.2, November 2002
Copyright (C) 2000,2001,2002 Free Software Foundation, Inc.
Free Software Foundation, Inc.
51 Franklin Street, Fifth Floor,
Boston,
MA
02110-1301
USA
Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed.
Version 1.2, November 2002
[edit] D.1. PREAMBLE
The purpose of this License is to make a manual, textbook, or other functional and useful document "free" in the sense of freedom: to assure everyone the effective freedom to copy and redistribute it, with or without modifying it, either commercially or noncommercially. Secondarily, this License preserves for the author and publisher a way to get credit for their work, while not being considered responsible for modifications made by others.
This License is a kind of "copyleft", which means that derivative works of the document must themselves be free in the same sense. It complements the GNU General Public License, which is a copyleft license designed for free software.
We have designed this License in order to use it for manuals for free software, because free software needs free documentation: a free program should come with manuals providing the same freedoms that the software does. But this License is not limited to software manuals; it can be used for any textual work, regardless of subject matter or whether it is published as a printed book. We recommend this License principally for works whose purpose is instruction or reference.
[edit] D.2. APPLICABILITY AND DEFINITIONS
This License applies to any manual or other work, in any medium, that contains a notice placed by the copyright holder saying it can be distributed under the terms of this License. Such a notice grants a world-wide, royalty-free license, unlimited in duration, to use that work under the conditions stated herein. The "Document", below, refers to any such manual or work. Any member of the public is a licensee, and is addressed as "you". You accept the license if you copy, modify or distribute the work in a way requiring permission under copyright law.
A "Modified Version" of the Document means any work containing the Document or a portion of it, either copied verbatim, or with modifications and/or translated into another language.
A "Secondary Section" is a named appendix or a front-matter section of the Document that deals exclusively with the relationship of the publishers or authors of the Document to the Document's overall subject (or to related matters) and contains nothing that could fall directly within that overall subject. (Thus, if the Document is in part a textbook of mathematics, a Secondary Section may not explain any mathematics.) The relationship could be a matter of historical connection with the subject or with related matters, or of legal, commercial, philosophical, ethical or political position regarding them.
The "Invariant Sections" are certain Secondary Sections whose titles are designated, as being those of Invariant Sections, in the notice that says that the Document is released under this License. If a section does not fit the above definition of Secondary then it is not allowed to be designated as Invariant. The Document may contain zero Invariant Sections. If the Document does not identify any Invariant Sections then there are none.
The "Cover Texts" are certain short passages of text that are listed, as Front-Cover Texts or Back-Cover Texts, in the notice that says that the Document is released under this License. A Front-Cover Text may be at most 5 words, and a Back-Cover Text may be at most 25 words.
A "Transparent" copy of the Document means a machine-readable copy, represented in a format whose specification is available to the general public, that is suitable for revising the document straightforwardly with generic text editors or (for images composed of pixels) generic paint programs or (for drawings) some widely available drawing editor, and that is suitable for input to text formatters or for automatic translation to a variety of formats suitable for input to text formatters. A copy made in an otherwise Transparent file format whose markup, or absence of markup, has been arranged to thwart or discourage subsequent modification by readers is not Transparent. An image format is not Transparent if used for any substantial amount of text. A copy that is not "Transparent" is called "Opaque".
Examples of suitable formats for Transparent copies include plain ASCII without markup, Texinfo input format, LaTeX input format, SGML or XML using a publicly available DTD, and standard-conforming simple HTML, PostScript or PDF designed for human modification. Examples of transparent image formats include PNG, XCF and JPG. Opaque formats include proprietary formats that can be read and edited only by proprietary word processors, SGML or XML for which the DTD and/or processing tools are not generally available, and the machine-generated HTML, PostScript or PDF produced by some word processors for output purposes only.
The "Title Page" means, for a printed book, the title page itself, plus such following pages as are needed to hold, legibly, the material this License requires to appear in the title page. For works in formats which do not have any title page as such, "Title Page" means the text near the most prominent appearance of the work's title, preceding the beginning of the body of the text.
A section "Entitled XYZ" means a named subunit of the Document whose title either is precisely XYZ or contains XYZ in parentheses following text that translates XYZ in another language. (Here XYZ stands for a specific section name mentioned below, such as "Acknowledgements", "Dedications", "Endorsements", or "History".) To "Preserve the Title" of such a section when you modify the Document means that it remains a section "Entitled XYZ" according to this definition.
The Document may include Warranty Disclaimers next to the notice which states that this License applies to the Document. These Warranty Disclaimers are considered to be included by reference in this License, but only as regards disclaiming warranties: any other implication that these Warranty Disclaimers may have is void and has no effect on the meaning of this License.
[edit] D.3. VERBATIM COPYING
You may copy and distribute the Document in any medium, either commercially or noncommercially, provided that this License, the copyright notices, and the license notice saying this License applies to the Document are reproduced in all copies, and that you add no other conditions whatsoever to those of this License. You may not use technical measures to obstruct or control the reading or further copying of the copies you make or distribute. However, you may accept compensation in exchange for copies. If you distribute a large enough number of copies you must also follow the conditions in section 3.
You may also lend copies, under the same conditions stated above, and you may publicly display copies.
[edit] D.4. COPYING IN QUANTITY
If you publish printed copies (or copies in media that commonly have printed covers) of the Document, numbering more than 100, and the Document's license notice requires Cover Texts, you must enclose the copies in covers that carry, clearly and legibly, all these Cover Texts: Front-Cover Texts on the front cover, and Back-Cover Texts on the back cover. Both covers must also clearly and legibly identify you as the publisher of these copies. The front cover must present the full title with all words of the title equally prominent and visible. You may add other material on the covers in addition. Copying with changes limited to the covers, as long as they preserve the title of the Document and satisfy these conditions, can be treated as verbatim copying in other respects.
If the required texts for either cover are too voluminous to fit legibly, you should put the first ones listed (as many as fit reasonably) on the actual cover, and continue the rest onto adjacent pages.
If you publish or distribute Opaque copies of the Document numbering more than 100, you must either include a machine-readable Transparent copy along with each Opaque copy, or state in or with each Opaque copy a computer-network location from which the general network-using public has access to download using public-standard network protocols a complete Transparent copy of the Document, free of added material. If you use the latter option, you must take reasonably prudent steps, when you begin distribution of Opaque copies in quantity, to ensure that this Transparent copy will remain thus accessible at the stated location until at least one year after the last time you distribute an Opaque copy (directly or through your agents or retailers) of that edition to the public.
It is requested, but not required, that you contact the authors of the Document well before redistributing any large number of copies, to give them a chance to provide you with an updated version of the Document.
[edit] D.5. MODIFICATIONS
You may copy and distribute a Modified Version of the Document under the conditions of sections 2 and 3 above, provided that you release the Modified Version under precisely this License, with the Modified Version filling the role of the Document, thus licensing distribution and modification of the Modified Version to whoever possesses a copy of it. In addition, you must do these things in the Modified Version:
GNU FDL Modification Conditions
- Use in the Title Page (and on the covers, if any) a title distinct from that of the Document, and from those of previous versions (which should, if there were any, be listed in the History section of the Document). You may use the same title as a previous version if the original publisher of that version gives permission.
- List on the Title Page, as authors, one or more persons or entities responsible for authorship of the modifications in the Modified Version, together with at least five of the principal authors of the Document (all of its principal authors, if it has fewer than five), unless they release you from this requirement.
- State on the Title page the name of the publisher of the Modified Version, as the publisher.
- Preserve all the copyright notices of the Document.
- Add an appropriate copyright notice for your modifications adjacent to the other copyright notices.
- Include, immediately after the copyright notices, a license notice giving the public permission to use the Modified Version under the terms of this License, in the form shown in the [gfdl.html#gfdl-addendum Addendum] below.
- Preserve in that license notice the full lists of Invariant Sections and required Cover Texts given in the Document's license notice.
- Include an unaltered copy of this License.
- Preserve the section Entitled "History", Preserve its Title, and add to it an item stating at least the title, year, new authors, and publisher of the Modified Version as given on the Title Page. If there is no section Entitled "History" in the Document, create one stating the title, year, authors, and publisher of the Document as given on its Title Page, then add an item describing the Modified Version as stated in the previous sentence.
- Preserve the network location, if any, given in the Document for public access to a Transparent copy of the Document, and likewise the network locations given in the Document for previous versions it was based on. These may be placed in the "History" section. You may omit a network location for a work that was published at least four years before the Document itself, or if the original publisher of the version it refers to gives permission.
- For any section Entitled "Acknowledgements" or "Dedications", Preserve the Title of the section, and preserve in the section all the substance and tone of each of the contributor acknowledgements and/or dedications given therein.
- Preserve all the Invariant Sections of the Document, unaltered in their text and in their titles. Section numbers or the equivalent are not considered part of the section titles.
- Delete any section Entitled "Endorsements". Such a section may not be included in the Modified Version.
- Do not retitle any existing section to be Entitled "Endorsements" or to conflict in title with any Invariant Section.
- Preserve any Warranty Disclaimers.
If the Modified Version includes new front-matter sections or appendices that qualify as Secondary Sections and contain no material copied from the Document, you may at your option designate some or all of these sections as invariant. To do this, add their titles to the list of Invariant Sections in the Modified Version's license notice. These titles must be distinct from any other section titles.
You may add a section Entitled "Endorsements", provided it contains nothing but endorsements of your Modified Version by various parties--for example, statements of peer review or that the text has been approved by an organization as the authoritative definition of a standard.
You may add a passage of up to five words as a Front-Cover Text, and a passage of up to 25 words as a Back-Cover Text, to the end of the list of Cover Texts in the Modified Version. Only one passage of Front-Cover Text and one of Back-Cover Text may be added by (or through arrangements made by) any one entity. If the Document already includes a cover text for the same cover, previously added by you or by arrangement made by the same entity you are acting on behalf of, you may not add another; but you may replace the old one, on explicit permission from the previous publisher that added the old one.
The author(s) and publisher(s) of the Document do not by this License give permission to use their names for publicity for or to assert or imply endorsement of any Modified Version.
[edit] D.6. COMBINING DOCUMENTS
You may combine the Document with other documents released under this License, under the terms defined in [gfdl.html#gfdl-4 section 4] above for modified versions, provided that you include in the combination all of the Invariant Sections of all of the original documents, unmodified, and list them all as Invariant Sections of your combined work in its license notice, and that you preserve all their Warranty Disclaimers.
The combined work need only contain one copy of this License, and multiple identical Invariant Sections may be replaced with a single copy. If there are multiple Invariant Sections with the same name but different contents, make the title of each such section unique by adding at the end of it, in parentheses, the name of the original author or publisher of that section if known, or else a unique number. Make the same adjustment to the section titles in the list of Invariant Sections in the license notice of the combined work.
In the combination, you must combine any sections Entitled "History" in the various original documents, forming one section Entitled "History"; likewise combine any sections Entitled "Acknowledgements", and any sections Entitled "Dedications". You must delete all sections Entitled "Endorsements".
[edit] D.7. COLLECTIONS OF DOCUMENTS
You may make a collection consisting of the Document and other documents released under this License, and replace the individual copies of this License in the various documents with a single copy that is included in the collection, provided that you follow the rules of this License for verbatim copying of each of the documents in all other respects.
You may extract a single document from such a collection, and distribute it individually under this License, provided you insert a copy of this License into the extracted document, and follow this License in all other respects regarding verbatim copying of that document.
[edit] D.8. AGGREGATION WITH INDEPENDENT WORKS
A compilation of the Document or its derivatives with other separate and independent documents or works, in or on a volume of a storage or distribution medium, is called an "aggregate" if the copyright resulting from the compilation is not used to limit the legal rights of the compilation's users beyond what the individual works permit. When the Document is included in an aggregate, this License does not apply to the other works in the aggregate which are not themselves derivative works of the Document.
If the Cover Text requirement of section 3 is applicable to these copies of the Document, then if the Document is less than one half of the entire aggregate, the Document's Cover Texts may be placed on covers that bracket the Document within the aggregate, or the electronic equivalent of covers if the Document is in electronic form. Otherwise they must appear on printed covers that bracket the whole aggregate.
[edit] D.9. TRANSLATION
Translation is considered a kind of modification, so you may distribute translations of the Document under the terms of section 4. Replacing Invariant Sections with translations requires special permission from their copyright holders, but you may include translations of some or all Invariant Sections in addition to the original versions of these Invariant Sections. You may include a translation of this License, and all the license notices in the Document, and any Warranty Disclaimers, provided that you also include the original English version of this License and the original versions of those notices and disclaimers. In case of a disagreement between the translation and the original version of this License or a notice or disclaimer, the original version will prevail.
If a section in the Document is Entitled "Acknowledgements", "Dedications", or "History", the requirement (section 4) to Preserve its Title (section 1) will typically require changing the actual title.
[edit] D.10. TERMINATION
You may not copy, modify, sublicense, or distribute the Document except as expressly provided for under this License. Any other attempt to copy, modify, sublicense or distribute the Document is void, and will automatically terminate your rights under this License. However, parties who have received copies, or rights, from you under this License will not have their licenses terminated so long as such parties remain in full compliance.
[edit] D.11. FUTURE REVISIONS OF THIS LICENSE
The Free Software Foundation may publish new, revised versions of the GNU Free Documentation License from time to time. Such new versions will be similar in spirit to the present version, but may differ in detail to address new problems or concerns. See http://www.gnu.org/copyleft/.
Each version of the License is given a distinguishing version number. If the Document specifies that a particular numbered version of this License "or any later version" applies to it, you have the option of following the terms and conditions either of that specified version or of any later version that has been published (not as a draft) by the Free Software Foundation. If the Document does not specify a version number of this License, you may choose any version ever published (not as a draft) by the Free Software Foundation.
[edit] D.12. ADDENDUM: How to use this License for your documents
To use this License in a document you have written, include a copy of the License in the document and put the following copyright and license notices just after the title page:
Sample Invariant Sections list
Copyright (c) YEAR YOUR NAME. Permission is granted to copy, distribute and/or modify this document under the terms of the GNU Free Documentation License, Version 1.2 or any later version published by the Free Software Foundation; with no Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts. A copy of the license is included in the section entitled "GNU Free Documentation License".
If you have Invariant Sections, Front-Cover Texts and Back-Cover Texts, replace the "with...Texts." line with this:
Sample Invariant Sections list
with the Invariant Sections being LIST THEIR TITLES, with the Front-Cover Texts being LIST, and with the Back-Cover Texts being LIST.
If you have Invariant Sections without Cover Texts, or some other combination of the three, merge those two alternatives to suit the situation.
If your document contains nontrivial examples of program code, we recommend releasing these examples in parallel under your choice of free software license, such as the GNU General Public License, to permit their use in free software.