Variable: cperl-short-docs

cperl-short-docs is a variable defined in cperl-mode.el.gz.

Value

please-ignore-this-line

Documentation

Short documentation of Perl functions and variables.

# based on '@(#)@ perl-descr.el 1.9 - describe-perl-symbol' [Perl 5]
... Range (list context); flip/flop [no flop when flip] (scalar context).
! ... Logical negation.
... != ... Numeric inequality.
... !~ ... Search pattern, substitution, or translation (negated).
$! In numeric context: errno. In a string context: error string.
$" The separator which joins elements of arrays interpolated in strings.
$# The output format for printed numbers. Default is %.15g or close.
$$ Process number of this script. Changes in the fork()ed child process.
$% The current page number of the currently selected output channel.

The following variables are always local to the current block:

$1 Match of the 1st set of parentheses in the last match (auto-local).
$2 Match of the 2nd set of parentheses in the last match (auto-local).
$3 Match of the 3rd set of parentheses in the last match (auto-local).
$4 Match of the 4th set of parentheses in the last match (auto-local).
$5 Match of the 5th set of parentheses in the last match (auto-local).
$6 Match of the 6th set of parentheses in the last match (auto-local).
$7 Match of the 7th set of parentheses in the last match (auto-local).
$8 Match of the 8th set of parentheses in the last match (auto-local).
$9 Match of the 9th set of parentheses in the last match (auto-local).
$& The string matched by the last pattern match (auto-local).
$\\=' The string after what was matched by the last match (auto-local).
$\\=` The string before what was matched by the last match (auto-local).

$( The real gid of this process.
$) The effective gid of this process.
$* Deprecated: Set to 1 to do multiline matching within a string.
$+ The last bracket matched by the last search pattern.
$, The output field separator for the print operator.
$- The number of lines left on the page.
$. The current input line number of the last filehandle that was read.
$/ The input record separator, newline by default.
$0 Name of the file containing the current perl script (read/write).
$: String may be broken after these characters to fill ^-lines in a format.
$; Subscript separator for multi-dim array emulation. Default "\034".
$< The real uid of this process.
$= The page length of the current output channel. Default is 60 lines.
$> The effective uid of this process.
$? The status returned by the last \\=`\\=`, pipe close or `system'.
$@ The perl error message from the last eval or do @var{EXPR} command.
$ARGV The name of the current file used with <> .
$[ Deprecated: The index of the first element/char in an array/string.
$\\ The output record separator for the print operator.
$] The perl version string as displayed with perl -v.
$^ The name of the current top-of-page format.
$^A The current value of the write() accumulator for format() lines.
$^D The value of the perl debug (-D) flags.
$^E Information about the last system error other than that provided by $!.
$^F The highest system file descriptor, ordinarily 2.
$^H The current set of syntax checks enabled by `use strict'.
$^I The value of the in-place edit extension (perl -i option).
$^L What formats output to perform a formfeed. Default is \\f.
$^M A buffer for emergency memory allocation when running out of memory.
$^O The operating system name under which this copy of Perl was built.
$^P Internal debugging flag.
$^T The time the script was started. Used by -A/-M/-C file tests.
$^W True if warnings are requested (perl -w flag).
$^X The name under which perl was invoked (argv[0] in C-speech).
$_ The default input and pattern-searching space.
$| Auto-flush after write/print on current output channel? Default 0.
$~ The name of the current report format.
... % ... Modulo division.
... %= ... Modulo division assignment.
%ENV Contains the current environment.
%INC List of files that have been require-d or do-ne.
%SIG Used to set signal handlers for various signals.
... & ... Bitwise and.
... && ... Logical and.
... &&= ... Logical and assignment.
... &= ... Bitwise and assignment.
... * ... Multiplication.
... ** ... Exponentiation.
*NAME Glob: all objects referred by NAME. *NAM1 = *NAM2 aliases NAM1 to NAM2.
&NAME(arg0, ...) Subroutine call. Arguments go to @_.
... + ... Addition. +EXPR Makes EXPR into scalar context.
++ Auto-increment (magical on strings). ++EXPR EXPR++
... += ... Addition assignment.
, Comma operator.
... - ... Subtraction.
-- Auto-decrement (NOT magical on strings). --EXPR EXPR--
... -= ... Subtraction assignment.
-A Access time in days since script started.
-B File is a non-text (binary) file.
-C Inode change time in days since script started.
-M Age in days since script started.
-O File is owned by real uid.
-R File is readable by real uid.
-S File is a socket .
-T File is a text file.
-W File is writable by real uid.
-X File is executable by real uid.
-b File is a block special file.
-c File is a character special file.
-d File is a directory.
-e File exists .
-f File is a plain file.
-g File has setgid bit set.
-k File has sticky bit set.
-l File is a symbolic link.
-o File is owned by effective uid.
-p File is a named pipe (FIFO).
-r File is readable by effective uid.
-s File has non-zero size.
-t Tests if filehandle (STDIN by default) is opened to a tty.
-u File has setuid bit set.
-w File is writable by effective uid.
-x File is executable by effective uid.
-z File has zero size.
. Concatenate strings.
.. Range (list context); flip/flop (scalar context) operator.
.= Concatenate assignment strings
... / ... Division. /PATTERN/ioxsmg Pattern match
... /= ... Division assignment.
/PATTERN/ioxsmg Pattern match.
... < ... Numeric less than. <pattern> Glob. See <NAME>, <> as well.
<NAME> Reads line from filehandle NAME (a bareword or dollar-bareword).
<pattern> Glob (Unless pattern is bareword/dollar-bareword - see <NAME>).
<> Reads line from union of files in @ARGV (= command line) and STDIN.
... << ... Bitwise shift left. << start of HERE-DOCUMENT.
... <= ... Numeric less than or equal to.
... <=> ... Numeric compare.
... = ... Assignment.
... == ... Numeric equality.
... =~ ... Search pattern, substitution, or translation
... ~~ .. Smart match
... > ... Numeric greater than.
... >= ... Numeric greater than or equal to.
... >> ... Bitwise shift right.
... >>= ... Bitwise shift right assignment.
... ? ... : ... Condition=if-then-else operator.
... | ... Bitwise or.
... || ... Logical or.
... // ... Defined-or.
~ ... Unary bitwise complement.
... and ... Low-precedence synonym for &&.
... cmp ... String compare.
... eq ... String equality.
... ge ... String greater than or equal.
... gt ... String greater than.
... le ... String less than or equal.
... lt ... String less than.
... ne ... String inequality.
not ... Low-precedence synonym for ! - negation.
... or ... Low-precedence synonym for ||.
... x ... Repeat string or array.
x= ... Repetition assignment.
... xor ... Low-precedence synonym for exclusive or.
@ARGV Command line arguments (not including the command name - see $0).
@INC List of places to look for perl scripts during do/include/use.
@_ Parameter array for subroutines; result of split() unless in list context.
\\ Creates reference to what follows, like \\$var. Quotes non-\\w in strings.
\\0 Octal char, e.g. \\033.
\\E Case modification terminator. See \\Q, \\L, and \\U.
\\L Lowercase until \\E . See also \\l, lc.
\\U Upcase until \\E . See also \\u, uc.
\\Q Quote metacharacters until \\E . See also quotemeta.
\\a Alarm character (octal 007).
\\b Backspace character (octal 010).
\\c Control character, e.g. \\c[ .
\\e Escape character (octal 033).
\\f Formfeed character (octal 014).
\\l Lowercase the next character. See also \\L and \\u, lcfirst.
\\n Newline character (octal 012 on most systems).
\\r Return character (octal 015 on most systems).
\\t Tab character (octal 011).
\\u Upcase the next character. See also \\U and \\l, ucfirst.
\\x Hex character, e.g. \\x1b.
... ^ ... Bitwise exclusive or.
__CLASS__ The class of an object in construction
__DATA__ Ends program source.
__END__ Ends program source.
ADJUST {...} Callback for object creation
ARGV Default multi-file input filehandle. <ARGV> is a synonym for <>.
ARGVOUT Output filehandle with -i flag.
BEGIN { ... } Immediately executed (during compilation) piece of code.
END { ... } Pseudo-subroutine executed after the script finishes.
CHECK { ... } Pseudo-subroutine executed after the script is compiled.
UNITCHECK { ... }
INIT { ... } Pseudo-subroutine executed before the script starts running.
DATA Input filehandle for what follows after __END__ or __DATA__.
abs [ EXPR ] absolute value function
accept(NEWSOCKET,GENERICSOCKET) accept an incoming socket connect
alarm(SECONDS) schedule a SIGALRM
all {BLOCK} LIST true if BLOCK is true for all elements in LIST
any {BLOCK} LIST true if BLOCK is true for any element in LIST
async(SUB NAME {}|SUB {}) Mark function as potentially asynchronous
atan2(X,Y) arctangent of Y/X in the range -PI to PI
await(ASYNCEXPR) Yield result of Future
bind(SOCKET,NAME) binds an address to a socket
binmode(FILEHANDLE) prepare binary files for I/O
bless REFERENCE [, PACKAGE] Makes reference into an object of a package.
break Break out of a given/when statement
caller[(LEVEL)] get context of the current subroutine call
chdir(EXPR) change your current working directory
chmod(LIST) changes the permissions on a list of files
chomp [LIST] Strips $/ off LIST/$_. Returns count.
chop[(LIST|VAR)] remove the last character from a string
chown(LIST) change the ownership on a list of files
chr [NUMBER] Converts a number to char with the same ordinal.
chroot(FILENAME) make directory new root for path lookups
class NAME Introduce an object class.
close(FILEHANDLE) close file (or pipe or socket) handle
closedir(DIRHANDLE) close directory handle
connect(SOCKET,NAME) connect to a remote socket
continue of { block } continue { block }. Is executed after `next' or at end.
cos(EXPR) cosine function
crypt(PLAINTEXT,SALT) one-way passwd-style encryption
dbmclose(%HASH) breaks binding on a tied dbm file
dbmopen(%HASH,DBNAME,MODE) create binding on a tied dbm file
defined(EXPR) test whether a value, variable, or function is defined
delete($HASH{KEY}) deletes a value from a hash
die(LIST) raise an exception or bail out
do { ... }|SUBR while|until EXPR executes at least once
do(EXPR|SUBR([LIST])) (with while|until executes at least once)
dump LABEL create an immediate core dump
each(%HASH) retrieve the next key/value pair from a hash
endgrent be done using group file
endhostent be done using hosts file
endnetent be done using networks file
endprotoent be done using protocols file
endpwent be done using passwd file
endservent be done using services file
eof[([FILEHANDLE])] test a filehandle for its end
eval(EXPR) or eval { BLOCK } catch exceptions or compile and run code
evalbytes See eval.
exec([TRUENAME] ARGV0, ARGVs) or exec(SHELL_COMMAND_LINE)
exists $HASH{KEY} True if the key exists.
exit(EXPR) terminate this program
exp(EXPR) raise e to a power
fc EXPR Returns the casefolded version of EXPR.
fcntl(FILEHANDLE,FUNCTION,SCALAR)
field VAR [:param[(NAME)]] [=EXPR] declare an object attribute
__FILE__ Current (source) filename.
fileno(FILEHANDLE) return file descriptor from filehandle
flock(FILEHANDLE,OPERATION) lock an entire file with an advisory lock
fork create a new process just like this one
format [NAME] = Start of output format. Ended by a single dot (.) on a line.
formline PICTURE, LIST Backdoor into "format" processing.
getc[(FILEHANDLE)] get the next character from the filehandle
getgrent get group record given group user ID
getgrgid(GID) get group record given group user ID
getgrnam(NAME) get group record given group name
gethostbyaddr(ADDR,ADDRTYPE) get host record given name
gethostbyname(NAME) get host record given name
gethostent get next hosts record
getlogin return who logged in at this tty
getnetbyaddr(ADDR,ADDRTYPE) get network record given its address
getnetbyname(NAME) get networks record given name
getnetent get next networks record
getpeername(SOCKET) find the other end of a socket connection
getpgrp(PID) get process group
getppid get parent process ID
getpriority(WHICH,WHO) get current nice value
getprotobyname(NAME) get protocol record given name
getprotobynumber(NUMBER) get protocol record numeric protocol
getprotoent get next protocols record
getpwent get next passwd record
getpwnam(NAME) get passwd record given user login name
getpwuid(UID) get passwd record given user ID
getservbyname(NAME,PROTO) get services record given its name
getservbyport(PORT,PROTO) get services record given numeric port
getservent get next services record
getsockname(SOCKET) retrieve the sockaddr for a given socket
getsockopt(SOCKET,LEVEL,OPTNAME) get socket options on a given socket
glob EXPR expand filenames using wildcards. Synonym of <EXPR>.
gmtime(EXPR) convert UNIX time into record or string using Greenwich time
goto LABEL create spaghetti code
grep EXPR,LIST or grep {BLOCK} LIST Filters LIST via EXPR/BLOCK.
hex(EXPR) convert a hexadecimal string to a number
import patch a module's namespace into your own
index(STR,SUBSTR[,OFFSET]) find a substring within a string
int(EXPR) get the integer portion of a number
ioctl(FILEHANDLE,FUNCTION,SCALAR) device control system call
join(EXPR,LIST) join a list into a string using a separator
keys(%HASH) retrieve list of indices from a hash
kill(LIST) send a signal to a process or process group
last [LABEL] exit a block prematurely
lc [ EXPR ] Returns lowercased EXPR.
lcfirst [ EXPR ] Returns EXPR with lower-cased first letter.
length(EXPR) return the number of characters in a string
__LINE__ Current line in current source.
link(OLDFILE,NEWFILE) create a hard link in the filesystem
listen(SOCKET,QUEUESIZE) register your socket as a server
local(LIST) create a temporary value for a global variable
localtime(EXPR) convert UNIX time into record or string using local time
lock(THING) get a thread lock on a variable, subroutine, or method
log(EXPR) retrieve the natural logarithm for a number
lstat(EXPR|FILEHANDLE|VAR) stat a symbolic link
m/PATTERN/iogsmx match a string with a regular expression pattern
map EXPR, LIST or map {BLOCK} LIST Applies EXPR/BLOCK to elts of LIST.
method [NAME [(signature)]] { BODY } method NAME;
mkdir(FILENAME,MODE) create a directory
msgctl(ID,CMD,ARG) SysV IPC message control operations
msgget(KEY,FLAGS) get SysV IPC message queue
msgrcv(ID,VAR,SIZE,TYPE.FLAGS) receive a SysV IPC message from a message queue
msgsnd(ID,MSG,FLAGS) send a SysV IPC message to a message queue
my VAR or my (VAR1,...) Introduces a lexical variable ($VAR, @ARR, or %HASH).
next [LABEL] iterate a block prematurely
no MODULE [SYMBOL1, ...] Partial reverse for `use'. Runs `unimport' method.
oct(EXPR) convert a string to an octal number
open(FILEHANDLE[,EXPR]) open a file, pipe, or descriptor
opendir(DIRHANDLE,EXPR) open a directory
ord(EXPR) ASCII value of the first char of the string.
our VAR or our (VAR1,...) Lexically enable a global variable ($V, @A, or %H).
pack(TEMPLATE,LIST) convert a list into a binary representation
package NAME Introduces package context.
__PACKAGE__ Current package.
pipe(READHANDLE,WRITEHANDLE) Create a pair of filehandles on ends of a pipe.
pop(ARRAY) remove the last element from an array and return it
pos STRING Set/Get end-position of the last match over this string, see \\G.
print [FILEHANDLE] [(LIST)] output a list to a filehandle
printf [FILEHANDLE] (FORMAT,LIST) output a formatted list to a filehandle
prototype \\&SUB Returns prototype of the function given a reference.
push(ARRAY,LIST) append one or more elements to an array
q/STRING/ Synonym for \\='STRING\\='
qq/STRING/ Synonym for "STRING"
qr/PATTERN/ compile pattern
quotemeta quote regular expression magic characters
qw/STRING/ quote a list of words
qx/STRING/ Synonym for `STRING`
rand[(EXPR)] retrieve the next pseudorandom number
read(FILEHANDLE,SCALAR,LENGTH[,OFFSET]) fixed-length buffered input
readdir(DIRHANDLE) get a directory from a directory handle
readline FH Synonym of <FH>.
readlink(EXPR) determine where a symbolic link is pointing
readpipe CMD Synonym of `CMD`.
recv(SOCKET,SCALAR,LEN,FLAGS) receive a message over a Socket
redo [LABEL] start this loop iteration over again
ref [ EXPR ] Type of EXPR when dereferenced.
rename(OLDNAME,NEWNAME) change a filename
require [FILENAME | PERL_VERSION] load from a library at runtime
reset[(EXPR)] clear all variables of a given name
return(LIST) get out of a function early
reverse(LIST) flip a string or a list
rewinddir(DIRHANDLE) reset directory handle
rindex(STR,SUBSTR[,OFFSET]) right-to-left substring search
rmdir(FILENAME) remove a directory
s/PATTERN/REPLACEMENT/gieoxsm replace a pattern with a string
say [FILEHANDLE] [(LIST)] output a list, appending a newline
scalar(EXPR) force a scalar context
seek(FILEHANDLE,POSITION,WHENCE) reposition file pointer
seekdir(DIRHANDLE,POS) reposition directory pointer
select(FILEHANDLE) reset default output or do I/O multiplexing
select(RBITS,WBITS,EBITS,TIMEOUT) do I/O multiplexing
semctl(ID,SEMNUM,CMD,ARG) SysV semaphore control operations
semget(KEY,NSEMS,SIZE,FLAGS) get set of SysV semaphores
semop(KEY,...) SysV semaphore operations
send(SOCKET,MSG,FLAGS[,TO]) send a message over a socket
setgrent prepare group file for use
sethostent(STAYOPEN) prepare hosts file for use
setnetent(STAYOPEN) prepare networks file for use
setpgrp(PID,PGRP) set the process group of a process
setpriority(WHICH,WHO,PRIORITY) Process set a process's nice value
setprotoent(STAYOPEN) etwork prepare protocols file for use
setpwent prepare passwd file for use
setservent(STAYOPEN) prepare services file for use
setsockopt(SOCKET,LEVEL,OPTNAME,OPTVAL) set some socket options
shift[(ARRAY)] remove the first element of an array, and return it
shmctl(ID,CMD,ARG) SysV shared memory operations
shmget(KEY,SIZE,FLAGS) get SysV shared memory segment identifier
shmread(ID,VAR,POS,SIZE) read SysV shared memory
shmwrite(ID,STRING,POS,SIZE) write SysV shared memory
shutdown(SOCKET,HOW) close down just half of a socket connection
sin(EXPR) return the sine of a number
sleep[(EXPR)] block for some number of seconds
socket(SOCKET,DOMAIN,TYPE,PROTOCOL) create a socket
socketpair(SOCKET1,SOCKET2,DOMAIN,TYPE,PROTOCOL) create a pair of sockets
sort [SUBROUTINE] (LIST) sort a list of values
splice(ARRAY,OFFSET[,LENGTH[,LIST]]) add or remove elements anywhere
split[(/PATTERN/[,EXPR[,LIMIT]])] split up a string using a regexp
sprintf(FORMAT,LIST) formatted print into a string
sqrt(EXPR) square root function
srand(EXPR) seed the random number generator
stat(EXPR|FILEHANDLE|VAR) get a file's status information
state VAR or state (VAR1,...) Introduces a static lexical variable
study[(SCALAR)] no-op, formerly optimized input data for repeated searches
sub [NAME [(format)]] { BODY } sub NAME [(format)]; sub [(format)] {...}
__SUB__ the current subroutine, or C<undef> if not in a subroutine
substr(EXPR,OFFSET[,LEN]) get or alter a portion of a string
symlink(OLDFILE,NEWFILE) create a symbolic link to a file
syscall(LIST) execute an arbitrary system call
sysopen FH, FILENAME, MODE [, PERM] (MODE is numeric, see Fcntl.)
sysread(FILEHANDLE,SCALAR,LENGTH[,OFFSET]) fixed-length unbuffered input
sysseek(FILEHANDLE,POSITION,WHENCE) position I/O pointer on handle
system([TRUENAME] ARGV0 [,ARGV]) or system(SHELL_COMMAND_LINE)
syswrite(FILEHANDLE,SCALAR,LENGTH[,OFFSET]) fixed-length unbuffered output
tell[(FILEHANDLE)] get current seekpointer on a filehandle
telldir(DIRHANDLE) get current seekpointer on a directory handle
tie VAR, CLASS, LIST Hide an object behind a simple Perl variable.
tied Returns internal object for a tied data.
time return number of seconds since 1970
times return elapsed time for self and child processes
tr/SEARCHLIST/REPLACEMENTLIST/cds transliterate a string
truncate(FILE|EXPR,LENGTH) shorten a file
uc [ EXPR ] Returns upcased EXPR.
ucfirst [ EXPR ] Returns EXPR with upcased first letter.
umask[(EXPR)] set file creation mode mask
undef[(EXPR)] remove a variable or function definition
unlink(LIST) remove one link to a file
unpack(TEMPLATE,EXPR) convert binary structure into normal perl variables
unshift(ARRAY,LIST) prepend more elements to the beginning of a list
untie VAR Unlink an object from a simple Perl variable.
use MODULE [SYMBOL1, ...] Compile-time require with consequent import.
utime(LIST) set a file's last access and modify times
values(%HASH) return a list of the values in a hash
vec(EXPR,OFFSET,BITS) test or set particular bits in a string
wait wait for any child process to die
waitpid(PID,FLAGS) wait for a particular child process to die
wantarray Returns true if the sub/eval is called in list context.
warn(LIST) print debugging info
write[(EXPR|FILEHANDLE)] print a picture record
y/SEARCHLIST/REPLACEMENTLIST/ transliterate a string
#! OS interpreter indicator. If contains perl, used for options, and -x.
AUTOLOAD {...} Shorthand for sub AUTOLOAD {...}.
CORE:: Prefix to access builtin function if imported sub obscures it.
SUPER:: Prefix to lookup for a method in @ISA classes.
DESTROY Shorthand for sub DESTROY {...}.
else Part of if/unless {BLOCK} elsif {BLOCK} else {BLOCK}.
elsif Part of if/unless {BLOCK} elsif {BLOCK} else {BLOCK}.
default { ... } default case for given/when block
defer { ... } run this block after the containing block.
for (EXPR;EXPR;EXPR) { ... } foreach [VAR] (@ARRAY) { ... } given (EXPR) { [ when (EXPR) { ... } ]+ [ default { ... } ]? } if (EXPR) { ... } [ elsif (EXPR) { ... } ... ] [ else { ... } ] or EXPR if EXPR unless (EXPR) { ... } [ else { ... } ] or EXPR unless EXPR
until (EXPR) { ... } EXPR until EXPR
while (EXPR) { ... } EXPR while EXPR
=head1 Top-level heading.
=head2 Second-level heading.
=head3 Third-level heading.
=head4 Fourth-level heading.
=over [ NUMBER ] Start list.
=item [ TITLE ] Start new item in the list.
=back End list.
=cut Switch from POD to Perl.
=pod Switch from Perl to POD.
=begin formatname Start directly formatted region.
=end formatname End directly formatted region.
=for formatname text Paragraph in special format.
=encoding encodingname Encoding of the document.

Source Code

;; Defined in /usr/src/emacs/lisp/progmodes/cperl-mode.el.gz
(defvar cperl-short-docs 'please-ignore-this-line
  ;; Perl4 version was written by Johan Vromans (jvromans@squirrel.nl)
  "Short documentation of Perl functions and variables.
# based on \\='@(#)@ perl-descr.el 1.9 - describe-perl-symbol\\=' [Perl 5]
...	Range (list context); flip/flop [no flop when flip] (scalar context).
! ...	Logical negation.
... != ...	Numeric inequality.
... !~ ...	Search pattern, substitution, or translation (negated).
$!	In numeric context: errno.  In a string context: error string.
$\"	The separator which joins elements of arrays interpolated in strings.
$#	The output format for printed numbers.  Default is %.15g or close.
$$	Process number of this script.  Changes in the fork()ed child process.
$%	The current page number of the currently selected output channel.

	The following variables are always local to the current block:

$1	Match of the 1st set of parentheses in the last match (auto-local).
$2	Match of the 2nd set of parentheses in the last match (auto-local).
$3	Match of the 3rd set of parentheses in the last match (auto-local).
$4	Match of the 4th set of parentheses in the last match (auto-local).
$5	Match of the 5th set of parentheses in the last match (auto-local).
$6	Match of the 6th set of parentheses in the last match (auto-local).
$7	Match of the 7th set of parentheses in the last match (auto-local).
$8	Match of the 8th set of parentheses in the last match (auto-local).
$9	Match of the 9th set of parentheses in the last match (auto-local).
$&	The string matched by the last pattern match (auto-local).
$\\='	The string after what was matched by the last match (auto-local).
$\\=`	The string before what was matched by the last match (auto-local).

$(	The real gid of this process.
$)	The effective gid of this process.
$*	Deprecated: Set to 1 to do multiline matching within a string.
$+	The last bracket matched by the last search pattern.
$,	The output field separator for the print operator.
$-	The number of lines left on the page.
$.	The current input line number of the last filehandle that was read.
$/	The input record separator, newline by default.
$0	Name of the file containing the current perl script (read/write).
$:     String may be broken after these characters to fill ^-lines in a format.
$;	Subscript separator for multi-dim array emulation.  Default \"\\034\".
$<	The real uid of this process.
$=	The page length of the current output channel.  Default is 60 lines.
$>	The effective uid of this process.
$?	The status returned by the last \\=`\\=`, pipe close or `system'.
$@	The perl error message from the last eval or do @var{EXPR} command.
$ARGV	The name of the current file used with <> .
$[	Deprecated: The index of the first element/char in an array/string.
$\\	The output record separator for the print operator.
$]	The perl version string as displayed with perl -v.
$^	The name of the current top-of-page format.
$^A     The current value of the write() accumulator for format() lines.
$^D	The value of the perl debug (-D) flags.
$^E     Information about the last system error other than that provided by $!.
$^F	The highest system file descriptor, ordinarily 2.
$^H     The current set of syntax checks enabled by `use strict'.
$^I	The value of the in-place edit extension (perl -i option).
$^L     What formats output to perform a formfeed.  Default is \\f.
$^M     A buffer for emergency memory allocation when running out of memory.
$^O     The operating system name under which this copy of Perl was built.
$^P	Internal debugging flag.
$^T	The time the script was started.  Used by -A/-M/-C file tests.
$^W	True if warnings are requested (perl -w flag).
$^X	The name under which perl was invoked (argv[0] in C-speech).
$_	The default input and pattern-searching space.
$|	Auto-flush after write/print on current output channel?  Default 0.
$~	The name of the current report format.
... % ...	Modulo division.
... %= ...	Modulo division assignment.
%ENV	Contains the current environment.
%INC	List of files that have been require-d or do-ne.
%SIG	Used to set signal handlers for various signals.
... & ...	Bitwise and.
... && ...	Logical and.
... &&= ...	Logical and assignment.
... &= ...	Bitwise and assignment.
... * ...	Multiplication.
... ** ...	Exponentiation.
*NAME	Glob: all objects referred by NAME.  *NAM1 = *NAM2 aliases NAM1 to NAM2.
&NAME(arg0, ...)	Subroutine call.  Arguments go to @_.
... + ...	Addition.		+EXPR	Makes EXPR into scalar context.
++	Auto-increment (magical on strings).	++EXPR	EXPR++
... += ...	Addition assignment.
,	Comma operator.
... - ...	Subtraction.
--	Auto-decrement (NOT magical on strings).	--EXPR	EXPR--
... -= ...	Subtraction assignment.
-A	Access time in days since script started.
-B	File is a non-text (binary) file.
-C	Inode change time in days since script started.
-M	Age in days since script started.
-O	File is owned by real uid.
-R	File is readable by real uid.
-S	File is a socket .
-T	File is a text file.
-W	File is writable by real uid.
-X	File is executable by real uid.
-b	File is a block special file.
-c	File is a character special file.
-d	File is a directory.
-e	File exists .
-f	File is a plain file.
-g	File has setgid bit set.
-k	File has sticky bit set.
-l	File is a symbolic link.
-o	File is owned by effective uid.
-p	File is a named pipe (FIFO).
-r	File is readable by effective uid.
-s	File has non-zero size.
-t	Tests if filehandle (STDIN by default) is opened to a tty.
-u	File has setuid bit set.
-w	File is writable by effective uid.
-x	File is executable by effective uid.
-z	File has zero size.
.	Concatenate strings.
..	Range (list context); flip/flop (scalar context) operator.
.=	Concatenate assignment strings
... / ...	Division.	/PATTERN/ioxsmg	Pattern match
... /= ...	Division assignment.
/PATTERN/ioxsmg	Pattern match.
... < ...    Numeric less than.	<pattern>	Glob.	See <NAME>, <> as well.
<NAME>	Reads line from filehandle NAME (a bareword or dollar-bareword).
<pattern>	Glob (Unless pattern is bareword/dollar-bareword - see <NAME>).
<>	Reads line from union of files in @ARGV (= command line) and STDIN.
... << ...	Bitwise shift left.	<<	start of HERE-DOCUMENT.
... <= ...	Numeric less than or equal to.
... <=> ...	Numeric compare.
... = ...	Assignment.
... == ...	Numeric equality.
... =~ ...	Search pattern, substitution, or translation
... ~~ ..       Smart match
... > ...	Numeric greater than.
... >= ...	Numeric greater than or equal to.
... >> ...	Bitwise shift right.
... >>= ...	Bitwise shift right assignment.
... ? ... : ...	Condition=if-then-else operator.
... | ...	Bitwise or.
... || ...	Logical or.
... // ...      Defined-or.
~ ...		Unary bitwise complement.
... and ...		Low-precedence synonym for &&.
... cmp ...	String compare.
... eq ...	String equality.
... ge ...	String greater than or equal.
... gt ...	String greater than.
... le ...	String less than or equal.
... lt ...	String less than.
... ne ...	String inequality.
not ...		Low-precedence synonym for ! - negation.
... or ...		Low-precedence synonym for ||.
... x ...	Repeat string or array.
x= ...	Repetition assignment.
... xor ...		Low-precedence synonym for exclusive or.
@ARGV	Command line arguments (not including the command name - see $0).
@INC	List of places to look for perl scripts during do/include/use.
@_    Parameter array for subroutines; result of split() unless in list context.
\\  Creates reference to what follows, like \\$var.  Quotes non-\\w in strings.
\\0	Octal char, e.g. \\033.
\\E	Case modification terminator.  See \\Q, \\L, and \\U.
\\L	Lowercase until \\E .  See also \\l, lc.
\\U	Upcase until \\E .  See also \\u, uc.
\\Q	Quote metacharacters until \\E .  See also quotemeta.
\\a	Alarm character (octal 007).
\\b	Backspace character (octal 010).
\\c	Control character, e.g. \\c[ .
\\e	Escape character (octal 033).
\\f	Formfeed character (octal 014).
\\l	Lowercase the next character.  See also \\L and \\u, lcfirst.
\\n	Newline character (octal 012 on most systems).
\\r	Return character (octal 015 on most systems).
\\t	Tab character (octal 011).
\\u	Upcase the next character.  See also \\U and \\l, ucfirst.
\\x	Hex character, e.g. \\x1b.
... ^ ...	Bitwise exclusive or.
__CLASS__	The class of an object in construction
__DATA__	Ends program source.
__END__	Ends program source.
ADJUST {...}	Callback for object creation
ARGV	Default multi-file input filehandle.  <ARGV> is a synonym for <>.
ARGVOUT	Output filehandle with -i flag.
BEGIN { ... }	Immediately executed (during compilation) piece of code.
END { ... }	Pseudo-subroutine executed after the script finishes.
CHECK { ... }	Pseudo-subroutine executed after the script is compiled.
UNITCHECK { ... }
INIT { ... }	Pseudo-subroutine executed before the script starts running.
DATA	Input filehandle for what follows after __END__	or __DATA__.
abs [ EXPR ]	absolute value function
accept(NEWSOCKET,GENERICSOCKET)	accept an incoming socket connect
alarm(SECONDS)	schedule a SIGALRM
all {BLOCK} LIST	true if BLOCK is true for all elements in LIST
any {BLOCK} LIST	true if BLOCK is true for any element in LIST
async(SUB NAME {}|SUB {})	Mark function as potentially asynchronous
atan2(X,Y)	arctangent of Y/X in the range -PI to PI
await(ASYNCEXPR)	Yield result of Future
bind(SOCKET,NAME)	binds an address to a socket
binmode(FILEHANDLE)	prepare binary files for I/O
bless REFERENCE [, PACKAGE]	Makes reference into an object of a package.
break	Break out of a given/when statement
caller[(LEVEL)]	get context of the current subroutine call
chdir(EXPR)	change your current working directory
chmod(LIST)	changes the permissions on a list of files
chomp [LIST]	Strips $/ off LIST/$_.  Returns count.
chop[(LIST|VAR)]	remove the last character from a string
chown(LIST)	change the ownership on a list of files
chr [NUMBER]	Converts a number to char with the same ordinal.
chroot(FILENAME)	make directory new root for path lookups
class NAME	Introduce an object class.
close(FILEHANDLE)	close file (or pipe or socket) handle
closedir(DIRHANDLE)	close directory handle
connect(SOCKET,NAME)	connect to a remote socket
continue of { block } continue { block }.  Is executed after `next' or at end.
cos(EXPR)	cosine function
crypt(PLAINTEXT,SALT)	one-way passwd-style encryption
dbmclose(%HASH)	breaks binding on a tied dbm file
dbmopen(%HASH,DBNAME,MODE)	create binding on a tied dbm file
defined(EXPR)	test whether a value, variable, or function is defined
delete($HASH{KEY})	deletes a value from a hash
die(LIST)	raise an exception or bail out
do { ... }|SUBR while|until EXPR	executes at least once
do(EXPR|SUBR([LIST]))	(with while|until executes at least once)
dump LABEL	create an immediate core dump
each(%HASH)	retrieve the next key/value pair from a hash
endgrent	be done using group file
endhostent	be done using hosts file
endnetent	be done using networks file
endprotoent	be done using protocols file
endpwent	be done using passwd file
endservent	be done using services file
eof[([FILEHANDLE])]	test a filehandle for its end
eval(EXPR) or eval { BLOCK }	catch exceptions or compile and run code
evalbytes   See eval.
exec([TRUENAME] ARGV0, ARGVs)     or     exec(SHELL_COMMAND_LINE)
exists $HASH{KEY}	True if the key exists.
exit(EXPR)	terminate this program
exp(EXPR)	raise e to a power
fc EXPR    Returns the casefolded version of EXPR.
fcntl(FILEHANDLE,FUNCTION,SCALAR)
field VAR  [:param[(NAME)]] [=EXPR]	declare an object attribute
__FILE__	Current (source) filename.
fileno(FILEHANDLE)	return file descriptor from filehandle
flock(FILEHANDLE,OPERATION)	lock an entire file with an advisory lock
fork	create a new process just like this one
format [NAME] =	 Start of output format.  Ended by a single dot (.) on a line.
formline PICTURE, LIST	Backdoor into \"format\" processing.
getc[(FILEHANDLE)]	get the next character from the filehandle
getgrent	get group record given group user ID
getgrgid(GID)	get group record given group user ID
getgrnam(NAME)	get group record given group name
gethostbyaddr(ADDR,ADDRTYPE)	get host record given name
gethostbyname(NAME)	get host record given name
gethostent	get next hosts record
getlogin	return who logged in at this tty
getnetbyaddr(ADDR,ADDRTYPE)	get network record given its address
getnetbyname(NAME)	get networks record given name
getnetent	get next networks record
getpeername(SOCKET)	find the other end of a socket connection
getpgrp(PID)	get process group
getppid	get parent process ID
getpriority(WHICH,WHO)	get current nice value
getprotobyname(NAME)	get protocol record given name
getprotobynumber(NUMBER)	get protocol record numeric protocol
getprotoent	get next protocols record
getpwent	get next passwd record
getpwnam(NAME)	get passwd record given user login name
getpwuid(UID)	get passwd record given user ID
getservbyname(NAME,PROTO)	get services record given its name
getservbyport(PORT,PROTO)	get services record given numeric port
getservent	get next services record
getsockname(SOCKET)	retrieve the sockaddr for a given socket
getsockopt(SOCKET,LEVEL,OPTNAME)	get socket options on a given socket
glob EXPR	expand filenames using wildcards.  Synonym of <EXPR>.
gmtime(EXPR)	convert UNIX time into record or string using Greenwich time
goto LABEL	create spaghetti code
grep EXPR,LIST  or grep {BLOCK} LIST	Filters LIST via EXPR/BLOCK.
hex(EXPR)	convert a hexadecimal string to a number
import	patch a module's namespace into your own
index(STR,SUBSTR[,OFFSET])	find a substring within a string
int(EXPR)	get the integer portion of a number
ioctl(FILEHANDLE,FUNCTION,SCALAR)	device control system call
join(EXPR,LIST)	join a list into a string using a separator
keys(%HASH)	retrieve list of indices from a hash
kill(LIST)	send a signal to a process or process group
last [LABEL]	exit a block prematurely
lc [ EXPR ]	Returns lowercased EXPR.
lcfirst [ EXPR ]	Returns EXPR with lower-cased first letter.
length(EXPR)	return the number of characters in a string
__LINE__	Current line in current source.
link(OLDFILE,NEWFILE)	create a hard link in the filesystem
listen(SOCKET,QUEUESIZE)	register your socket as a server
local(LIST)	create a temporary value for a global variable
localtime(EXPR)	convert UNIX time into record or string using local time
lock(THING)	get a thread lock on a variable, subroutine, or method
log(EXPR)	retrieve the natural logarithm for a number
lstat(EXPR|FILEHANDLE|VAR)	stat a symbolic link
m/PATTERN/iogsmx	match a string with a regular expression pattern
map EXPR, LIST	or map {BLOCK} LIST	Applies EXPR/BLOCK to elts of LIST.
method  [NAME [(signature)]] { BODY }	method NAME;
mkdir(FILENAME,MODE)	create a directory
msgctl(ID,CMD,ARG)	SysV IPC message control operations
msgget(KEY,FLAGS)	get SysV IPC message queue
msgrcv(ID,VAR,SIZE,TYPE.FLAGS)	receive a SysV IPC message from a message queue
msgsnd(ID,MSG,FLAGS)	send a SysV IPC message to a message queue
my VAR or my (VAR1,...)	Introduces a lexical variable ($VAR, @ARR, or %HASH).
next [LABEL]	iterate a block prematurely
no MODULE [SYMBOL1, ...]  Partial reverse for `use'.  Runs `unimport' method.
oct(EXPR)	convert a string to an octal number
open(FILEHANDLE[,EXPR])	open a file, pipe, or descriptor
opendir(DIRHANDLE,EXPR)	open a directory
ord(EXPR)	ASCII value of the first char of the string.
our VAR or our (VAR1,...) Lexically enable a global variable ($V, @A, or %H).
pack(TEMPLATE,LIST)	convert a list into a binary representation
package NAME	Introduces package context.
__PACKAGE__	Current package.
pipe(READHANDLE,WRITEHANDLE)	Create a pair of filehandles on ends of a pipe.
pop(ARRAY)	remove the last element from an array and return it
pos STRING    Set/Get end-position of the last match over this string, see \\G.
print [FILEHANDLE] [(LIST)]	output a list to a filehandle
printf [FILEHANDLE] (FORMAT,LIST)	output a formatted list to a filehandle
prototype \\&SUB	Returns prototype of the function given a reference.
push(ARRAY,LIST)	append one or more elements to an array
q/STRING/	Synonym for \\='STRING\\='
qq/STRING/	Synonym for \"STRING\"
qr/PATTERN/	compile pattern
quotemeta	quote regular expression magic characters
qw/STRING/	quote a list of words
qx/STRING/	Synonym for \\=`STRING\\=`
rand[(EXPR)]	retrieve the next pseudorandom number
read(FILEHANDLE,SCALAR,LENGTH[,OFFSET])	fixed-length buffered input
readdir(DIRHANDLE)	get a directory from a directory handle
readline FH	Synonym of <FH>.
readlink(EXPR)	determine where a symbolic link is pointing
readpipe CMD	Synonym of \\=`CMD\\=`.
recv(SOCKET,SCALAR,LEN,FLAGS)	receive a message over a Socket
redo [LABEL]	start this loop iteration over again
ref [ EXPR ]	Type of EXPR when dereferenced.
rename(OLDNAME,NEWNAME)	change a filename
require [FILENAME | PERL_VERSION]	load from a library at runtime
reset[(EXPR)]	clear all variables of a given name
return(LIST)	get out of a function early
reverse(LIST)	flip a string or a list
rewinddir(DIRHANDLE)	reset directory handle
rindex(STR,SUBSTR[,OFFSET])	right-to-left substring search
rmdir(FILENAME)	remove a directory
s/PATTERN/REPLACEMENT/gieoxsm	replace a pattern with a string
say [FILEHANDLE] [(LIST)]	output a list, appending a newline
scalar(EXPR)	force a scalar context
seek(FILEHANDLE,POSITION,WHENCE)	reposition file pointer
seekdir(DIRHANDLE,POS)	reposition directory pointer
select(FILEHANDLE)	reset default output or do I/O multiplexing
select(RBITS,WBITS,EBITS,TIMEOUT)	do I/O multiplexing
semctl(ID,SEMNUM,CMD,ARG)	SysV semaphore control operations
semget(KEY,NSEMS,SIZE,FLAGS)	get set of SysV semaphores
semop(KEY,...)	SysV semaphore operations
send(SOCKET,MSG,FLAGS[,TO])	send a message over a socket
setgrent	prepare group file for use
sethostent(STAYOPEN)	prepare hosts file for use
setnetent(STAYOPEN)	prepare networks file for use
setpgrp(PID,PGRP)	set the process group of a process
setpriority(WHICH,WHO,PRIORITY)	Process	set a process\\='s nice value
setprotoent(STAYOPEN)	etwork	prepare protocols file for use
setpwent	prepare passwd file for use
setservent(STAYOPEN)	prepare services file for use
setsockopt(SOCKET,LEVEL,OPTNAME,OPTVAL)	set some socket options
shift[(ARRAY)]	remove the first element of an array, and return it
shmctl(ID,CMD,ARG)	SysV shared memory operations
shmget(KEY,SIZE,FLAGS)	get SysV shared memory segment identifier
shmread(ID,VAR,POS,SIZE)	read SysV shared memory
shmwrite(ID,STRING,POS,SIZE)	write SysV shared memory
shutdown(SOCKET,HOW)	close down just half of a socket connection
sin(EXPR)	return the sine of a number
sleep[(EXPR)]	block for some number of seconds
socket(SOCKET,DOMAIN,TYPE,PROTOCOL)	create a socket
socketpair(SOCKET1,SOCKET2,DOMAIN,TYPE,PROTOCOL)	create a pair of sockets
sort [SUBROUTINE] (LIST)	sort a list of values
splice(ARRAY,OFFSET[,LENGTH[,LIST]])	add or remove elements anywhere
split[(/PATTERN/[,EXPR[,LIMIT]])]	split up a string using a regexp
sprintf(FORMAT,LIST)	formatted print into a string
sqrt(EXPR)	square root function
srand(EXPR)	seed the random number generator
stat(EXPR|FILEHANDLE|VAR)	get a file\\='s status information
state VAR or state (VAR1,...)	Introduces a static lexical variable
study[(SCALAR)]	no-op, formerly optimized input data for repeated searches
sub [NAME [(format)]] { BODY }	sub NAME [(format)];	sub [(format)] {...}
__SUB__	the current subroutine, or C<undef> if not in a subroutine
substr(EXPR,OFFSET[,LEN])	get or alter a portion of a string
symlink(OLDFILE,NEWFILE)	create a symbolic link to a file
syscall(LIST)	execute an arbitrary system call
sysopen FH, FILENAME, MODE [, PERM]	(MODE is numeric, see Fcntl.)
sysread(FILEHANDLE,SCALAR,LENGTH[,OFFSET])	fixed-length unbuffered input
sysseek(FILEHANDLE,POSITION,WHENCE) position I/O pointer on handle
system([TRUENAME] ARGV0 [,ARGV])     or     system(SHELL_COMMAND_LINE)
syswrite(FILEHANDLE,SCALAR,LENGTH[,OFFSET])	fixed-length unbuffered output
tell[(FILEHANDLE)]	get current seekpointer on a filehandle
telldir(DIRHANDLE)	get current seekpointer on a directory handle
tie VAR, CLASS, LIST	Hide an object behind a simple Perl variable.
tied		Returns internal object for a tied data.
time	return number of seconds since 1970
times	return elapsed time for self and child processes
tr/SEARCHLIST/REPLACEMENTLIST/cds	transliterate a string
truncate(FILE|EXPR,LENGTH)	shorten a file
uc [ EXPR ]	Returns upcased EXPR.
ucfirst [ EXPR ]	Returns EXPR with upcased first letter.
umask[(EXPR)]	set file creation mode mask
undef[(EXPR)]	remove a variable or function definition
unlink(LIST)	remove one link to a file
unpack(TEMPLATE,EXPR)	convert binary structure into normal perl variables
unshift(ARRAY,LIST)	prepend more elements to the beginning of a list
untie VAR	Unlink an object from a simple Perl variable.
use MODULE [SYMBOL1, ...]  Compile-time `require' with consequent `import'.
utime(LIST)	set a file\\='s last access and modify times
values(%HASH)	return a list of the values in a hash
vec(EXPR,OFFSET,BITS)	test or set particular bits in a string
wait	wait for any child process to die
waitpid(PID,FLAGS)	wait for a particular child process to die
wantarray	Returns true if the sub/eval is called in list context.
warn(LIST)	print debugging info
write[(EXPR|FILEHANDLE)]	print a picture record
y/SEARCHLIST/REPLACEMENTLIST/	transliterate a string
#!	OS interpreter indicator.  If contains `perl', used for options, and -x.
AUTOLOAD {...}	Shorthand for `sub AUTOLOAD {...}'.
CORE::		Prefix to access builtin function if imported sub obscures it.
SUPER::		Prefix to lookup for a method in @ISA classes.
DESTROY		Shorthand for `sub DESTROY {...}'.
else		Part of if/unless {BLOCK} elsif {BLOCK} else {BLOCK}.
elsif		Part of if/unless {BLOCK} elsif {BLOCK} else {BLOCK}.
default { ... } default case for given/when block
defer { ... }	run this block after the containing block.
for (EXPR;EXPR;EXPR) { ... }
foreach [VAR] (@ARRAY) { ... }
given (EXPR) { [ when (EXPR) { ... } ]+ [ default { ... } ]? }
if (EXPR) { ... } [ elsif (EXPR) { ... } ... ] [ else { ... } ] or EXPR if EXPR
unless (EXPR) { ... } [ else { ... } ] or EXPR unless EXPR
until (EXPR) { ... }	EXPR until EXPR
while  (EXPR) { ... }	EXPR while EXPR
=head1		Top-level heading.
=head2		Second-level heading.
=head3		Third-level heading.
=head4		Fourth-level heading.
=over [ NUMBER ]	Start list.
=item [ TITLE ]		Start new item in the list.
=back		End list.
=cut		Switch from POD to Perl.
=pod		Switch from Perl to POD.
=begin formatname	Start directly formatted region.
=end formatname	End directly formatted region.
=for formatname text	Paragraph in special format.
=encoding encodingname	Encoding of the document.")