UNIX BSD Linux SunOS HP-UX & Perl Man Pages

Man Page or Keyword Search Man Apropos

man page | Documentation Library | Writing UNIX manpages
aarch64-freebsd-c++filt, c++filt(1)
Demangle C++ and Java symbols.
aarch64-freebsd-dlltool, dlltool(1)
Create files needed to build and use DLLs.
aarch64-freebsd-nm, nm(1)
list symbols from object files
aarch64-freebsd-strip, strip(1)
Discard symbols from object files.
aarch64-none-elf-c++filt, c++filt(1)
Demangle C++ and Java symbols.
aarch64-none-elf-dlltool, dlltool(1)
Create files needed to build and use DLLs.
aarch64-none-elf-nm, nm(1)
list symbols from object files
aarch64-none-elf-strip, strip(1)
Discard symbols from object files.
aarch64-unknown-cloudabi-c++filt, c++filt(1)
Demangle C++ and Java symbols.
aarch64-unknown-cloudabi-strip, strip(1)
Discard symbols from object files.
aconnect(1)
ALSA sequencer connection manager
addrinfo(1)
.TH "addrinfo" 1 "Fri Mar 11 2011" "Version 1.12.11" "sofia-sip-utils"
aels(1)
annotated directory listing
aelsf(1)
list source files
aenrls, aegis(1)
new release - create a new project from an old-style project.
akmos(1)
sets of cryptography utils
alcbanner(1)
Display a standardized banner for Alliance tools
alsa-info.sh(1)
command-line utility to gather information about the ALSA subsystem
alsabat(1)
command-line sound tester for ALSA sound card driver
alsactl(1)
advanced controls for ALSA soundcard driver
alsaloop(1)
command-line PCM loopback
alsamixer(1)
soundcard mixer for ALSA soundcard driver, with ncurses interface
amidi(1)
read from and write to ALSA RawMIDI ports
amixer(1)
command-line mixer for ALSA soundcard driver
and(1)
- conditionally execute a command Synopsis COMMAND1; and COMMAND2 Description and is used to execute a command if the current exit status (as set by the previous command) is 0. and statements may be used as part of the condition in an if or while block. See the documentation for if and while for examples. and does not change the current exit status. The exit status of the last foreground command to exit can always be accessed using the $status variable. Example The following code runs the make command to build a program. If the build succeeds, make's exit status is 0, and the program is installed. If either step fails, the exit status is 1, and make clean is run, which removes the files created by the build process. make; and make install; or make clean
anim_track(1)
make an script to model or animate the pads and wheels of a tracked vehicle.
ansible(1)
run a command somewhere else
ansiweather(1)
weather in terminal, with ANSI colors and Unicode symbols
antimicro(1)
map keyboard keys and mouse controls to a gamepad
apertium-desxlsx(1)
This application is part of ( apertium ) This tool is part of the apertium open-source machine translation toolbox: http://www.apertium.org.
apertium-rexlsx(1)
This application is part of ( apertium ) This tool is part of the apertium open-source machine translation toolbox: http://www.apertium.org.
apertium-utils-fixlatex(1)
This application is part of ( apertium ) This tool is part of the apertium open-source machine translation toolbox: http://www.apertium.org.
aplay, arecord(1)
command-line sound recorder and player for ALSA soundcard driver
arm-elf-c++filt, c++filt(1)
Demangle C++ and Java symbols.
arm-elf-dlltool, dlltool(1)
Create files needed to build and use DLLs.
arm-elf-nm, nm(1)
list symbols from object files
arm-elf-strip, strip(1)
Discard symbols from object files.
arm-gnueabi-freebsd-c++filt, c++filt(1)
Demangle C++ and Java symbols.
arm-gnueabi-freebsd-dlltool, dlltool(1)
Create files needed to build and use DLLs.
arm-gnueabi-freebsd-nm, nm(1)
list symbols from object files
arm-gnueabi-freebsd-strip, strip(1)
Discard symbols from object files.
arm-none-eabi-c++filt, c++filt(1)
Demangle C++ and Java symbols.
arm-none-eabi-c++filt, c++filt(1)
Demangle C++ and Java symbols.
arm-none-eabi-dlltool, dlltool(1)
Create files needed to build and use DLLs.
arm-none-eabi-dlltool, dlltool(1)
Create files needed to build and use DLLs.
arm-none-eabi-nm, nm(1)
list symbols from object files
arm-none-eabi-nm, nm(1)
list symbols from object files
arm-none-eabi-strip, strip(1)
Discard symbols from object files.
arm-none-eabi-strip, strip(1)
Discard symbols from object files.
aseqdump(1)
show the events received at an ALSA sequencer port
aseqnet(1)
ALSA sequencer connectors over network
atool, acat, adiff, als, apack, arepack, aunpack(1)
A script for managing file archives of various types
atril-thumbnailer(1)
create png thumbnails from atril supported documents
aubiotrack(1)
- a command line tool to extract musical beats from audio signals
audiopreview(1)
play previews of your audio and video files, and also internet media streams.
auto-add-fdesc-mount, auto-admin(1)
Automated systems management tools
auto-add-linproc-mount, auto-admin(1)
Automated systems management tools
auto-add-proc-mount, auto-admin(1)
Automated systems management tools
auto-adduser, auto-admin(1)
Automated systems management tools
auto-admin(1)
Automated systems management tools
auto-amd-nfs-setup, auto-admin(1)
Automated systems management tools
auto-append-line, auto-admin(1)
Automated systems management tools
auto-ask, auto-admin(1)
Automated systems management tools
auto-backup-file, auto-admin(1)
Automated systems management tools
auto-clean-pkgsrc, auto-admin(1)
Automated systems management tools
auto-clean-ports, auto-admin(1)
Automated systems management tools
auto-config-snd-driver, auto-admin(1)
Automated systems management tools
auto-db-dir, auto-admin(1)
Automated systems management tools
auto-denyhosts-remove-ip, auto-admin(1)
Automated systems management tools
auto-denyhosts-setup, auto-admin(1)
Automated systems management tools
auto-detect-intel-gpu, auto-admin(1)
Automated systems management tools
auto-disable-service, auto-admin(1)
Automated systems management tools
auto-disable-tcp-timestamps, auto-admin(1)
Automated systems management tools
auto-enable-autologout, auto-admin(1)
Automated systems management tools
auto-enable-compat32, auto-admin(1)
Automated systems management tools
auto-enable-hal-mount, auto-admin(1)
Automated systems management tools
auto-enable-passwdqc, auto-admin(1)
Automated systems management tools
auto-enable-procfs, auto-admin(1)
Automated systems management tools
auto-enable-service, auto-admin(1)
Automated systems management tools
auto-fastest-mirror, auto-admin(1)
Automated systems management tools
auto-file-secure, auto-admin(1)
Automated systems management tools
auto-harden, auto-admin(1)
Automated systems management tools
auto-insert-line, auto-admin(1)
Automated systems management tools
auto-install-packages, auto-admin(1)
Automated systems management tools
auto-ipfw-gateway-setup, auto-admin(1)
Automated systems management tools
auto-kdm3-toggle, auto-admin(1)
Automated systems management tools
auto-ldap-adduser, auto-admin(1)
Automated systems management tools
auto-ldap-client-setup, auto-admin(1)
Automated systems management tools
auto-mount-any, auto-admin(1)
Automated systems management tools
auto-ostype, auto-admin(1)
Automated systems management tools
auto-package-installed, auto-admin(1)
Automated systems management tools
auto-pkgsrc-add-license, auto-admin(1)
Automated systems management tools
auto-pkgsrc-setup, auto-admin(1)
Automated systems management tools
auto-pkgsrc-wip-checkout, auto-admin(1)
Automated systems management tools
auto-ports-checkout, auto-admin(1)
Automated systems management tools
auto-print-make-variable, auto-admin(1)
Automated systems management tools
auto-pxe-installer-setup, auto-admin(1)
Automated systems management tools
auto-pxe-node-discover, auto-admin(1)
Automated systems management tools
auto-replace-file, auto-admin(1)
Automated systems management tools
auto-restore-pw, auto-admin(1)
Automated systems management tools
auto-restore-user, auto-admin(1)
Automated systems management tools
auto-service-enabled, auto-admin(1)
Automated systems management tools
auto-set-suspend-mode, auto-admin(1)
Automated systems management tools
auto-set-sysctl, auto-admin(1)
Automated systems management tools
auto-set-umask, auto-admin(1)
Automated systems management tools
auto-ssh-authorize, auto-admin(1)
Automated systems management tools
auto-ssh-reverse-authorize, auto-admin(1)
Automated systems management tools
auto-update-port-framework, auto-admin(1)
Automated systems management tools
auto-update-system, auto-admin(1)
Automated systems management tools
auto-update-xorg.conf, auto-admin(1)
Automated systems management tools
auto-using-pkgng, auto-admin(1)
Automated systems management tools
auto-using-pkgsrc, auto-admin(1)
Automated systems management tools
auto-wifi-failover, auto-admin(1)
Automated systems management tools
auto-xdm-toggle, auto-admin(1)
Automated systems management tools
avr-c++filt, c++filt(1)
Demangle C++ and Java symbols.
avr-dlltool, dlltool(1)
Create files needed to build and use DLLs.
avr-nm, nm(1)
list symbols from object files
avr-strip, strip(1)
Discard symbols from object files.
awesome-client(1)
awesome Fenstermanager externe Befehlsschnittstelle
balls(1, l)
preprocessor for space-filling models in Raster3D molecular graphics package
balsa, Balsa(1)
the GNOME email client.
bcftools(1)
utilities for variant calling and manipulating VCFs and BCFs.
bind(1)
- handle fish key bindings Synopsis bind [(-M | --mode) MODE] [(-m | --sets-mode) NEW_MODE] [(-k | --key)] SEQUENCE COMMAND [COMMAND...] bind [(-M | --mode) MODE] [(-k | --key)] SEQUENCE bind (-K | --key-names) [(-a | --all)] bind (-f | --function-names) bind (-e | --erase) [(-M | --mode) MODE] (-a | --all | [(-k | --key)] SEQUENCE [SEQUENCE...]) Description bind adds a binding for the specified key sequence to the specified command. SEQUENCE is the character sequence to bind to. These should be written as fish escape sequences. For example, because pressing the Alt key and another character sends that character prefixed with an escape character, Alt-based key bindings can be written using the \e escape. For example, [Alt-w] can be written as \ew. The control character can be written in much the same way using the \c escape, for example [Control-X] (^X) can be written as \cx. Note that Alt-based key bindings are case sensitive and Control-based key bindings are not. This is a constraint of text-based terminals, not fish. The default key binding can be set by specifying a SEQUENCE of the empty string (that is, '' ). It will be used whenever no other binding matches. For most key bindings, it makes sense to use the self-insert function (i.e. bind '' self-insert) as the default keybinding. This will insert any keystrokes not specifically bound to into the editor. Non- printable characters are ignored by the editor, so this will not result in control sequences being printable. If the -k switch is used, the name of the key (such as 'down', 'up' or 'backspace') is used instead of a sequence. The names used are the same as the corresponding curses variables, but without the 'key_' prefix. (See terminfo(5) for more information, or use bind --key-names for a list of all available named keys.) COMMAND can be any fish command, but it can also be one of a set of special input functions. These include functions for moving the cursor, operating on the kill-ring, performing tab completion, etc. Use bind --function-names for a complete list of these input functions. When COMMAND is a shellscript command, it is a good practice to put the actual code into a function and simply bind to the function name. This way it becomes significantly easier to test the function while editing, and the result is usually more readable as well. If such a script produces output, the script needs to finish by calling commandline -f repaint in order to tell fish that a repaint is in order. When multiple COMMANDs are provided, they are all run in the specified order when the key is pressed. If no SEQUENCE is provided, all bindings (or just the bindings in the specified MODE) are printed. If SEQUENCE is provided without COMMAND, just the binding matching that sequence is printed. Key bindings are not saved between sessions by default. Bare bind statements in config.fish won't have any effect because it is sourced before the default keybindings are setup. To save custom keybindings, put the bind statements into a function called fish_user_key_bindings, which will be autoloaded. Key bindings may use 'modes', which mimics Vi's modal input behavior. The default mode is 'default', and every bind applies to a single mode. The mode can be viewed/changed with the $fish_bind_mode variable. The following parameters are available: o 2 -k or --key Specify a key name, such as 'left' or 'backspace' instead of a character sequence o 2 -K or --key-names Display a list of available key names. Specifying -a or --all includes keys that don't have a known mapping o 2 -f or --function-names Display a list of available input functions o 2 -M MODE or --mode MODE Specify a bind mode that the bind is used in. Defaults to 'default' o 2 -m NEW_MODE or --sets-mode NEW_MODE Change the current mode to NEW_MODE after this binding is executed o 2 -e or --erase Erase the binding with the given sequence and mode instead of defining a new one. Multiple sequences can be specified with this flag. Specifying -a or --all with -M or --mode erases all binds in the given mode regardless of sequence. Specifying -a or --all without -M or --mode erases all binds in all modes regardless of sequence. o 2 -a or --all See --erase and --key-names The following special input functions are available: o 2 accept-autosuggestion, accept the current autosuggestion completely o 2 backward-char, moves one character to the left o 2 backward-bigword, move one whitespace-delimited word to the left o 2 backward-delete-char, deletes one character of input to the left of the cursor o 2 backward-kill-bigword, move the whitespace-delimited word to the left of the cursor to the killring o 2 backward-kill-line, move everything from the beginning of the line to the cursor to the killring o 2 backward-kill-path-component, move one path component to the left of the cursor (everything from the last '/' or whitespace exclusive) to the killring o 2 backward-kill-word, move the word to the left of the cursor to the killring o 2 backward-word, move one word to the left o 2 beginning-of-buffer, moves to the beginning of the buffer, i.e. the start of the first line o 2 beginning-of-history, move to the beginning of the history o 2 beginning-of-line, move to the beginning of the line o 2 begin-selection, start selecting text o 2 capitalize-word, make the current word begin with a capital letter o 2 complete, guess the remainder of the current token o 2 complete-and-search, invoke the searchable pager on completion options (for convenience, this also moves backwards in the completion pager) o 2 delete-char, delete one character to the right of the cursor o 2 downcase-word, make the current word lowercase o 2 end-of-buffer, moves to the end of the buffer, i.e. the end of the first line o 2 end-of-history, move to the end of the history o 2 end-of-line, move to the end of the line o 2 end-selection, end selecting text o 2 forward-bigword, move one whitespace-delimited word to the right o 2 forward-char, move one character to the right o 2 forward-word, move one word to the right o 2 history-search-backward, search the history for the previous match o 2 history-search-forward, search the history for the next match o 2 kill-bigword, move the next whitespace-delimited word to the killring o 2 kill-line, move everything from the cursor to the end of the line to the killring o 2 kill-selection, move the selected text to the killring o 2 kill-whole-line, move the line to the killring o 2 kill-word, move the next word to the killring o 2 suppress-autosuggestion, remove the current autosuggestion o 2 swap-selection-start-stop, go to the other end of the highlighted text without changing the selection o 2 transpose-chars, transpose two characters to the left of the cursor o 2 transpose-words, transpose two words to the left of the cursor o 2 upcase-word, make the current word uppercase o 2 yank, insert the latest entry of the killring into the buffer o 2 yank-pop, rotate to the previous entry of the killring Examples bind \cd 'exit' Causes fish to exit when [Control-D] is pressed. bind -k ppage history-search-backward Performs a history search when the [Page Up] key is pressed. set -g fish_key_bindings fish_vi_key_bindings bind -M insert \cc kill-whole-line force-repaint Turns on Vi key bindings and rebinds [Control-C] to clear the input line. Special Case: The escape Character The escape key can be used standalone, for example, to switch from insertion mode to normal mode when using Vi keybindings. Escape may also be used as a 'meta' key, to indicate the start of an escape sequence, such as function or arrow keys. Custom bindings can also be defined that begin with an escape character. fish waits for a period after receiving the escape character, to determine whether it is standalone or part of an escape sequence. While waiting, additional key presses make the escape key behave as a meta key. If no other key presses come in, it is handled as a standalone escape. The waiting period is set to 300 milliseconds (0.3 seconds) in the default key bindings and 10 milliseconds in the vi key bindings. It can be configured by setting the fish_escape_delay_ms variable to a value between 10 and 5000 ms. It is recommended that this be a universal variable that you set once from an interactive session. Note: fish 2.2.0 and earlier used a default of 10 milliseconds, and provided no way to configure it. That effectively made it impossible to use escape as a meta key.
blkls(1)
List or output file system data units.
blkstat(1)
Display details of a file system data unit (i.e. block or sector)
bombardment(1)
Run siege with an ever-increasing number of users SYNOPSIS bombardment [urlfile] [clients] [increment] [trials] [delay] bombardment urls.txt 5 10 20 1
bp_classify_hits_kingdom.pl, bp_classify_hits_kingdom(1)
classify BLAST hits by taxonomic kingdom USAGE bp_classify_hits_kingdom [-i tab_file] [-i second_BLAST_file] [-e evalue_cutoff] [-t dir_where_TAXONOMY_files_are] [-g gi2taxid] [-z PATH_TO_zcat] [-v] DESCRIPTION Will print out the taxonomic distribution (at the kingdom level) for a set of hits against the NR database. By default, this script assumes you did a search against the protein database (gi_taxid_nuc.dump file). This expects BLAST files in tabbed -m9 or -m8 format. Output with -m 8 or use blast2table.pl to convert (or fastam9_to_table.PLS if using FASTA). CW Input values: -t/--taxonomy Directory where the taxonomy .dmp files are (from NCBI) -g/--gi File path of the gi2taxid file (gi_taxid_prot.dmp for proteins or gi_taxid_nucl.dmp if the search was against a nucleid database) -i/--in The name of the tab delimited -m8/-m9 output files to process -e/--evalue Provide an E-value cutoff for hits to be considered -z/--zcat Path to the 'zcat' executable, can also be 'gunzip -c' if no zcat on your system. Flags: -v/--verbose To turn on verbose messages -h/--help Display this helpful information R This is intended to be useful starting script, but users may want to customize the output and parameters. Note that I am summarizing the kingdoms here and Eukaryota not falling into Metazoa, Viridiplantae, or Fungi gets grouped into the general superkingdom Eukaryota for simplicity. There are comments in the code directing you to where changes can be made if you wanted to display hits by phylum for example. Note that you must wipe out the cache file 'gi2class' that is created in your directory after making these changes. AUTHOR Jason Stajich jason_at_bioperl_dot_org
bp_nrdb.pl, bp_nrdb.PLS(1)
a script to emulate Warren Gish's nrdb, make a unique sequence database from a set of input databases
breakpoint(1)
- Launch debug mode Synopsis breakpoint Description breakpoint is used to halt a running script and launch an interactive debugging prompt. For more details, see Debugging fish scripts in the fish manual. There are no parameters for breakpoint.
bsnmpget, bsnmpset, bsnmpwalk(1)
simple tools for querying SNMP agents
builtin, alias, alloc, bg, bind, bindkey, break, breaksw, builtins, case, cd, chdir, command, complete, continue, default, dirs, do, done, echotc, elif, else, end, endif, endsw, esac, eval, exec, exit, export, fc, fg, fi, filetest, for, foreach, getopts, glob, goto, hash, hashstat, history, hup, if, jobid, jobs, limit, log, logout, ls-F, notify, onintr, popd, pushd, read, readonly, rehash, repeat, sched, set, setenv, settc, setty, setvar, shift, source, stop, suspend, switch, telltc, then, times, trap, type, ulimit, umask, unalias, uncomplete, unhash, unlimit, unset, unsetenv, until, wait, where, while, !, %, ., :, @, [, echo, false, kill, local, login, nice, nohup, printenv, printf, pwd, return, test, time, true, which, {, }(1)
shell built-in commands
builtin, alias, alloc, bg, bind, bindkey, break, breaksw, builtins, case, cd, chdir, command, complete, continue, default, dirs, do, done, echotc, elif, else, end, endif, endsw, esac, eval, exec, exit, export, fc, fg, fi, filetest, for, foreach, getopts, glob, goto, hash, hashstat, history, hup, if, jobid, jobs, limit, log, logout, ls-F, notify, onintr, popd, pushd, read, readonly, rehash, repeat, sched, set, setenv, settc, setty, setvar, shift, source, stop, suspend, switch, telltc, then, trap, type, ulimit, umask, unalias, uncomplete, unhash, unlimit, unset, unsetenv, until, wait, where, while(1)
??????????????????????
c++filt(1)
decode C++ symbols
c++filt(1)
Demangle C++ and Java symbols.
callpass(1)
generate Pass-code associated with your callsign for authentication via xastir to APRS(tm) network.
case(1)
- conditionally execute a block of commands Synopsis switch VALUE; [case [WILDCARD...]; [COMMANDS...]; ...] end Description switch performs one of several blocks of commands, depending on whether a specified value equals one of several wildcarded values. case is used together with the switch statement in order to determine which block should be executed. Each case command is given one or more parameters. The first case command with a parameter that matches the string specified in the switch command will be evaluated. case parameters may contain wildcards. These need to be escaped or quoted in order to avoid regular wildcard expansion using filenames. Note that fish does not fall through on case statements. Only the first matching case is executed. Note that command substitutions in a case statement will be evaluated even if its body is not taken. All substitutions, including command substitutions, must be performed before the value can be compared against the parameter. Example If the variable $animal contains the name of an animal, the following code would attempt to classify it: switch $animal case cat echo evil case wolf dog human moose dolphin whale echo mammal case duck goose albatross echo bird case shark trout stingray echo fish Note that the next case has a wildcard which is quoted case '*' echo I have no idea what a $animal is end If the above code was run with $animal set to whale, the output would be mammal.
cd(1)
- change directory Synopsis cd [DIRECTORY] Description cd changes the current working directory. If DIRECTORY is supplied, it will become the new directory. If no parameter is given, the contents of the HOME environment variable will be used. If DIRECTORY is a relative path, the paths found in the CDPATH environment variable array will be tried as prefixes for the specified path. Note that the shell will attempt to change directory without requiring cd if the name of a directory is provided (starting with ., / or ~, or ending with /). Fish also ships a wrapper function around the builtin cd that understands cd - as changing to the previous directory. See also prevd. This wrapper function maintains a history of the 25 most recently visited directories in the $dirprev and $dirnext global variables. Examples cd changes the working directory to your home directory. cd /usr/src/fish-shell changes the working directory to /usr/src/fish-shell
cdlabelgen(1)
CD/DVD labels, jewel case inserts, and envelopes creator. Generates frontcards and traycards for CD cases, single-cd envelopes, DVD case inserts, as well as output suitable for direct printing on CD/DVD.
centerim(1)
a text mode based IM client for Linux, *BSD, Sun Solaris, MacOS X and possibly, other Unices. ICQ2000, Yahoo!, AIM TOC, IRC, MSN, Gadu-Gadu and Jabber protocols are now supported. Internal LiveJournal client and RSS reader are also provided.
certtool(1)
GnuTLS certificate tool
ceylon(1)
The top level Ceylon tool is used to execute other Ceylon tools
ceylon-classpath, ceylon(1)
classpath - Prints a classpath suitable for passing to Java tools to run a given Ceylon module
ceylon-help, ceylon(1)
help - Displays help information about other Ceylon tools
ceylon-jigsaw, ceylon(1)
jigsaw - Tools to interop with Java 9 (Jigsaw) modules
chk4mail(1)
list the number of mails in your mailfolders
chkimap(1)
list the number of mails in your IMAP folders
chmls(1)
The FPC Pascal CHM utility
chronic(1)
runs a command quietly unless it fails
cidcall(1)
view calls, hangups, messages, and end of calls in the NCID call file
cinnamon-screensaver-command(1)
controls Cinnamon screensaver
clsync(1)
live sync tool, written in GNU C
cmdtest(1)
blackbox testing of Unix command line tools
cmdwatch(1)
execute a program periodically, showing output fullscreen
coil(1)
Generate various types of coils, using pipe control points calculated from coil dimensions.
command(1)
- run a program Synopsis command [OPTIONS] COMMANDNAME [ARGS...] Description command forces the shell to execute the program COMMANDNAME and ignore any functions or builtins with the same name. The following options are available: o 2 -s or --search returns the name of the disk file that would be executed, or nothing if no file with the specified name could be found in the $PATH. With the -s option, command treats every argument as a separate command to look up and sets the exit status to 0 if any of the specified commands were found, or 1 if no commands could be found. Additionally passing a -q or --quiet option prevents any paths from being printed, like the type -q, for testing only the exit status. For basic compatibility with POSIX command, the -v flag is recognized as an alias for -s. Examples command ls causes fish to execute the ls program, even if an ls function exists. command -s ls returns the path to the ls program.
complete(1)
- edit command specific tab-completions Synopsis complete ( -c | --command | -p | --path ) COMMAND [( -c | --command | -p | --path ) COMMAND]... [( -e | --erase )] [( -s | --short-option ) SHORT_OPTION]... [( -l | --long-option | -o | --old-option ) LONG_OPTION]... [( -a | --arguments ) OPTION_ARGUMENTS] [( -f | --no-files )] [( -r | --require-parameter )] [( -x | --exclusive )] [( -w | --wraps ) WRAPPED_COMMAND]... [( -n | --condition ) CONDITION] [( -d | --description ) DESCRIPTION] complete ( -C[STRING] | --do-complete[=STRING] ) Description For an introduction to specifying completions, see Writing your own completions in the fish manual. o 2 COMMAND is the name of the command for which to add a completion. o 2 SHORT_OPTION is a one character option for the command. o 2 LONG_OPTION is a multi character option for the command. o 2 OPTION_ARGUMENTS is parameter containing a space-separated list of possible option-arguments, which may contain command substitutions. o 2 DESCRIPTION is a description of what the option and/or option arguments do. o 2 -c COMMAND or --command COMMAND specifies that COMMAND is the name of the command. o 2 -p COMMAND or --path COMMAND specifies that COMMAND is the absolute path of the program (optionally containing wildcards). o 2 -e or --erase deletes the specified completion. o 2 -s SHORT_OPTION or --short-option=SHORT_OPTION adds a short option to the completions list. o 2 -l LONG_OPTION or --long-option=LONG_OPTION adds a GNU style long option to the completions list. o 2 -o LONG_OPTION or --old-option=LONG_OPTION adds an old style long option to the completions list (See below for details). o 2 -a OPTION_ARGUMENTS or --arguments=OPTION_ARGUMENTS adds the specified option arguments to the completions list. o 2 -f or --no-files specifies that the options specified by this completion may not be followed by a filename. o 2 -r or --require-parameter specifies that the options specified by this completion always must have an option argument, i.e. may not be followed by another option. o 2 -x or --exclusive implies both -r and -f. o 2 -w WRAPPED_COMMAND or --wraps=WRAPPED_COMMAND causes the specified command to inherit completions from the wrapped command (See below for details). o 2 -n or --condition specifies a shell command that must return 0 if the completion is to be used. This makes it possible to specify completions that should only be used in some cases. o 2 -CSTRING or --do-complete=STRING makes complete try to find all possible completions for the specified string. o 2 -C or --do-complete with no argument makes complete try to find all possible completions for the current command line buffer. If the shell is not in interactive mode, an error is returned. o 2 -A and --authoritative no longer do anything and are silently ignored. o 2 -u and --unauthoritative no longer do anything and are silently ignored. Command specific tab-completions in fish are based on the notion of options and arguments. An option is a parameter which begins with a hyphen, such as '-h', '-help' or '--help'. Arguments are parameters that do not begin with a hyphen. Fish recognizes three styles of options, the same styles as the GNU version of the getopt library. These styles are: o 2 Short options, like '-a'. Short options are a single character long, are preceded by a single hyphen and may be grouped together (like '-la', which is equivalent to '-l -a'). Option arguments may be specified in the following parameter ('-w 32') or by appending the option with the value ('-w32'). o 2 Old style long options, like '-Wall'. Old style long options can be more than one character long, are preceded by a single hyphen and may not be grouped together. Option arguments are specified in the following parameter ('-ao null'). o 2 GNU style long options, like '--colors'. GNU style long options can be more than one character long, are preceded by two hyphens, and may not be grouped together. Option arguments may be specified in the following parameter ('--quoting-style shell') or by appending the option with a '=' and the value ('--quoting-style=shell'). GNU style long options may be abbreviated so long as the abbreviation is unique ('--h') is equivalent to '--help' if help is the only long option beginning with an 'h'). The options for specifying command name and command path may be used multiple times to define the same completions for multiple commands. The options for specifying command switches and wrapped commands may be used multiple times to define multiple completions for the command(s) in a single call. Invoking complete multiple times for the same command adds the new definitions on top of any existing completions defined for the command. When -a or --arguments is specified in conjunction with long, short, or old style options, the specified arguments are only used as completions when attempting to complete an argument for any of the specified options. If -a or --arguments is specified without any long, short, or old style options, the specified arguments are used when completing any argument to the command (except when completing an option argument that was specified with -r or --require-parameter). Command substitutions found in OPTION_ARGUMENTS are not expected to return a space-separated list of arguments. Instead they must return a newline-separated list of arguments, and each argument may optionally have a tab character followed by the argument description. Any description provided in this way overrides a description given with -d or --description. The -w or --wraps options causes the specified command to inherit completions from another command. The inheriting command is said to 'wrap' the inherited command. The wrapping command may have its own completions in addition to inherited ones. A command may wrap multiple commands, and wrapping is transitive: if A wraps B, and B wraps C, then A automatically inherits all of C's completions. Wrapping can be removed using the -e or --erase options. Note that wrapping only works for completions specified with -c or --command and are ignored when specifying completions with -p or --path. When erasing completions, it is possible to either erase all completions for a specific command by specifying complete -c COMMAND -e, or by specifying a specific completion option to delete by specifying either a long, short or old style option. Example The short style option -o for the gcc command requires that a file follows it. This can be done using writing: complete -c gcc -s o -r The short style option -d for the grep command requires that one of the strings 'read', 'skip' or 'recurse' is used. This can be specified writing: complete -c grep -s d -x -a 'read skip recurse' The su command takes any username as an argument. Usernames are given as the first colon-separated field in the file /etc/passwd. This can be specified as: complete -x -c su -d 'Username' -a '(cat /etc/passwd | cut -d : -f 1)' The rpm command has several different modes. If the -e or --erase flag has been specified, rpm should delete one or more packages, in which case several switches related to deleting packages are valid, like the nodeps switch. This can be written as: complete -c rpm -n '__fish_contains_opt -s e erase' -d nodeps 'Don't check dependencies' where __fish_contains_opt is a function that checks the command line buffer for the presence of a specified set of options. To implement an alias, use the -w or --wraps option: complete -c hub -w git Now hub inherits all of the completions from git. Note this can also be specified in a function declaration.
connect-tunnel(1)
Create CONNECT tunnels through HTTP proxies
contains(1)
- test if a word is present in a list Synopsis contains [OPTIONS] KEY [VALUES...] Description contains tests whether the set VALUES contains the string KEY. If so, contains exits with status 0; if not, it exits with status 1. The following options are available: o 2 -i or --index print the word index Note that, like GNU tools, contains interprets all arguments starting with a - as options to contains, until it reaches an argument that is -- (two dashes). See the examples below. Example for i in ~/bin /usr/local/bin if not contains $i $PATH set PATH $PATH $i end end The above code tests if ~/bin and /usr/local/bin are in the path and adds them if not. function hasargs if contains -- -q $argv echo '$argv contains a -q option' end end The above code checks for -q in the argument list, using the -- argument to demarcate options to contains from the key to search for.
cook_bom(1)
bill of materials
copyauth(1)
Copies user's AFS credentials to a new cell
couriertls(1)
the Courier mail server TLS/SSL protocol wrapper
cpmls(1)
list sorted contents of directory
createPYMB, mb2org, readPYBase, readPYMB, scel2org(1)
fcitx Pinyin related tools
cvsutils(1)
CVS utilities for use in working directories
cwstudio(1)
lightweight and portable CW signals generator with Curses UI
d.labels(1)
d.labels
d.paint.labels(1)
Full index ? 2003-2016 GRASS Development Team
dane(1)
Generate TLSA/HASTLS DNS records by scanning SSL/TLS sites
dateutils(1)
command line date and time utilities
dbmail-deliver(1)
inserts messages into the DBMail mailsystem.
dbmail-smtp(1)
inserts messages into the DBMail mailsystem.
dcmcjpls(1)
Encode DICOM file to JPEG-LS transfer syntax
dcmdjpls(1)
Decode JPEG-LS compressed DICOM file
demandoc(1)
emit only text of UNIX manuals
depdiagram-generate(1)
KDE API documentation generation tools
depdiagram-generate-all(1)
KDE API documentation generation tools
devilspie(1)
perform actions on windows as they are created
dhcpd-pools(1)
ISC dhcpd pools usage analysis
dircolors(1)
color setup for ls
distfind, Dist::Joseki(1)
tools for the prolific module author
djvutoxml, djvuxmlparser, djvuxml(1)
DjVuLibre XML Tools.
dlltool(1)
Create files needed to build and use DLLs.
dlsdump(1)
List informations about a DLS (Downloadable Sound) file.
doveadm-altmove(1)
Move matching mails to the alternative storage (dbox-only)
doveadm-mount(1)
Manage the list of mountpoints where mails are stored
dpkg-gensymbols(1)
dpkg-gensymbols
dpkg-gensymbols(1)
dpkg-gensymbols
dpkg-gensymbols(1)
dpkg-gensymbols
dpkg-gensymbols(1)
generate symbols files (shared library dependency information)
dpkg-gensymbols(1)
dpkg-gensymbols
drempels(1)
Hallucinatory desktop enhancer.
ecaconvert, ecatools(1)
audio processing utils based on ecasound
ecafixdc, ecatools(1)
audio processing utils based on ecasound
ecamonitor, ecatools(1)
audio processing utils based on ecasound
ecanormalize, ecatools(1)
audio processing utils based on ecasound
ecaplay, ecatools(1)
audio processing utils based on ecasound
ecasignalview, ecatools(1)
audio processing utils based on ecasound
ecatools(1)
audio processing utils based on ecasound
elfls(1)
display the contents of an ELF file
else(1)
- execute command if a condition is not met Synopsis if CONDITION; COMMANDS_TRUE...; [else; COMMANDS_FALSE...;] end Description if will execute the command CONDITION. If the condition's exit status is 0, the commands COMMANDS_TRUE will execute. If it is not 0 and else is given, COMMANDS_FALSE will be executed. Example The following code tests whether a file foo.txt exists as a regular file. if test -f foo.txt echo foo.txt exists else echo foo.txt does not exist end
elvi, acronym, ads, alioth, amazon, archpkg, archwiki, arxiv, ask, aur, austlii, bbcnews, bing, bookfinder, bugmenot, bugzilla, cablesearch, cia, cite, cliki, cnn, comlaw, ctan, currency, cve, debbugs, debcodesearch, debcontents, deblists, deblogs, debpackages, debpkghome, debpts, debsec, debvcsbrowse, debwiki, deja, deli, discogs, dmoz, duckduckgo, ebay, etym, excite, finkpkg, foldoc, freebsd, freedb, freshmeat, fsfdir, gcache, genbugs, genportage, github, google, gutenberg, imdb, ixquick, jamendo, javasun, l1sp, lastfm, leodict, lsm, macports, mathworld, mdn, mininova, musicbrainz, mysqldoc, netbsd, ntrs, openbsd, openports, opensearch, oraclesearch, pasearch, pgdoc, pgpkeys, phpdoc, pin, piratebay, priberam, pubmed, rae, rfc, rhyme, rpmsearch, S, scholar, scicom, scirus, scpan, slashdot, slinuxdoc, sourceforge, springer, stack, stockquote, thesaurus, translate, urban, W, w3css, w3html, w3link, w3rdf, wayback, webster, wetandwild, wikipedia, woffle, wolfram, worldwidescience, yacy, yahoo, yandex, youtube, yubnub(1, 1sr)
surfraw(1) search tools
emacsclient(1)
tells a running Emacs to visit a file
email2smssend(1)
Send your emails to your GSM with smssend
encapsulate(1)
multiplex several channels over a single socket with sampling of remote process exit status, and provide conversation termination without closing the socket. netpipes 4.2
end(1)
- end a block of commands. Synopsis begin; [COMMANDS...] end if CONDITION; COMMANDS_TRUE...; [else; COMMANDS_FALSE...;] end while CONDITION; COMMANDS...; end for VARNAME in [VALUES...]; COMMANDS...; end switch VALUE; [case [WILDCARD...]; [COMMANDS...]; ...] end Description end ends a block of commands. For more information, read the documentation for the block constructs, such as if, for and while. The end command does not change the current exit status.
erlsrv(1)
Run the Erlang emulator as a service on Windows NT(R)
esdcompat(1)
PulseAudio ESD wrapper script
euare-releaserole(1)
Release IAM role credentials
euca-describe-network-acls(1)
Describe one or more network ACLs
euca-version(1)
Display the euca2ools suite's version
eval(1)
- evaluate the specified commands Synopsis eval [COMMANDS...] Description eval evaluates the specified parameters as a command. If more than one parameter is specified, all parameters will be joined using a space character as a separator. Example The following code will call the ls command. Note that fish does not support the use of shell variables as direct commands; eval can be used to work around this. set cmd ls eval $cmd
exa(1)
a modern replacement for ls
exfalso(1)
audio tag editor
exo-open(1)
Open URLs and launch preferred applications
exrtools(1)
a collection of utilities for manipulating OpenEXR images
extraclangtools-devel, extraclangtools(1)
Extra Clang Tools Documentation Welcome to the clang-tools-extra project which contains extra tools built using Clang's tooling API's.
extraclangtools38, extraclangtools(1)
Extra Clang Tools Documentation Welcome to the clang-tools-extra project which contains extra tools built using Clang's tooling API's.
extraclangtools39, extraclangtools(1)
Extra Clang Tools Documentation Welcome to the clang-tools-extra project which contains extra tools built using Clang's tooling API's.
extraclangtools40, extraclangtools(1)
Extra Clang Tools Documentation Welcome to the clang-tools-extra project which contains extra tools built using Clang's tooling API's.
extract_url(1)
extract URLs from email messages
extract_vba(1)
A utility to extract a VBA project from an Excel 2007+ xlsm file.
ezmlm-check(1)
Mails back results of ezmlm list check
faked(1)
Daemon, der sich an gef??lschte Besitz-/Zugriffsrechte von Dateien erinnert, die durch fakeroot-Prozesse manipuliert wurden
fakeroot(1)
einen Befehl zur Dateimanipulation in einer Umgebung mit gef??lschten Root-Rechten ausf??hren
false(1)
return false value
false(1)
- return an unsuccessful result Synopsis false Description false sets the exit status to 1.
false(1)
?????????? ???? ????????
false(1)
????????????????
fasta36, fastf35, fastm35, fasts35, fastx35, fasty35, ggsearch35, lalign35, prfx35, prss35, ssearch35, tfasta35, tfastf35, tfasts35, tfastx35, tfasty35(1, local)
scan a protein or DNA sequence library for similar sequences fastx36 - compare a DNA sequence to a protein sequence database, comparing the translated DNA sequence in forward and reverse frames. tfastx36 - compare a protein sequence to a DNA sequence database, calculating similarities with frameshifts to the forward and reverse orientations. fasty36 - compare a DNA sequence to a protein sequence database, comparing the translated DNA sequence in forward and reverse frames. tfasty36 - compare a protein sequence to a DNA sequence database, calculating similarities with frameshifts to the forward and reverse orientations. fasts36 - compare unordered peptides to a protein sequence database fastm36 - compare ordered peptides (or short DNA sequences) to a protein (DNA) sequence database tfasts36 - compare unordered peptides to a translated DNA sequence database fastf36 - compare mixed peptides to a protein sequence database tfastf36 - compare mixed peptides to a translated DNA sequence database ssearch36 - compare a protein or DNA sequence to a sequence database using the Smith-Waterman algorithm. ggsearch36 - compare a protein or DNA sequence to a sequence database using a global alignment (Needleman-Wunsch) glsearch36 - compare a protein or DNA sequence to a sequence database with alignments that are global in the query and local in the database sequence (global-local). lalign36 - produce multiple non-overlapping alignments for protein and DNA sequences using the Huang and Miller sim algorithm for the Waterman-Eggert algorithm. prss36, prfx36 - discontinued; all the FASTA programs will estimate statistical significance using 500 shuffled sequence scores if two sequences are compared.
ffmpeg-protocols(1)
FFmpeg protocols
ffmpeg-utils(1)
FFmpeg utilities
fid(1)
List identifiers in F1; if F2 is also given, list those common to both
fish_key_reader(1)
- explore what characters keyboard keys send Synopsis fish_key_reader [OPTIONS] Description fish_key_reader is used to study input received from the terminal and can help with key binds. The program is interactive and works on standard input. Individual characters themselves and their hexadecimal values are displayed. The tool will write an example bind command matching the character sequence captured to stdout. If the character sequence matches a special key name (see bind --key-names), both bind CHARS ... and bind -k KEYNAME ... usage will be shown. Additional details about the characters received, such as the delay between chars, are written to stderr. The following options are available: o 2 -c or --continuous begins a session where multiple key sequences can be inspected. By default the program exits after capturing a single key sequence. o 2 -d or --debug-level=DEBUG_LEVEL enables debug output and specifies a verbosity level (like fish -d). Defaults to 0. o 2 -D or --debug-stack-frames=DEBUG_LEVEL specify how many stack frames to display when debug messages are written. The default is zero. A value of 3 or 4 is usually sufficient to gain insight into how a given debug call was reached but you can specify a value up to 128. o 2 -h or --help prints usage information. Usage Notes The delay in milliseconds since the previous character was received is included in the diagnostic information written to stderr. This information may be useful to determine the optimal fish_escape_delay_ms setting or learn the amount of lag introduced by tools like ssh, mosh or tmux. fish_key_reader intentionally disables handling of many signals. To terminate fish_key_reader in --continuous mode do: o 2 press Ctrl-C twice, or o 2 press Ctrl-D twice, or o 2 type exit, or o 2 type quit
fish_key_reader(1)
- explore what characters keyboard keys send Synopsis fish_key_reader [OPTIONS] Description fish_key_reader is used to study input received from the terminal and can help with key binds. The program is interactive and works on standard input. Individual characters themselves and their hexadecimal values are displayed. The tool will write an example bind command matching the character sequence captured to stdout. If the character sequence matches a special key name (see bind --key-names), both bind CHARS ... and bind -k KEYNAME ... usage will be shown. Additional details about the characters received, such as the delay between chars, are written to stderr. The following options are available: o 2 -c or --continuous begins a session where multiple key sequences can be inspected. By default the program exits after capturing a single key sequence. o 2 -d or --debug-level=DEBUG_LEVEL enables debug output and specifies a verbosity level (like fish -d). Defaults to 0. o 2 -D or --debug-stack-frames=DEBUG_LEVEL specify how many stack frames to display when debug messages are written. The default is zero. A value of 3 or 4 is usually sufficient to gain insight into how a given debug call was reached but you can specify a value up to 128. o 2 -h or --help prints usage information. Usage Notes The delay in milliseconds since the previous character was received is included in the diagnostic information written to stderr. This information may be useful to determine the optimal fish_escape_delay_ms setting or learn the amount of lag introduced by tools like ssh, mosh or tmux. fish_key_reader intentionally disables handling of many signals. To terminate fish_key_reader in --continuous mode do: o 2 press Ctrl-C twice, or o 2 press Ctrl-D twice, or o 2 type exit, or o 2 type quit
fixdlsrps(1)
filter to fix DviLaser/PS documents to work with PSUtils
fixfmps(1)
filter to fix Framemaker documents so PSUtils work
fixpsditps(1)
filter to fix Transcript psdit documents so PSUtils work
fixpspps(1)
filter to fix PSPrint PostScript so PSUtils work
fixscribeps(1)
filter to fix Scribe documents so PSUtils work
fixtpps(1)
filter to fix Tpscript documents to work with PSUtils
fixwfwps(1)
filter to fix Word for Windows documents so PSUtils work
fixwpps(1)
filter to fix WP documents so PSUtils work
fixwwps(1)
filter to fix Windows Write documents so PSUtils work
flow-export(1)
Export flow-tools files into other NetFlow packages.
flow-import(1)
Import flows into flow-tools from other NetFlow packages.
flow-tools(1)
Tool set for working with NetFlow data.
flow-tools-examples(1)
Example usage of flow-tools.
fls(1)
List file and directory names in a disk image.
focuswriter(1)
fullscreen word processor
fs_getcellstatus(1)
Reports whether setuid programs are honored in a cell
fs_listacl(1)
Displays ACLs
fs_listaliases(1)
Displays the current list of aliases for AFS cells
fs_listcells(1)
Displays the database server machines known to the Cache Manager
fs_lsmount(1)
Reports the volume for which a directory is the mount point.
fs_setcell(1)
Configures permissions for setuid programs from specified cells
fslsfonts(1)
list fonts served by X font server
fsstat(1)
Display general details of a file system
ftpls(1)
generate a ftp directory listing.
function(1)
- create a function Synopsis function NAME [OPTIONS]; BODY; end Description function creates a new function NAME with the body BODY. A function is a list of commands that will be executed when the name of the function is given as a command. The following options are available: o 2 -a NAMES or --argument-names NAMES assigns the value of successive command-line arguments to the names given in NAMES. o 2 -d DESCRIPTION or --description=DESCRIPTION is a description of what the function does, suitable as a completion description. o 2 -w WRAPPED_COMMAND or --wraps=WRAPPED_COMMAND causes the function to inherit completions from the given wrapped command. See the documentation for complete for more information. o 2 -e or --on-event EVENT_NAME tells fish to run this function when the specified named event is emitted. Fish internally generates named events e.g. when showing the prompt. o 2 -v or --on-variable VARIABLE_NAME tells fish to run this function when the variable VARIABLE_NAME changes value. o 2 -j PGID or --on-job-exit PGID tells fish to run this function when the job with group ID PGID exits. Instead of PGID, the string 'caller' can be specified. This is only legal when in a command substitution, and will result in the handler being triggered by the exit of the job which created this command substitution. o 2 -p PID or --on-process-exit PID tells fish to run this function when the fish child process with process ID PID exits. o 2 -s or --on-signal SIGSPEC tells fish to run this function when the signal SIGSPEC is delivered. SIGSPEC can be a signal number, or the signal name, such as SIGHUP (or just HUP). o 2 -S or --no-scope-shadowing allows the function to access the variables of calling functions. Normally, any variables inside the function that have the same name as variables from the calling function are 'shadowed', and their contents is independent of the calling function. o 2 -V or --inherit-variable NAME snapshots the value of the variable NAME and defines a local variable with that same name and value when the function is defined. This is similar to a closure in other languages like Python but a bit different. Note the word 'snapshot' in the first sentence. If you change the value of the variable after defining the function, even if you do so in the same scope (typically another function) the new value will not be used by the function you just created using this option. See the function notify example below for how this might be used. If the user enters any additional arguments after the function, they are inserted into the environment variable array $argv. If the --argument-names option is provided, the arguments are also assigned to names specified in that option. By using one of the event handler switches, a function can be made to run automatically at specific events. The user may generate new events using the emit builtin. Fish generates the following named events: o 2 fish_prompt, which is emitted whenever a new fish prompt is about to be displayed. o 2 fish_command_not_found, which is emitted whenever a command lookup failed. o 2 fish_preexec, which is emitted right before executing an interactive command. The commandline is passed as the first parameter. Note: This event will be emitted even if the command is invalid. The commandline parameter includes the entire commandline verbatim, and may potentially include newlines. o 2 fish_postexec, which is emitted right after executing an interactive command. The commandline is passed as the first parameter. Note: This event will be emitted even if the command is invalid. The commandline parameter includes the entire commandline verbatim, and may potentially include newlines. Example function ll ls -l $argv end will run the ls command, using the -l option, while passing on any additional files and switches to ls. function mkdir -d 'Create a directory and set CWD' command mkdir $argv if test $status = 0 switch $argv[(count $argv)] case '-*' case '*' cd $argv[(count $argv)] return end end end This will run the mkdir command, and if it is successful, change the current working directory to the one just created. function notify set -l job (jobs -l -g) or begin; echo 'There are no jobs' >&2; return 1; end function _notify_job_$job --on-job-exit $job --inherit-variable job echo -n \a # beep functions -e _notify_job_$job end end This will beep when the most recent job completes.
fuse-utils(1)
various ZX Spectrum related utilities
g.proj(1)
Prints and manipulates GRASS projection information files (in various co-ordinate system descriptions). Can also be used to create new GRASS locations.
gcin-tools(1)
configuration tools of gcin
gcloud_auth, gcloud(1)
auth - manage oauth2 credentials for the Google Cloud SDK
gcloud_auth_activate-service-account, gcloud(1)
auth activate-service-account - get credentials via the private key for a service account
gcloud_auth_list, gcloud(1)
auth list - list the accounts for known credentials
gcloud_auth_login, gcloud(1)
auth login - get credentials for the tools in the Google Cloud SDK via a web flow
gcloud_auth_revoke, gcloud(1)
auth revoke - revoke authorization for credentials
gcloud_compute_instance-groups_managed_set-target-pools, gcloud(1)
compute instance-groups managed set-target-pools - set instance template for managed instance group
gcloud_compute_target-pools, gcloud(1)
compute target-pools - control Compute Engine target pools for network load balancing
gcloud_compute_target-pools_add-health-checks, gcloud(1)
compute target-pools add-health-checks - add an HTTP health check to a target pool
gcloud_compute_target-pools_add-instances, gcloud(1)
compute target-pools add-instances - add instances to a target pool
gcloud_compute_target-pools_create, gcloud(1)
compute target-pools create - define a load-balanced pool of virtual machine instances
gcloud_compute_target-pools_delete, gcloud(1)
compute target-pools delete - delete target pools
gcloud_compute_target-pools_describe, gcloud(1)
compute target-pools describe - describe a Google Compute Engine target pool
gcloud_compute_target-pools_get-health, gcloud(1)
compute target-pools get-health - get the health of instances in a target pool
gcloud_compute_target-pools_list, gcloud(1)
compute target-pools list - list Google Compute Engine target pools
gcloud_compute_target-pools_remove-health-checks, gcloud(1)
compute target-pools remove-health-checks - remove an HTTP health check from a target pool
gcloud_compute_target-pools_remove-instances, gcloud(1)
compute target-pools remove-instances - remove instances from a target pool
gcloud_compute_target-pools_set-backup, gcloud(1)
compute target-pools set-backup - set a backup pool for a target pool
gcloud_compute_vpn-tunnels, gcloud(1)
compute vpn-tunnels - read and manipulate Google Compute Engine VPN Tunnels
gcloud_compute_vpn-tunnels_create, gcloud(1)
compute vpn-tunnels create - create a VPN tunnel
gcloud_compute_vpn-tunnels_delete, gcloud(1)
compute vpn-tunnels delete - delete vpn tunnels
gcloud_compute_vpn-tunnels_describe, gcloud(1)
compute vpn-tunnels describe - describe a Google Compute Engine vpn tunnel
gcloud_compute_vpn-tunnels_list, gcloud(1)
compute vpn-tunnels list - list Google Compute Engine VPN tunnels
gcloud_container_clusters_get-credentials, gcloud(1)
container clusters get-credentials - fetch credentials for a running cluster
gcloud_dns_managed-zones_describe, gcloud(1)
dns managed-zones describe - view the details of a Cloud DNS managed-zone
gcloud_dns_record-sets_changes, gcloud(1)
dns record-sets changes - view details about changes to your Cloud DNS record-sets
gcloud_dns_record-sets_changes_describe, gcloud(1)
dns record-sets changes describe - view the details of a change
gdircolors, dircolors(1)
color setup for ls
gencat(1)
NLS catalog compiler
gencat(1)
NLS ???????? ????????
gencat(1)
NLS ??????????????????
get-edid, parse-edid(1)
read-edid tools to retrieve and interpret monitor specifications using the VESA VBE DDC protocol
gfalse, false(1)
do nothing, unsuccessfully
giftext(1)
dump GIF pixels and metadata as text
git-credential(1)
Retrieve and store user credentials
git-credential-cache--daemon(1)
Temporarily store user credentials in memory
git-credential-store(1)
Helper to store credentials on disk
git-difftool(1)
Show changes using common diff tools
git-locked(1)
ls files that have been locked
git-ls-files(1)
Show information about files in the index and the working tree
git-ls-remote(1)
List references in a remote repository
git-ls-tree(1)
List the contents of a tree object
git-mailsplit(1)
Simple UNIX mbox splitter program
git-mergetool(1)
Run merge conflict resolution tools to resolve merge conflicts
git-mktree(1)
Build a tree-object from ls-tree formatted text
git-send-email(1)
Send a collection of patches as emails
gitaction(1)
GNU Interactive Tools - per file type action script
gitdpkgname(1)
GNU Interactive Tools - gitdpkgname helper script
gitfm(1)
GNU Interactive Tools File Manager
github.pl, github(1)
GitHub Command Tools
gitkeys(1)
GNU Interactive Tools - Display key sequence utility
gitmount(1)
GNU Interactive Tools - auto-mount script
gitrgrep(1)
GNU Interactive Tools - recursive grep
gitunpack(1)
GNU Interactive Tools - Unified archive unpacking
gjdoc, cp-tools(1)
GNU Classpath Tools Guide
gjdoc5, cp-tools(1)
GNU Classpath Tools Guide
gjdoc6, cp-tools(1)
GNU Classpath Tools Guide
gkill, kill(1)
send signals to processes, or list signals
glabels(1)
Label and business card creation program for GNOME
global(1)
print locations of given symbols
gls, ls(1)
list directory contents
gmdb2(1)
- GNOME UI for MDB Tools
gmk_sym(1)
create rectangular symbols for gschem from a text file
gmx-angle(1)
Calculate distributions and correlations for angles and dihedrals
gmx-chi(1)
Calculate everything you want to know about chi and other dihedrals
gmx-order(1)
Compute the order parameter per atom for carbon tails
gmx-wheel(1)
Plot helical wheels
gnu-watch, watch(1)
execute a program periodically, showing output fullscreen
gnuls, ls(1)
list directory contents
gnutls-cli(1)
GnuTLS client
gnutls-cli-debug(1)
GnuTLS debug client
gnutls-serv(1)
GnuTLS server
gpg-mailkeys(1)
sends emails containing keys to their owners
gpstrip(1)
discard symbols from object file
gputils(1)
gputils
gputils(1)
GNU PIC utilities
gramps(1)
Gramps Documentation gramps(1) 4.2.5 gramps(1) 0.0 NOM gramps - Gramps est une application de g??n??alogie. Gramps est l'acronyme de Genealogical Research and Analysis Management Programming System (Systeme de Programmation pour Recherche, Analyse et Gestion de donn??es g??n??alogiques) SYNOPSIS gramps [-? | --help] [--usage] [--version] [-l] [-L] [-u | --force-unlock] [-O | --open= BASE_DE_DONNEES [-f | --format= FORMAT]] [-i | --import= FILE [-f | --format= FORMAT]] [-i | --import= ...] [-e | --export= FICHIER [-f | --format= FORMAT]] [-a | --action= ACTION] [-p | --options= CHA??NE??? OPTION]] [FICHIER] [--version] DESCRIPTION Gramps est un programme Libre/OpenSource de g??n??alogie. Il est ??crit en python, et utilise une interface GTK+/GNOME. Gramps est semblable ?? d'autres programmes de g??n??alogie tel que Family Tree Maker (FTM), Personal Ancestral Files, ou le programme GNU Geneweb. Il peut importer/exporter le format le plus utilis?? par les autres logiciels de g??n??alogie : GEDCOM. OPTIONS 7.0 gramps FICHIER Si FICHIER est d??sign?? (sans autres commandes) comme arbre familial ou comme r??pertoire d'arbre familial, alors une session interactive est ouverte. Si FICHIER est un format de fichier support?? par Gramps, une base vide est cr????e dont le nom est celui du FICHIER et les donn??es y seront import??es. Les autres options sont ignor??es. Ce type de lancement permet d'utiliser gramps pour manipuler des donn??es comme dans un navigateur web. Les formats natifs de gramps sont accept??s, voir ci-dessous. -f , --format= FORMAT Le format sp??cifique du FICHIER est pr??c??d?? par les arguments -i , ou -e . Si l'option -f n'est pas donn??e pour le FICHIER , alors le format sera celui de l'extension ou du type-MIME. Les formats de sortie disponibles sont gramps-xml (devin?? si FICHIER se termine par .gramps ), et gedcom (devin?? si FICHIER se termine par .ged ), ou tout autre fichier d'exportation disponible dans le syst??me de plugin Gramps. Les formats disponibles pour l'importation sont grdb , gramps-xml , gedcom , gramps-pkg (devin?? si FICHIER se termine par .gpkg ), et geneweb (devin?? si FICHIER se termine par .gw ). Les formats disponibles pour l'exportation sont gramps-xml , ged??? com , gramps-pkg , wft (devin?? si FICHIER se termine par .wft ), geneweb . -l Imprime une liste des arbres familiaux disponibles. -u , --force-unlock D??bloquer une base de donn??es verrouill??e. -O , --open= BASE_DE_DONNEES Ouvrir une BASE_DE_DONNEES qui doit ??tre une base pr??sente dans le r??pertoire des bases ou le nom d'un arbre familial existant. Si aucune action n'est d??finie, les options d'import ou d'export sont donn??es par la ligne de commande puis une session interactive est ouverte, utilisant cette base de donn??es. Seulement une base peut ??tre ouverte. Si vous utilisez plusieurs sources, vous devez utiliser l'option d'import. -i , --import= FICHIER Importer des donn??es depuis un FICHIER . Si vous n'avez pas sp??cifi?? de base de donn??es, alors une base de donn??es vide est utilis??e. Quand plus d'un fichier doit ??tre import??, chacun doit ??tre pr??c??d?? par la commande -i . Ces fichiers sont import??s dans le m??me ordre, -i FICHIER1 -i FICHIER2 et -i FICHIER2 -i FICHIER1 vont tous les deux produire diff??rents IDs gramps. -e , --export= FICHIER Exporter des donn??es dans un FICHIER . Pour les fichiers gramps-xml , gedcom , wft , gramps-pkg , et geneweb , le FICHIER est le nom du fichier de sortie. Quand plus d'un fichier doit ??tre export??, chacun doit ??tre pr??c??d?? par la commande -e . Ces fichiers sont import??s dans le m??me ordre. -a , --action= ACTION Accomplir une ACTION sur les donn??es import??es. C'est effectu?? ?? la fin de l'importation. Les actions possibles sont summary (comme le rapport -> Afficher -> Statistiques sur la base), check (comme l'outil -> R??paration de la base -> V??rifier et r??parer), report (produit un rapport) et tool (utilise un outil), ces derniers ont besoin de OPTION pr??c??d?? par la commande -p. L' OPTION doit satisfaire ces conditions: Il ne doit pas y avoir d'espace. Si certains arguments doivent utiliser des espaces, la cha??ne doit ??tre encadr??e par des guillemets. Les options vont par paire nom et valeur. Une paire est s??par??e par un signe ??gal. Diff??rentes paires sont s??par??es par une virgule. La plupart des options sont sp??cifiques ?? chaque rapport. M??me s'il existe des options communes. name=name Cette option est obligatoire, elle d??termine quel rapport ou outil sera utilis??. Si le name saisi ne correspond ?? aucun module disponible, un message d'erreur sera ajout??. show=all Cette option produit une liste avec les noms des options disponibles pour un rapport donn??. show=optionname Cette option affiche une description de toutes les fonctionnalit??s propos??es par optionname, aussi bien les types que les valeurs pour une option. Utiliser les options ci-dessus pour trouver tout sur un rapport choisi. 0u Quand plus d'une action doit ??tre effectu??e, chacune doit ??tre pr??c??d??e par la commande -a . Les actions seront r??alis??es une ?? une, dans l'ordre sp??cifi??. 7.0 -d , --debug= NOM_LOGGER Permet les logs de debug pour le d??veloppement et les tests. Regarder le code source pour les d??tails. --version Imprime le num??ro de version pour gramps puis quitte. 0u Op??ration Si le premie argument de la ligne de commande ne commence pas par un tiret (i.e. pas d'instruction), gramps va essayer d'ouvrir la base de donn??es avec le nom donn?? par le premier argument et d??marrer une ses??? sion interactive, en ignorant le reste de la ligne de commande. Si la commande -O est not??e, alors gramps va essayer le fichier d??fini et va travailler avec ses donn??es, comme pour les autres param??tres de la ligne de commande. Avec ou sans la commande -O , il peut y avoir plusieurs imports, exports, et actions dans la ligne de commande -i , -e , et -a . L'ordre des options -i , -e , ou -a n'a pas de sens. L'ordre actuel est toujours : imports -> actions -> exports. Mais l'ouverture doit toujours ??tre la premi??re ! Si aucune option -O ou -i n'est donn??e, gramps lancera sa propre fen??tre et demarrera avec une base vide, puisqu'il n'y a pas donn??es. Si aucune option -e ou -a n'est donn??e, gramps lancera sa propre fen??tre et d??marrera avec la base de donn??es issue de tout les imports. Cette base sera import_db.grdb dans le r??pertoire ~/.gramps/import. Les erreurs rencontr??es lors d'importation, d'exportation, ou d'action, seront m??moris??es en stdout (si elles sont le fait de la manipulation par gramps) ou en stderr (si elles ne sont pas le fait d'une manipulation). Utilisez les shell de redirection de stdout et stderr pour sauver les messages et les erreurs dans les fichiers. EXEMPLES Pour ouvrir un arbre familial et y importer un fichier XML, on peut saisir: 7.0 3.5 gramps -O 'Mon Arbre Familial' -i ~/db3.gramps 0u 0u Ceci ouvre un arbre familial, pour faire la m??me chose, mais importer dans un arbre familial temporaire et d??marrer une session interactive, on peut saisir : 7.0 3.5 gramps -i 'Mon Arbre Familial' -i ~/db3.gramps 0u 0u Lecture de quatre bases de donn??es dont les formats peuvent ??tre devin??s d'apr??s les noms, puis v??rification des donn??es: 7.0 3.5 gramps -i file1.ged -i file2.tgz -i ~/db3.gramps -i file4.wft -a check 0u 0u Si vous voulez pr??ciser lesformats de fichiers dans l'exemple ci- dessus, compl??tez les noms de fichiers par les options -f appropri??es: 7.0 3.5 gramps -i file1.ged -f gedcom -i file2.tgz -f gramps-pkg -i ~/db3.gramps -f gramps-xml -i file4.wft -f wft -a check 0u 0u Pour enregistrer le r??sultat des lectures, donnez l'option -e (utiliser -f si le nom de fichier ne permet pas ?? gramps de deviner le format): 7.0 3.5 gramps -i file1.ged -i file2.tgz -e ~/new-package -f gramps-pkg 0u 0u Pour lire trois ensembles de donn??es puis lancer une session interactive de gramps sur le tout : 7.0 3.5 gramps -i file1.ged -i file2.tgz -i ~/db3.gramps 0u 0u Pour lancer l'outil de v??rification de la base de donn??es depuis la ligne de commande et obtenir le r??sultat : 7.0 3.5 gramps -O 'My Family Tree' -a tool -p name= verify 0u 0u Enfin, pour lancer une session interactive normale, entrer : 7.0 3.5 gramps 0u 0u VARIABLES D'ENVIRONMENT Le programme v??rifie si ces variables d'environnement sont d??clar??es: LANG - d??crit, quelle langue est utilis??e: Ex.: pour le fran??ais on peut d??finir fr_FR.UTF-8. GRAMPSHOME - si d??fini, force Gramps ?? utiliser un r??pertoire sp??cifique pour y conserver ses pr??f??rences et bases de donn??es. Par d??faut, cette variable n'est pas active et Gramps sait que les options et bases de donn??es doivent ??tre cr????es dans le r??pertoire par d??faut de l'utilisateur (la variable d'environnement HOME pour Linux ou USER??? PROFILE pour Windows 2000/XP). CONCEPTS Gramps est un syst??me bas?? sur le support de plugin-python, permettant d'importer et d'exporter, la saisie, g??n??rer des rapports, des outils, et afficher des filtres pouvant ??tre ajout??s sans modifier le programme. Par ailleurs, gramps permet la g??n??ration directe : impression, rap??? ports avec sortie vers d'autres formats, comme LibreOffice.org , HTML , ou LaTeX pour permettre ?? l'utilisateur de choisir selon ses besoins 0u BUGS CONNUS ET LIMITATIONS FICHIERS 0.0 3.5 ${PREFIX}/bin/gramps ${PREFIX}/lib/python/dist-packages/gramps/ ${PREFIX}/share/ ${HOME}/.gramps 0u 0u 0.0 AUTEURS Donald Allingham <don@gramps-project.org> http://gramps-project.org/ Cette page man a d'abord ??t?? ??crite par : Brandon L. Griffith <brandon@debian.org> pour Debian GNU/Linux syst??me. Cette page man est maintenue par : Gramps project <xxx@gramps-project.org> La traduction fran??aise : J??r??me Rapinat <romjerome@yahoo.fr> DOCUMENTATION La documentation-utilisateur est disponible par un navigateur standard sous la forme du manuel Gramps. La documentation pour d??veloppeur est disponible sur le site http://www.gramps-project.org/wiki/index.php?title=Portal:Developers . 0u gramps(1) 4.2.5 gramps(1)
grub-menulst2cfg(1)
transform legacy menu.lst into grub.cfg
gsymfix(1)
automatically fix common issues with gEDA symbols
gtranslator(1)
a comfortable gettext po file editor with many bells and whistles.
gvfs-ls(1)
List files
gwyddion-thumbnailer(1)
Create thumbnails of SPM data files
hangup-calls(1)
hangup-calls
helios(1)
attraction/repulsion particle effects and some smooth surfaces.
hfsutils(1)
tools for reading and writing Macintosh HFS volumes
hfterm, hf(1)
is the start script for Tom Sailer's amateur radio sondcard program suite, implementing the "historic" digimodes RTTY, AMTOR (SITOR), PACTOR1, GTOR, now also MT63 and a CW elbug.
history(1)
- Show and manipulate command history Synopsis history search [ --show-time ] [ --case-sensitive ] [ --exact | --prefix | --contains ] [ --max=n ] [ --null ] [ 'search string'... ] history delete [ --show-time ] [ --case-sensitive ] [ --exact | --prefix | --contains ] 'search string'... history merge history save history clear history ( -h | --help ) Description history is used to search, delete, and otherwise manipulate the history of interactive commands. The following operations (sub-commands) are available: o 2 search returns history items matching the search string. If no search string is provided it returns all history items. This is the default operation if no other operation is specified. You only have to explicitly say history search if you wish to search for one of the subcommands. The --contains search option will be used if you don't specify a different search option. Entries are ordered newest to oldest. If stdout is attached to a tty the output will be piped through your pager by the history function. The history builtin simply writes the results to stdout. o 2 delete deletes history items. Without the --prefix or --contains options, the exact match of the specified text will be deleted. If you don't specify --exact a prompt will be displayed before any items are deleted asking you which entries are to be deleted. You can enter the word 'all' to delete all matching entries. You can enter a single ID (the number in square brackets) to delete just that single entry. You can enter more than one ID separated by a space to delete multiple entries. Just press [enter] to not delete anything. Note that the interactive delete behavior is a feature of the history function. The history builtin only supports --exact --case-sensitive deletion. o 2 merge immediately incorporates history changes from other sessions. Ordinarily fish ignores history changes from sessions started after the current one. This command applies those changes immediately. o 2 save immediately writes all changes to the history file. The shell automatically saves the history file; this option is provided for internal use and should not normally need to be used by the user. o 2 clear clears the history file. A prompt is displayed before the history is erased asking you to confirm you really want to clear all history unless builtin history is used. The following options are available: These flags can appear before or immediately after one of the sub-commands listed above. o 2 -C or --case-sensitive does a case-sensitive search. The default is case-insensitive. Note that prior to fish 2.4.0 the default was case-sensitive. o 2 -c or --contains searches or deletes items in the history that contain the specified text string. This is the default for the --search flag. This is not currently supported by the --delete flag. o 2 -e or --exact searches or deletes items in the history that exactly match the specified text string. This is the default for the --delete flag. Note that the match is case-insensitive by default. If you really want an exact match, including letter case, you must use the -C or --case-sensitive flag. o 2 -p or --prefix searches or deletes items in the history that begin with the specified text string. This is not currently supported by the --delete flag. o 2 -t or --show-time prepends each history entry with the date and time the entry was recorded . By default it uses the strftime format # cn. You can specify another format; e.g., `--show-time='Y-m-d H:M:S 'or--show-time='aIp'. The short option,-tdoesn't accept a stftime format string; it only uses the default format. Any strftime format is allowed, includingsto get the raw UNIX seconds since the epoch. Note that--with-time` is also allowed but is deprecated and will be removed at a future date. o 2 -z or --null causes history entries written by the search operations to be terminated by a NUL character rather than a newline. This allows the output to be processed by read -z to correctly handle multiline history entries. o 2 -<number> -n <number> or --max=<number> limits the matched history items to the first 'n' matching entries. This is only valid for history search. o 2 -h or --help display help for this command. Example history --clear Deletes all history items history --search --contains 'foo' Outputs a list of all previous commands containing the string 'foo'. history --delete --prefix 'foo' Interactively deletes commands which start with 'foo' from the history. You can select more than one entry by entering their IDs seperated by a space. Notes If you specify both --prefix and --contains the last flag seen is used. Note that for backwards compatibility each subcommand can also be specified as a long option. For example, rather than history search you can type history --search. Those long options are deprecated and will be removed in a future release.
hls(1)
list files in an HFS directory
hpidomain(1)
A openhpi sample application that shows information about domains. It can also set the domain tag.
hpievents(1)
An openhpi sample application that polls for events.
hpitree(1)
A openhpi sample application that shows in details the resources (rpt's) and resources' manamegement instruments (rdr's) data structures of the managed openHPI complex.
htmlsection(1)
insert section number in HTML and make the table of contents.
hugo-undraft(1)
Undraft changes the content's draft status from 'True' to 'False'
hxwls(1)
list links in an HTML file
i-ls(1)
display file stat and checksum information for files
i586-pc-msdosdjgpp-c++filt, c++filt(1)
Demangle C++ and Java symbols.
i586-pc-msdosdjgpp-dlltool, dlltool(1)
Create files needed to build and use DLLs.
i586-pc-msdosdjgpp-nm, nm(1)
list symbols from object files
i586-pc-msdosdjgpp-strip, strip(1)
Discard symbols from object files.
icedtea-web(1)
provides a Free Software web browser plugin running applets written in the Java programming language and an implementation of Java Web Start, originally based on the NetX project. NetX allows Java applets and applications to be downloaded over the network, cached, and (by default) run in a secure sandbox environment. Subsequent runs of the applet download the latest version automatically. Update and security settings, among others, can be set using the itw-settings command. icedtea-web also includes a plugin to enable Java applets (http://www.java.com/en/download/testjava.jsp) within web browsers. 12 Names and email addresses of contributors to this project can be found in the file AUTHORS in the IcedTea-Web root directory. 12 The full GPLv2 license of this project can be found in the file COPYING in the IcedTea-Web root directory. 12 News about releases of this project can be found in the file NEWS in the IcedTea-Web root directory.
icedtea-web(1)
provides a Free Software web browser plugin running applets written in the Java programming language and an implementation of Java Web Start, originally based on the NetX project. NetX allows Java applets and applications to be downloaded over the network, cached, and (by default) run in a secure sandbox environment. Subsequent runs of the applet download the latest version automatically. Update and security settings, among others, can be set using the itw-settings command. icedtea-web also includes a plugin to enable Java applets (http://www.java.com/en/download/testjava.jsp) within web browsers. 12 Names and email addresses of contributors to this project can be found in the file AUTHORS in the IcedTea-Web root directory. 12 The full GPLv2 license of this project can be found in the file COPYING in the IcedTea-Web root directory. 12 News about releases of this project can be found in the file NEWS in the IcedTea-Web root directory.
icedtea-web(1)
provides a Free Software web browser plugin running applets written in the Java programming language and an implementation of Java Web Start, originally based on the NetX project. NetX allows Java applets and applications to be downloaded over the network, cached, and (by default) run in a secure sandbox environment. Subsequent runs of the applet download the latest version automatically. Update and security settings, among others, can be set using the itw-settings command. icedtea-web also includes a plugin to enable Java applets (http://www.java.com/en/download/testjava.jsp) within web browsers. 12 Names and email addresses of contributors to this project can be found in the file AUTHORS in the IcedTea-Web root directory. 12 The full GPLv2 license of this project can be found in the file COPYING in the IcedTea-Web root directory. 12 News about releases of this project can be found in the file NEWS in the IcedTea-Web root directory.
icedtea-web(1)
provides a Free Software web browser plugin running applets written in the Java programming language and an implementation of Java Web Start, originally based on the NetX project. NetX allows Java applets and applications to be downloaded over the network, cached, and (by default) run in a secure sandbox environment. Subsequent runs of the applet download the latest version automatically. Update and security settings, among others, can be set using the itw-settings command. icedtea-web also includes a plugin to enable Java applets (http://www.java.com/en/download/testjava.jsp) within web browsers. 12 Names and email addresses of contributors to this project can be found in the file AUTHORS in the IcedTea-Web root directory. 12 The full GPLv2 license of this project can be found in the file COPYING in the IcedTea-Web root directory. 12 News about releases of this project can be found in the file NEWS in the IcedTea-Web root directory.
idjc-ls(1)
Display information relating to the profiles
if(1)
- conditionally execute a command Synopsis if CONDITION; COMMANDS_TRUE...; [else if CONDITION2; COMMANDS_TRUE2...;] [else; COMMANDS_FALSE...;] end Description if will execute the command CONDITION. If the condition's exit status is 0, the commands COMMANDS_TRUE will execute. If the exit status is not 0 and else is given, COMMANDS_FALSE will be executed. You can use and or or in the condition. See the second example below. The exit status of the last foreground command to exit can always be accessed using the $status variable. Example The following code will print foo.txt exists if the file foo.txt exists and is a regular file, otherwise it will print bar.txt exists if the file bar.txt exists and is a regular file, otherwise it will print foo.txt and bar.txt do not exist. if test -f foo.txt echo foo.txt exists else if test -f bar.txt echo bar.txt exists else echo foo.txt and bar.txt do not exist end The following code will print 'foo.txt exists and is readable' if foo.txt is a regular file and readable if test -f foo.txt and test -r foo.txt echo 'foo.txt exists and is readable' end
ifnames-2.69(1)
Extract CPP conditionals from a set of files
ils(1)
List inode information
imap4d(1)
manual page for imap4d (GNU Mailutils)
img_stat(1)
Display details of an image file
incm(1)
Incorporating new mails for Mew
installpkg(1)
installs a Ch Package
installsieve(1)
Cyrus IMAP documentation User utility for managing sieve scripts
intro, introduction(1)
introduction to general commands (tools and utilities)
ipup, ipdb, ipdb-update.sh, ipdbtools, -(1)
Tools for generating IP based Geo-blocking and Geo-routing tables in order to configure the system's firewall and/or routing facilities
ipython(1)
Tools for Interactive Computing in Python.
irrtoolset-errors, IRRToolSet(1)
error and warning messages
istat(1)
Display details of a meta-data structure (i.e. inode)
ivstools(1)
extract IVs from a pcap file or merges several .ivs files into one
jailctl(1)
FreeBSD 4.x/5.x/6.x jail management shellscript
jaildaemon(1)
A fixed command-line interface for FreeBSD jails to their host system
jails.conf, jailctl(1)
FreeBSD 4.x/5.x/6.x jail management shellscript - configuration
jls(1)
List the contents of a file system journal
jmap(1)
Prints shared object memory maps or heap memory details for a process, core file, or remote debug server. This command is experimental and unsupported.
jmx4perl(1)
JMX access tools and modules
jpgtn(1, 2)
create thumbnails of JPEG files
jpilot-dial(1)
generates the DTMF tone signals used for telephone dialing
jps(1)
Wrapper to ps(1) that maps pids to jails
jstatd(1)
Monitors Java Virtual Machines (JVMs) and enables remote monitoring tools to attach to JVMs. This command is experimental and unsupported.
jtop, jps(1)
Wrapper to top(1) that maps pids to jails
kabcclient(1)
Befehlszeilenprogramm fur das KDE-Adressbuch
kdrill(1)
v6.2 - drill program for kanji chars under Xwindows (X11R5 or better is required to run) kdrill also does dictionary lookup Yikes.. this man-page is getting huge. But I am a great believer in having proper documentation. Hopefully, this new format will help instead of hinder. At some future point in time, I shall convert this huge beast to HTML. But that point is not now. [Although actually, you CAN go to http://www.bolthole.com/kdrill/ for some help ] TIP: "/WORD" usually takes you to the next occurrence of "WORD", if you are viewing this using a "man"-like program.
kermit(1)
C-Kermit 9.0: transport- and platform-independent interactive and scriptable communications software. This document is intended to give the beginner sufficient information to make basic (if not advanced) use of C-Kermit 9.0. Although it might be rather long for a Unix manual page, it's still far shorter than the C-Kermit manual, which should be consulted for advanced topics such as customization, character-sets, scripting, etc. We also attempt to provide a clear structural overview of C-Kermit's many capabilities, functional areas, states, and modes and their interrelation, that should be helpful to beginners and veterans alike, as well as to those upgrading to version 9.0 from earlier releases. This document is also available as a Web page at: http://www.columbia.edu/kermit/ckututor.html
klelstdlib(1, 3)
klelstdlib
klist(1)
list Kerberos credentials
knife-bootstrap(1)
The man page for the knife bootstrap subcommand. A bootstrap is a process that installs the chef-client on a target system so that it can run as a chef-client and communicate with a Chef server. The knife bootstrap subcommand is used to run a bootstrap operation that installs the chef-client on the target system. The bootstrap operation must specify the IP address or FQDN of the target system. Syntax This subcommand has the following syntax: 0.0 3.5 $ knife bootstrap FQDN_or_IP_ADDRESS (options) P 0u 0u Options This subcommand has the following options: 0.0 -A, --forward-agent Use to enable SSH agent forwarding. --bootstrap-no-proxy NO_PROXY_URL_or_IP A URL or IP address that specifies a location that should not be proxied. Note: This option is used internally by Chef to help verify bootstrap operations during testing and should never be used during an actual bootstrap operation. --bootstrap-proxy PROXY_URL The proxy server for the node that is the target of a bootstrap operation. --bootstrap-version VERSION The version of the chef-client to install. -c CONFIG_FILE, --config CONFIG_FILE The configuration file to use. --chef-zero-port PORT The port on which chef-zero will listen. --[no-]color Use to view colored output. -d DISTRO, --distro DISTRO WARNING: 7.0 3.5 The default bootstrap operation uses the omnibus installer, which means the default template file (chef-full) should work on all supported platforms. It is recommended to use custom bootstrap templates only when the omnibus installer cannot be used. The .erb file extension is added automatically and should not be passed as part of the bootstrap command. 0u 0u The template file to be used during a bootstrap operation. The following distributions are supported: chef-full (the default bootstrap), centos5-gems, fedora13-gems, ubuntu10.04-gems, ubuntu10.04-apt, ubuntu12.04-gems, and the name of a custom bootstrap template file. When this option is used, Knife will search for the template file in the following order: the bootstrap/ folder in the current working directory, the bootstrap/ folder in the chef-repo, the bootstrap/ folder in the ~/.chef/ directory, or a default bootstrap file. Do not use the --template-file option when --distro is specified. --defaults Use to have Knife use the default value instead of asking a user to provide one. --disable-editing Use to prevent the $EDITOR from being opened and to accept data as-is. -e EDITOR, --editor EDITOR The $EDITOR that is used for all interactive commands. -E ENVIRONMENT, --environment ENVIRONMENT The name of the environment. When this option is added to a command, the command will run only against the named environment. -F FORMAT, --format FORMAT The output format: summary (default), text, json, yaml, and pp. -G GATEWAY, --ssh-gateway GATEWAY The SSH tunnel or gateway that is used to run a bootstrap action on a machine that is not accessible from the workstation. -h, --help Shows help for the command. --hint HINT_NAME[=HINT_FILE] An Ohai hint to be set on the target of the bootstrap. The hint is contained in a file and is formatted as JSON: {"attribute":"value","attribute":"value"...}. HINT_NAME is the name of the hint and HINT_FILE is the name of the hint file located at /etc/chef/ohai/hints/HINT_FILE.json. Use multiple --hint options in the command to specify multiple hints. --[no-]host-key-verify Use --no-host-key-verify to disable host key verification. Default setting: --host-key-verify. -i IDENTITY_FILE, --identity-file IDENTITY_FILE The SSH identity file used for authentication. Key-based authentication is recommended. -j JSON_ATTRIBS, --json-attributes JSON_ATTRIBS A JSON string that is added to the first run of a chef-client. -k KEY, --key KEY The private key that Knife will use to sign requests made by the API client to the Chef server. -N NAME, --node-name NAME The name of the node. -p PORT, --ssh-port PORT The SSH port. -P PASSWORD, --ssh-password PASSWORD The SSH password. This can be used to pass the password directly on the command line. If this option is not specified (and a password is required) Knife will prompt for the password. --prerelease Use to install pre-release gems. --print-after Use to show data after a destructive operation. -r RUN_LIST, --run-list RUN_LIST A comma-separated list of roles and/or recipes to be applied. -s URL, --server-url URL The URL for the Chef server. --secret SECRET The encryption key that is used for values contained within a data bag item. --secret-file FILE The path to the file that contains the encryption key. --sudo Use to execute a bootstrap operation with sudo. --template-file TEMPLATE The path to a template file that will be used during a bootstrap operation. Do not use the --distro option when --template-file is specified. -u USER, --user USER The user name used by Knife to sign requests made by the API client to the Chef server. Authentication will fail if the user name does not match the private key. --use-sudo-password Use to perform a bootstrap operation with sudo; specify the password with the -P (or --ssh-password) option. -v, --version The version of the chef-client. -V, --verbose Set for more verbose outputs. Use -VV for maximum verbosity. -V -V Use to run the initial chef-client run at the debug log-level (e.g. chef-client -l debug). -x USERNAME, --ssh-user USERNAME The SSH user name. -y, --yes Use to respond to all confirmation prompts with "Yes". Knife will not ask for confirmation. -z, --local-mode Use to run the chef-client in local mode. This allows all commands that work against the Chef server to also work against the local chef-repo. 0u Examples 0.0 3.5 $ knife bootstrap 192.168.1.1 -x username -P PASSWORD --sudo P 0u 0u 0.0 3.5 $ knife bootstrap 192.168.1.1 -x username -i ~/.ssh/id_rsa --sudo P 0u 0u
knife-bootstrap(1)
The man page for the knife bootstrap subcommand. A bootstrap is a process that installs the chef-client on a target system so that it can run as a chef-client and communicate with a Chef server. The knife bootstrap subcommand is used to run a bootstrap operation that installs the chef-client on the target system. The bootstrap operation must specify the IP address or FQDN of the target system. Syntax This subcommand has the following syntax: 0.0 3.5 $ knife bootstrap FQDN_or_IP_ADDRESS (options) P 0u 0u Options This subcommand has the following options: 0.0 -A, --forward-agent Use to enable SSH agent forwarding. --bootstrap-no-proxy NO_PROXY_URL_or_IP A URL or IP address that specifies a location that should not be proxied. Note: This option is used internally by Chef to help verify bootstrap operations during testing and should never be used during an actual bootstrap operation. --bootstrap-proxy PROXY_URL The proxy server for the node that is the target of a bootstrap operation. --bootstrap-version VERSION The version of the chef-client to install. -c CONFIG_FILE, --config CONFIG_FILE The configuration file to use. --chef-zero-port PORT The port on which chef-zero will listen. --[no-]color Use to view colored output. -d DISTRO, --distro DISTRO WARNING: 7.0 3.5 The default bootstrap operation uses the omnibus installer, which means the default template file (chef-full) should work on all supported platforms. It is recommended to use custom bootstrap templates only when the omnibus installer cannot be used. The .erb file extension is added automatically and should not be passed as part of the bootstrap command. 0u 0u The template file to be used during a bootstrap operation. The following distributions are supported: chef-full (the default bootstrap), centos5-gems, fedora13-gems, ubuntu10.04-gems, ubuntu10.04-apt, ubuntu12.04-gems, and the name of a custom bootstrap template file. When this option is used, Knife will search for the template file in the following order: the bootstrap/ folder in the current working directory, the bootstrap/ folder in the chef-repo, the bootstrap/ folder in the ~/.chef/ directory, or a default bootstrap file. Do not use the --template-file option when --distro is specified. --defaults Use to have Knife use the default value instead of asking a user to provide one. --disable-editing Use to prevent the $EDITOR from being opened and to accept data as-is. -e EDITOR, --editor EDITOR The $EDITOR that is used for all interactive commands. -E ENVIRONMENT, --environment ENVIRONMENT The name of the environment. When this option is added to a command, the command will run only against the named environment. -F FORMAT, --format FORMAT The output format: summary (default), text, json, yaml, and pp. -G GATEWAY, --ssh-gateway GATEWAY The SSH tunnel or gateway that is used to run a bootstrap action on a machine that is not accessible from the workstation. -h, --help Shows help for the command. --hint HINT_NAME[=HINT_FILE] An Ohai hint to be set on the target of the bootstrap. The hint is contained in a file and is formatted as JSON: {"attribute":"value","attribute":"value"...}. HINT_NAME is the name of the hint and HINT_FILE is the name of the hint file located at /etc/chef/ohai/hints/HINT_FILE.json. Use multiple --hint options in the command to specify multiple hints. --[no-]host-key-verify Use --no-host-key-verify to disable host key verification. Default setting: --host-key-verify. -i IDENTITY_FILE, --identity-file IDENTITY_FILE The SSH identity file used for authentication. Key-based authentication is recommended. -j JSON_ATTRIBS, --json-attributes JSON_ATTRIBS A JSON string that is added to the first run of a chef-client. -k KEY, --key KEY The private key that Knife will use to sign requests made by the API client to the Chef server. -N NAME, --node-name NAME The name of the node. -p PORT, --ssh-port PORT The SSH port. -P PASSWORD, --ssh-password PASSWORD The SSH password. This can be used to pass the password directly on the command line. If this option is not specified (and a password is required) Knife will prompt for the password. --prerelease Use to install pre-release gems. --print-after Use to show data after a destructive operation. -r RUN_LIST, --run-list RUN_LIST A comma-separated list of roles and/or recipes to be applied. -s URL, --server-url URL The URL for the Chef server. --secret SECRET The encryption key that is used for values contained within a data bag item. --secret-file FILE The path to the file that contains the encryption key. --sudo Use to execute a bootstrap operation with sudo. --template-file TEMPLATE The path to a template file that will be used during a bootstrap operation. Do not use the --distro option when --template-file is specified. -u USER, --user USER The user name used by Knife to sign requests made by the API client to the Chef server. Authentication will fail if the user name does not match the private key. --use-sudo-password Use to perform a bootstrap operation with sudo; specify the password with the -P (or --ssh-password) option. -v, --version The version of the chef-client. -V, --verbose Set for more verbose outputs. Use -VV for maximum verbosity. -V -V Use to run the initial chef-client run at the debug log-level (e.g. chef-client -l debug). -x USERNAME, --ssh-user USERNAME The SSH user name. -y, --yes Use to respond to all confirmation prompts with "Yes". Knife will not ask for confirmation. -z, --local-mode Use to run the chef-client in local mode. This allows all commands that work against the Chef server to also work against the local chef-repo. 0u Examples 0.0 3.5 $ knife bootstrap 192.168.1.1 -x username -P PASSWORD --sudo P 0u 0u 0.0 3.5 $ knife bootstrap 192.168.1.1 -x username -i ~/.ssh/id_rsa --sudo P 0u 0u
knife-configure(1)
The man page for the knife configure subcommand. The knife configure subcommand is used to create the knife.rb and client.rb files so that they can be distributed to workstations and nodes. Syntax This subcommand has the following syntax when creating a knife.rb file: 0.0 3.5 $ knife configure (options) P 0u 0u and the following syntax when creating a client.rb file: 0.0 3.5 $ knife configure client DIRECTORY P 0u 0u Options This subcommand has the following options: 0.0 --admin-client-key PATH The path to the private key used by the client, typically a file named admin.pem. --admin-client-name NAME The name of the client, typically the name of the admin client. -c CONFIG_FILE, --config CONFIG_FILE The configuration file to use. --chef-zero-port PORT The port on which chef-zero will listen. --[no-]color Use to view colored output. -d, --disable-editing Use to prevent the $EDITOR from being opened and to accept data as-is. --defaults Use to have Knife use the default value instead of asking a user to provide one. -e EDITOR, --editor EDITOR The $EDITOR that is used for all interactive commands. -E ENVIRONMENT, --environment ENVIRONMENT The name of the environment. When this option is added to a command, the command will run only against the named environment. -F FORMAT, --format FORMAT The output format: summary (default), text, json, yaml, and pp. -h, --help Shows help for the command. -i, --initial Use to create a API client, typically an administrator client on a freshly-installed Chef server. -k KEY, --key KEY The private key that Knife will use to sign requests made by the API client to the Chef server. --print-after Use to show data after a destructive operation. -r REPO, --repository REPO The path to the chef-repo. -s URL, --server-url URL The URL for the Chef server. -u USER, --user USER The user name used by Knife to sign requests made by the API client to the Chef server. Authentication will fail if the user name does not match the private key. -v, --version The version of the chef-client. -V, --verbose Set for more verbose outputs. Use -VV for maximum verbosity. --validation-client-name NAME The name of the validation client. --validation-key PATH The path to the validation key used by the client, typically a file named validation.pem. -y, --yes Use to respond to all confirmation prompts with "Yes". Knife will not ask for confirmation. -z, --local-mode Use to run the chef-client in local mode. This allows all commands that work against the Chef server to also work against the local chef-repo. 0u Examples 0.0 3.5 $ knife configure P 0u 0u 0.0 3.5 $ knife configure client '/directory' P 0u 0u
knife-configure(1)
The man page for the knife configure subcommand. The knife configure subcommand is used to create the knife.rb and client.rb files so that they can be distributed to workstations and nodes. Syntax This subcommand has the following syntax when creating a knife.rb file: 0.0 3.5 $ knife configure (options) P 0u 0u and the following syntax when creating a client.rb file: 0.0 3.5 $ knife configure client DIRECTORY P 0u 0u Options This subcommand has the following options: 0.0 --admin-client-key PATH The path to the private key used by the client, typically a file named admin.pem. --admin-client-name NAME The name of the client, typically the name of the admin client. -c CONFIG_FILE, --config CONFIG_FILE The configuration file to use. --chef-zero-port PORT The port on which chef-zero will listen. --[no-]color Use to view colored output. -d, --disable-editing Use to prevent the $EDITOR from being opened and to accept data as-is. --defaults Use to have Knife use the default value instead of asking a user to provide one. -e EDITOR, --editor EDITOR The $EDITOR that is used for all interactive commands. -E ENVIRONMENT, --environment ENVIRONMENT The name of the environment. When this option is added to a command, the command will run only against the named environment. -F FORMAT, --format FORMAT The output format: summary (default), text, json, yaml, and pp. -h, --help Shows help for the command. -i, --initial Use to create a API client, typically an administrator client on a freshly-installed Chef server. -k KEY, --key KEY The private key that Knife will use to sign requests made by the API client to the Chef server. --print-after Use to show data after a destructive operation. -r REPO, --repository REPO The path to the chef-repo. -s URL, --server-url URL The URL for the Chef server. -u USER, --user USER The user name used by Knife to sign requests made by the API client to the Chef server. Authentication will fail if the user name does not match the private key. -v, --version The version of the chef-client. -V, --verbose Set for more verbose outputs. Use -VV for maximum verbosity. --validation-client-name NAME The name of the validation client. --validation-key PATH The path to the validation key used by the client, typically a file named validation.pem. -y, --yes Use to respond to all confirmation prompts with "Yes". Knife will not ask for confirmation. -z, --local-mode Use to run the chef-client in local mode. This allows all commands that work against the Chef server to also work against the local chef-repo. 0u Examples 0.0 3.5 $ knife configure P 0u 0u 0.0 3.5 $ knife configure client '/directory' P 0u 0u
knife-delete(1)
The man page for the knife delete subcommand. The knife delete subcommand is used to delete an object from a Chef server. This subcommand works similar to knife cookbook delete, knife data bag delete, knife environment delete, knife node delete, and knife role delete, but with a single verb (and a single action). Syntax This subcommand has the following syntax: 0.0 3.5 $ knife delete [PATTERN...] (options) P 0u 0u Options This subcommand has the following options: 0.0 --both Use to delete both local and remote copies of an object. Default: false. -c CONFIG_FILE, --config CONFIG_FILE The configuration file to use. --chef-repo-path PATH The path to the chef-repo. This setting will override the default path to the chef-repo. Default: same as specified by chef_repo_path in config.rb. --chef-zero-port PORT The port on which chef-zero will listen. --[no-]color Use to view colored output. --concurrency The number of allowed concurrent connections. Default: 10. -d, --disable-editing Use to prevent the $EDITOR from being opened and to accept data as-is. --defaults Use to have Knife use the default value instead of asking a user to provide one. -e EDITOR, --editor EDITOR The $EDITOR that is used for all interactive commands. -E ENVIRONMENT, --environment ENVIRONMENT The name of the environment. When this option is added to a command, the command will run only against the named environment. -F FORMAT, --format FORMAT The output format: summary (default), text, json, yaml, and pp. -h, --help Shows help for the command. -k KEY, --key KEY The private key that Knife will use to sign requests made by the API client to the Chef server. --local Use to delete only the local copy of an object. (A remote copy will not be deleted.) Default: false. --print-after Use to show data after a destructive operation. -r, --[no-]recurse Use --recurse to delete directories recursively. Default: --no-recurse. --repo-mode MODE The layout of the local chef-repo. Possible values: static, everything, or hosted_everything. Use static for just roles, environments, cookbooks, and data bags. By default, everything and hosted_everything are dynamically selected depending on the server type. Default: everything / hosted_everything. -s URL, --server-url URL The URL for the Chef server. -u USER, --user USER The user name used by Knife to sign requests made by the API client to the Chef server. Authentication will fail if the user name does not match the private key. -v, --version The version of the chef-client. -V, --verbose Set for more verbose outputs. Use -VV for maximum verbosity. -y, --yes Use to respond to all confirmation prompts with "Yes". Knife will not ask for confirmation. -z, --local-mode Use to run the chef-client in local mode. This allows all commands that work against the Chef server to also work against the local chef-repo. 0u
knife-delete(1)
The man page for the knife delete subcommand. The knife delete subcommand is used to delete an object from a Chef server. This subcommand works similar to knife cookbook delete, knife data bag delete, knife environment delete, knife node delete, and knife role delete, but with a single verb (and a single action). Syntax This subcommand has the following syntax: 0.0 3.5 $ knife delete [PATTERN...] (options) P 0u 0u Options This subcommand has the following options: 0.0 --both Use to delete both local and remote copies of an object. Default: false. -c CONFIG_FILE, --config CONFIG_FILE The configuration file to use. --chef-repo-path PATH The path to the chef-repo. This setting will override the default path to the chef-repo. Default: same as specified by chef_repo_path in config.rb. --chef-zero-port PORT The port on which chef-zero will listen. --[no-]color Use to view colored output. --concurrency The number of allowed concurrent connections. Default: 10. -d, --disable-editing Use to prevent the $EDITOR from being opened and to accept data as-is. --defaults Use to have Knife use the default value instead of asking a user to provide one. -e EDITOR, --editor EDITOR The $EDITOR that is used for all interactive commands. -E ENVIRONMENT, --environment ENVIRONMENT The name of the environment. When this option is added to a command, the command will run only against the named environment. -F FORMAT, --format FORMAT The output format: summary (default), text, json, yaml, and pp. -h, --help Shows help for the command. -k KEY, --key KEY The private key that Knife will use to sign requests made by the API client to the Chef server. --local Use to delete only the local copy of an object. (A remote copy will not be deleted.) Default: false. --print-after Use to show data after a destructive operation. -r, --[no-]recurse Use --recurse to delete directories recursively. Default: --no-recurse. --repo-mode MODE The layout of the local chef-repo. Possible values: static, everything, or hosted_everything. Use static for just roles, environments, cookbooks, and data bags. By default, everything and hosted_everything are dynamically selected depending on the server type. Default: everything / hosted_everything. -s URL, --server-url URL The URL for the Chef server. -u USER, --user USER The user name used by Knife to sign requests made by the API client to the Chef server. Authentication will fail if the user name does not match the private key. -v, --version The version of the chef-client. -V, --verbose Set for more verbose outputs. Use -VV for maximum verbosity. -y, --yes Use to respond to all confirmation prompts with "Yes". Knife will not ask for confirmation. -z, --local-mode Use to run the chef-client in local mode. This allows all commands that work against the Chef server to also work against the local chef-repo. 0u
knife-deps(1)
The man page for the knife deps subcommand. The knife deps subcommand is used to identify dependencies for a node, role, or cookbook. Syntax This subcommand has the following syntax: 0.0 3.5 $ knife deps (options) P 0u 0u Options This subcommand has the following options: 0.0 -c CONFIG_FILE, --config CONFIG_FILE The configuration file to use. --chef-repo-path PATH The path to the chef-repo. This setting will override the default path to the chef-repo. Default: same as specified by chef_repo_path in config.rb. --chef-zero-port PORT The port on which chef-zero will listen. --[no-]color Use to view colored output. --concurrency The number of allowed concurrent connections. Default: 10. -d, --disable-editing Use to prevent the $EDITOR from being opened and to accept data as-is. --defaults Use to have Knife use the default value instead of asking a user to provide one. -e EDITOR, --editor EDITOR The $EDITOR that is used for all interactive commands. -E ENVIRONMENT, --environment ENVIRONMENT The name of the environment. When this option is added to a command, the command will run only against the named environment. -F FORMAT, --format FORMAT The output format: summary (default), text, json, yaml, and pp. -h, --help Shows help for the command. -k KEY, --key KEY The private key that Knife will use to sign requests made by the API client to the Chef server. --print-after Use to show data after a destructive operation. --[no-]recurse Use --recurse to list dependencies recursively. This option can only be used when --tree is set to true. Default: --no-recurse. --remote Use to determine dependencies from objects located on the Chef server instead of in the local chef-repo. Default: false. --repo-mode MODE The layout of the local chef-repo. Possible values: static, everything, or hosted_everything. Use static for just roles, environments, cookbooks, and data bags. By default, everything and hosted_everything are dynamically selected depending on the server type. Default: everything / hosted_everything. -s URL, --server-url URL The URL for the Chef server. --tree Use to show dependencies in a visual tree structure (including duplicates, if they exist). Default: false. -u USER, --user USER The user name used by Knife to sign requests made by the API client to the Chef server. Authentication will fail if the user name does not match the private key. -v, --version The version of the chef-client. -V, --verbose Set for more verbose outputs. Use -VV for maximum verbosity. -y, --yes Use to respond to all confirmation prompts with "Yes". Knife will not ask for confirmation. -z, --local-mode Use to run the chef-client in local mode. This allows all commands that work against the Chef server to also work against the local chef-repo. 0u Examples 0.0 3.5 $ knife deps nodes/node_name.json P 0u 0u 0.0 3.5 $ knife deps roles/role_name.json P 0u 0u 0.0 3.5 $ knife deps cookbooks/cookbook_name.json P 0u 0u 0.0 3.5 $ knife deps environments/environment_name.json P 0u 0u To find the dependencies for a combination of nodes, cookbooks, roles, and/or environments: 0.0 3.5 $ knife deps cookbooks/git.json cookbooks/github.json roles/base.json environments/desert.json nodes/mynode.json P 0u 0u A wildcard can be used to return all of the child nodes. For example, all of the environments: 0.0 3.5 $ knife deps environments/*.json P 0u 0u Use the --tree option to view the results with structure: 0.0 3.5 $ knife deps roles/webserver.json P 0u 0u to return something like: 0.0 3.5 roles/webserver.json roles/base.json cookbooks/github cookbooks/git cookbooks/users cookbooks/apache2 P 0u 0u The output of knife deps can be passed to knife upload: 0.0 3.5 $ knife upload `knife deps nodes/*.json P 0u 0u The output of knife deps can be passed to knife xargs: 0.0 3.5 $ knife deps nodes/*.json | xargs knife upload P 0u 0u
knife-deps(1)
The man page for the knife deps subcommand. The knife deps subcommand is used to identify dependencies for a node, role, or cookbook. Syntax This subcommand has the following syntax: 0.0 3.5 $ knife deps (options) P 0u 0u Options This subcommand has the following options: 0.0 -c CONFIG_FILE, --config CONFIG_FILE The configuration file to use. --chef-repo-path PATH The path to the chef-repo. This setting will override the default path to the chef-repo. Default: same as specified by chef_repo_path in config.rb. --chef-zero-port PORT The port on which chef-zero will listen. --[no-]color Use to view colored output. --concurrency The number of allowed concurrent connections. Default: 10. -d, --disable-editing Use to prevent the $EDITOR from being opened and to accept data as-is. --defaults Use to have Knife use the default value instead of asking a user to provide one. -e EDITOR, --editor EDITOR The $EDITOR that is used for all interactive commands. -E ENVIRONMENT, --environment ENVIRONMENT The name of the environment. When this option is added to a command, the command will run only against the named environment. -F FORMAT, --format FORMAT The output format: summary (default), text, json, yaml, and pp. -h, --help Shows help for the command. -k KEY, --key KEY The private key that Knife will use to sign requests made by the API client to the Chef server. --print-after Use to show data after a destructive operation. --[no-]recurse Use --recurse to list dependencies recursively. This option can only be used when --tree is set to true. Default: --no-recurse. --remote Use to determine dependencies from objects located on the Chef server instead of in the local chef-repo. Default: false. --repo-mode MODE The layout of the local chef-repo. Possible values: static, everything, or hosted_everything. Use static for just roles, environments, cookbooks, and data bags. By default, everything and hosted_everything are dynamically selected depending on the server type. Default: everything / hosted_everything. -s URL, --server-url URL The URL for the Chef server. --tree Use to show dependencies in a visual tree structure (including duplicates, if they exist). Default: false. -u USER, --user USER The user name used by Knife to sign requests made by the API client to the Chef server. Authentication will fail if the user name does not match the private key. -v, --version The version of the chef-client. -V, --verbose Set for more verbose outputs. Use -VV for maximum verbosity. -y, --yes Use to respond to all confirmation prompts with "Yes". Knife will not ask for confirmation. -z, --local-mode Use to run the chef-client in local mode. This allows all commands that work against the Chef server to also work against the local chef-repo. 0u Examples 0.0 3.5 $ knife deps nodes/node_name.json P 0u 0u 0.0 3.5 $ knife deps roles/role_name.json P 0u 0u 0.0 3.5 $ knife deps cookbooks/cookbook_name.json P 0u 0u 0.0 3.5 $ knife deps environments/environment_name.json P 0u 0u To find the dependencies for a combination of nodes, cookbooks, roles, and/or environments: 0.0 3.5 $ knife deps cookbooks/git.json cookbooks/github.json roles/base.json environments/desert.json nodes/mynode.json P 0u 0u A wildcard can be used to return all of the child nodes. For example, all of the environments: 0.0 3.5 $ knife deps environments/*.json P 0u 0u Use the --tree option to view the results with structure: 0.0 3.5 $ knife deps roles/webserver.json P 0u 0u to return something like: 0.0 3.5 roles/webserver.json roles/base.json cookbooks/github cookbooks/git cookbooks/users cookbooks/apache2 P 0u 0u The output of knife deps can be passed to knife upload: 0.0 3.5 $ knife upload `knife deps nodes/*.json P 0u 0u The output of knife deps can be passed to knife xargs: 0.0 3.5 $ knife deps nodes/*.json | xargs knife upload P 0u 0u
knife-diff(1)
The man page for the knife diff subcommand. The knife diff subcommand is used to compare the differences between files and directories on the Chef server and in the chef-repo. For example, to compare files on the Chef server prior to an uploading or downloading files using the knife download and knife upload subcommands, or to ensure that certain files in multiple production environments are the same. This subcommand is similar to the git diff command that can be used to diff what is in the chef-repo with what is synced to a git repository. Syntax This subcommand has the following syntax: 0.0 3.5 $ knife diff [PATTERN...] (options) P 0u 0u Options This subcommand has the following options: 0.0 -c CONFIG_FILE, --config CONFIG_FILE The configuration file to use. --chef-repo-path PATH The path to the chef-repo. This setting will override the default path to the chef-repo. Default: same as specified by chef_repo_path in config.rb. --chef-zero-port PORT The port on which chef-zero will listen. --[no-]color Use to view colored output. --cookbook-version VERSION The version of a cookbook to be downloaded. --concurrency The number of allowed concurrent connections. Default: 10. -d, --disable-editing Use to prevent the $EDITOR from being opened and to accept data as-is. --defaults Use to have Knife use the default value instead of asking a user to provide one. --diff-filter=[(A|D|M|T)...[*]] Use to select only files that have been added (A), deleted (D), modified (M), and/or have had their type changed (T). Any combination of filter characters may be used, including no filter characters. Use * to select all paths if a file matches other criteria in the comparison. Default value: nil. -e EDITOR, --editor EDITOR The $EDITOR that is used for all interactive commands. -E ENVIRONMENT, --environment ENVIRONMENT The name of the environment. When this option is added to a command, the command will run only against the named environment. -F FORMAT, --format FORMAT The output format: summary (default), text, json, yaml, and pp. -h, --help Shows help for the command. -k KEY, --key KEY The private key that Knife will use to sign requests made by the API client to the Chef server. --name-only Use to show only the names of modified files. --name-status Use to show only the names of files with a status of Added, Deleted, Modified, or Type Changed. --no-recurse Use --no-recurse to disable listing a directory recursively. Default: --recurse. --print-after Use to show data after a destructive operation. --repo-mode MODE The layout of the local chef-repo. Possible values: static, everything, or hosted_everything. Use static for just roles, environments, cookbooks, and data bags. By default, everything and hosted_everything are dynamically selected depending on the server type. Default: everything / hosted_everything. -s URL, --server-url URL The URL for the Chef server. -u USER, --user USER The user name used by Knife to sign requests made by the API client to the Chef server. Authentication will fail if the user name does not match the private key. -v, --version The version of the chef-client. -V, --verbose Set for more verbose outputs. Use -VV for maximum verbosity. -y, --yes Use to respond to all confirmation prompts with "Yes". Knife will not ask for confirmation. -z, --local-mode Use to run the chef-client in local mode. This allows all commands that work against the Chef server to also work against the local chef-repo. 0u knife.rb File Settings In addition to the default settings in a knife.rb file, there are other subcommand-specific settings that can be added. When a subcommand is run, Knife will use: 0.0 1. 3 A value passed via the command-line 2. 3 A value contained in the knife.rb file 3. 3 The default value 0u A value passed via the command line will override a value in the knife.rb file; a value in a knife.rb file will override a default value. The following knife diff settings can be added to the knife.rb file: 0.0 knife[:chef_repo_path] Use to add the --chef-repo-path option. knife[:concurrency] Use to add the --concurrency option. knife[:name_only] Use to add the --name-only option. knife[:name_status] Use to add the --name-status option. knife[:recurse] Use to add the --recurse option. knife[:repo_mode] Use to add the --repo-mode option. 0u Examples To compare the "base.json" role to a "webserver.json" role, enter: 0.0 3.5 $ knife diff roles/base.json roles/webserver.json P 0u 0u To compare the differences between the local chef-repo and the files that are on the Chef server, enter: 0.0 3.5 $ knife diff P 0u 0u To diff a node named node-lb and then only return files that have been added, deleted, modified, or changed, enter: 0.0 3.5 $ knife diff --name-status node-lb P 0u 0u to return something like: 0.0 3.5 node-lb/recipes/eip.rb node-lb/recipes/heartbeat-int.rb node-lb/templates/default/corpsite.conf.erb node-lb/files/default/wildcard.node.com.crt node-lb/files/default/wildcard.node.com.crt-2009 node-lb/files/default/wildcard.node.com.key node-lb/.gitignore node-lb/Rakefile P 0u 0u
knife-diff(1)
The man page for the knife diff subcommand. The knife diff subcommand is used to compare the differences between files and directories on the Chef server and in the chef-repo. For example, to compare files on the Chef server prior to an uploading or downloading files using the knife download and knife upload subcommands, or to ensure that certain files in multiple production environments are the same. This subcommand is similar to the git diff command that can be used to diff what is in the chef-repo with what is synced to a git repository. Syntax This subcommand has the following syntax: 0.0 3.5 $ knife diff [PATTERN...] (options) P 0u 0u Options This subcommand has the following options: 0.0 -c CONFIG_FILE, --config CONFIG_FILE The configuration file to use. --chef-repo-path PATH The path to the chef-repo. This setting will override the default path to the chef-repo. Default: same as specified by chef_repo_path in config.rb. --chef-zero-port PORT The port on which chef-zero will listen. --[no-]color Use to view colored output. --cookbook-version VERSION The version of a cookbook to be downloaded. --concurrency The number of allowed concurrent connections. Default: 10. -d, --disable-editing Use to prevent the $EDITOR from being opened and to accept data as-is. --defaults Use to have Knife use the default value instead of asking a user to provide one. --diff-filter=[(A|D|M|T)...[*]] Use to select only files that have been added (A), deleted (D), modified (M), and/or have had their type changed (T). Any combination of filter characters may be used, including no filter characters. Use * to select all paths if a file matches other criteria in the comparison. Default value: nil. -e EDITOR, --editor EDITOR The $EDITOR that is used for all interactive commands. -E ENVIRONMENT, --environment ENVIRONMENT The name of the environment. When this option is added to a command, the command will run only against the named environment. -F FORMAT, --format FORMAT The output format: summary (default), text, json, yaml, and pp. -h, --help Shows help for the command. -k KEY, --key KEY The private key that Knife will use to sign requests made by the API client to the Chef server. --name-only Use to show only the names of modified files. --name-status Use to show only the names of files with a status of Added, Deleted, Modified, or Type Changed. --no-recurse Use --no-recurse to disable listing a directory recursively. Default: --recurse. --print-after Use to show data after a destructive operation. --repo-mode MODE The layout of the local chef-repo. Possible values: static, everything, or hosted_everything. Use static for just roles, environments, cookbooks, and data bags. By default, everything and hosted_everything are dynamically selected depending on the server type. Default: everything / hosted_everything. -s URL, --server-url URL The URL for the Chef server. -u USER, --user USER The user name used by Knife to sign requests made by the API client to the Chef server. Authentication will fail if the user name does not match the private key. -v, --version The version of the chef-client. -V, --verbose Set for more verbose outputs. Use -VV for maximum verbosity. -y, --yes Use to respond to all confirmation prompts with "Yes". Knife will not ask for confirmation. -z, --local-mode Use to run the chef-client in local mode. This allows all commands that work against the Chef server to also work against the local chef-repo. 0u knife.rb File Settings In addition to the default settings in a knife.rb file, there are other subcommand-specific settings that can be added. When a subcommand is run, Knife will use: 0.0 1. 3 A value passed via the command-line 2. 3 A value contained in the knife.rb file 3. 3 The default value 0u A value passed via the command line will override a value in the knife.rb file; a value in a knife.rb file will override a default value. The following knife diff settings can be added to the knife.rb file: 0.0 knife[:chef_repo_path] Use to add the --chef-repo-path option. knife[:concurrency] Use to add the --concurrency option. knife[:name_only] Use to add the --name-only option. knife[:name_status] Use to add the --name-status option. knife[:recurse] Use to add the --recurse option. knife[:repo_mode] Use to add the --repo-mode option. 0u Examples To compare the "base.json" role to a "webserver.json" role, enter: 0.0 3.5 $ knife diff roles/base.json roles/webserver.json P 0u 0u To compare the differences between the local chef-repo and the files that are on the Chef server, enter: 0.0 3.5 $ knife diff P 0u 0u To diff a node named node-lb and then only return files that have been added, deleted, modified, or changed, enter: 0.0 3.5 $ knife diff --name-status node-lb P 0u 0u to return something like: 0.0 3.5 node-lb/recipes/eip.rb node-lb/recipes/heartbeat-int.rb node-lb/templates/default/corpsite.conf.erb node-lb/files/default/wildcard.node.com.crt node-lb/files/default/wildcard.node.com.crt-2009 node-lb/files/default/wildcard.node.com.key node-lb/.gitignore node-lb/Rakefile P 0u 0u
knife-download(1)
The man page for the knife download subcommand. The knife download subcommand is used to download roles, cookbooks, environments, nodes, and data bags from the Chef server to the current working directory. It can be used to back up data on the Chef server, inspect the state of one or more files, or to extract out-of-process changes users may have made to files on the Chef server, such as if a user made a change that bypassed version source control. This subcommand is often used in conjunction with knife diff, which can be used to see exactly what changes will be downloaded, and then knife upload, which does the opposite of knife download. Syntax This subcommand has the following syntax: 0.0 3.5 $ knife download [PATTERN...] (options) P 0u 0u Options This subcommand has the following options: 0.0 -c CONFIG_FILE, --config CONFIG_FILE The configuration file to use. --chef-repo-path PATH The path to the chef-repo. This setting will override the default path to the chef-repo. Default: same as specified by chef_repo_path in config.rb. --chef-zero-port PORT The port on which chef-zero will listen. --[no-]color Use to view colored output. --concurrency The number of allowed concurrent connections. Default: 10. --cookbook-version VERSION The version of a cookbook to be downloaded. -d, --disable-editing Use to prevent the $EDITOR from being opened and to accept data as-is. --defaults Use to have Knife use the default value instead of asking a user to provide one. --[no-]diff Use to download only new and modified files. Set to false to download all files. Default: --diff. -e EDITOR, --editor EDITOR The $EDITOR that is used for all interactive commands. -E ENVIRONMENT, --environment ENVIRONMENT The name of the environment. When this option is added to a command, the command will run only against the named environment. -F FORMAT, --format FORMAT The output format: summary (default), text, json, yaml, and pp. --[no-]force Use --force to download files even when the file on the hard drive is identical to the object on the server (role, cookbook, etc.). By default, files are compared to see if they have equivalent content, and local files are only overwritten if they are different. Default: --no-force. -h, --help Shows help for the command. -k KEY, --key KEY The private key that Knife will use to sign requests made by the API client to the Chef server. -n, --dry-run Use to take no action and only print out results. Default: false. --print-after Use to show data after a destructive operation. --[no-]purge Use --purge to delete local files and directories that do not exist on the Chef server. By default, if a role, cookbook, etc. does not exist on the Chef server, the local file for said role will be left alone and NOT deleted. Default: --no-purge. --[no-]recurse Use --no-recurse to disable downloading a directory recursively. Default: --recurse. --repo-mode MODE The layout of the local chef-repo. Possible values: static, everything, or hosted_everything. Use static for just roles, environments, cookbooks, and data bags. By default, everything and hosted_everything are dynamically selected depending on the server type. Default: everything / hosted_everything. -s URL, --server-url URL The URL for the Chef server. -u USER, --user USER The user name used by Knife to sign requests made by the API client to the Chef server. Authentication will fail if the user name does not match the private key. -v, --version The version of the chef-client. -V, --verbose Set for more verbose outputs. Use -VV for maximum verbosity. -y, --yes Use to respond to all confirmation prompts with "Yes". Knife will not ask for confirmation. -z, --local-mode Use to run the chef-client in local mode. This allows all commands that work against the Chef server to also work against the local chef-repo. 0u Examples To download the entire chef-repo from the Chef server, browse to the top level of the chef-repo and enter: 0.0 3.5 $ knife download / P 0u 0u To download the cookbooks/ directory from the Chef server, browse to the top level of the chef-repo and enter: 0.0 3.5 $ knife download cookbooks P 0u 0u or from anywhere in the chef-repo, enter: 0.0 3.5 $ knife download /cookbooks P 0u 0u To download the environments/ directory from the Chef server, browse to the top level of the chef-repo and enter: 0.0 3.5 $ knife download environments P 0u 0u or from anywhere in the chef-repo, enter: 0.0 3.5 $ knife download /environments P 0u 0u To download an environment named "production" from the Chef server, browse to the top level of the chef-repo and enter: 0.0 3.5 $ knife download environments/production.json P 0u 0u or from the environments/ directory, enter: 0.0 3.5 $ knife download production.json P 0u 0u To download the roles/ directory from the Chef server, browse to the top level of the chef-repo and enter: 0.0 3.5 $ knife download roles P 0u 0u or from anywhere in the chef-repo, enter: 0.0 3.5 $ knife download /roles P 0u 0u To download all cookbooks that start with "apache" and belong to the "webserver" role, browse to the top level of the chef-repo and enter: 0.0 3.5 $ knife download cookbooks/apache\* roles/webserver.json P 0u 0u
knife-download(1)
The man page for the knife download subcommand. The knife download subcommand is used to download roles, cookbooks, environments, nodes, and data bags from the Chef server to the current working directory. It can be used to back up data on the Chef server, inspect the state of one or more files, or to extract out-of-process changes users may have made to files on the Chef server, such as if a user made a change that bypassed version source control. This subcommand is often used in conjunction with knife diff, which can be used to see exactly what changes will be downloaded, and then knife upload, which does the opposite of knife download. Syntax This subcommand has the following syntax: 0.0 3.5 $ knife download [PATTERN...] (options) P 0u 0u Options This subcommand has the following options: 0.0 -c CONFIG_FILE, --config CONFIG_FILE The configuration file to use. --chef-repo-path PATH The path to the chef-repo. This setting will override the default path to the chef-repo. Default: same as specified by chef_repo_path in config.rb. --chef-zero-port PORT The port on which chef-zero will listen. --[no-]color Use to view colored output. --concurrency The number of allowed concurrent connections. Default: 10. --cookbook-version VERSION The version of a cookbook to be downloaded. -d, --disable-editing Use to prevent the $EDITOR from being opened and to accept data as-is. --defaults Use to have Knife use the default value instead of asking a user to provide one. --[no-]diff Use to download only new and modified files. Set to false to download all files. Default: --diff. -e EDITOR, --editor EDITOR The $EDITOR that is used for all interactive commands. -E ENVIRONMENT, --environment ENVIRONMENT The name of the environment. When this option is added to a command, the command will run only against the named environment. -F FORMAT, --format FORMAT The output format: summary (default), text, json, yaml, and pp. --[no-]force Use --force to download files even when the file on the hard drive is identical to the object on the server (role, cookbook, etc.). By default, files are compared to see if they have equivalent content, and local files are only overwritten if they are different. Default: --no-force. -h, --help Shows help for the command. -k KEY, --key KEY The private key that Knife will use to sign requests made by the API client to the Chef server. -n, --dry-run Use to take no action and only print out results. Default: false. --print-after Use to show data after a destructive operation. --[no-]purge Use --purge to delete local files and directories that do not exist on the Chef server. By default, if a role, cookbook, etc. does not exist on the Chef server, the local file for said role will be left alone and NOT deleted. Default: --no-purge. --[no-]recurse Use --no-recurse to disable downloading a directory recursively. Default: --recurse. --repo-mode MODE The layout of the local chef-repo. Possible values: static, everything, or hosted_everything. Use static for just roles, environments, cookbooks, and data bags. By default, everything and hosted_everything are dynamically selected depending on the server type. Default: everything / hosted_everything. -s URL, --server-url URL The URL for the Chef server. -u USER, --user USER The user name used by Knife to sign requests made by the API client to the Chef server. Authentication will fail if the user name does not match the private key. -v, --version The version of the chef-client. -V, --verbose Set for more verbose outputs. Use -VV for maximum verbosity. -y, --yes Use to respond to all confirmation prompts with "Yes". Knife will not ask for confirmation. -z, --local-mode Use to run the chef-client in local mode. This allows all commands that work against the Chef server to also work against the local chef-repo. 0u Examples To download the entire chef-repo from the Chef server, browse to the top level of the chef-repo and enter: 0.0 3.5 $ knife download / P 0u 0u To download the cookbooks/ directory from the Chef server, browse to the top level of the chef-repo and enter: 0.0 3.5 $ knife download cookbooks P 0u 0u or from anywhere in the chef-repo, enter: 0.0 3.5 $ knife download /cookbooks P 0u 0u To download the environments/ directory from the Chef server, browse to the top level of the chef-repo and enter: 0.0 3.5 $ knife download environments P 0u 0u or from anywhere in the chef-repo, enter: 0.0 3.5 $ knife download /environments P 0u 0u To download an environment named "production" from the Chef server, browse to the top level of the chef-repo and enter: 0.0 3.5 $ knife download environments/production.json P 0u 0u or from the environments/ directory, enter: 0.0 3.5 $ knife download production.json P 0u 0u To download the roles/ directory from the Chef server, browse to the top level of the chef-repo and enter: 0.0 3.5 $ knife download roles P 0u 0u or from anywhere in the chef-repo, enter: 0.0 3.5 $ knife download /roles P 0u 0u To download all cookbooks that start with "apache" and belong to the "webserver" role, browse to the top level of the chef-repo and enter: 0.0 3.5 $ knife download cookbooks/apache\* roles/webserver.json P 0u 0u
knife-edit(1)
The man page for the knife edit subcommand. The knife edit subcommand is used to edit objects on the Chef server. This subcommand works similar to knife cookbook edit, knife data bag edit, knife environment edit, knife node edit, and knife role edit, but with a single verb (and a single action). Syntax This subcommand has the following syntax: 0.0 3.5 $ knife edit (options) P 0u 0u Options This subcommand has the following options: 0.0 -c CONFIG_FILE, --config CONFIG_FILE The configuration file to use. --chef-repo-path PATH The path to the chef-repo. This setting will override the default path to the chef-repo. Default: same as specified by chef_repo_path in config.rb. --chef-zero-port PORT The port on which chef-zero will listen. --[no-]color Use to view colored output. --concurrency The number of allowed concurrent connections. Default: 10. -d, --disable-editing Use to prevent the $EDITOR from being opened and to accept data as-is. --defaults Use to have Knife use the default value instead of asking a user to provide one. -e EDITOR, --editor EDITOR The $EDITOR that is used for all interactive commands. -E ENVIRONMENT, --environment ENVIRONMENT The name of the environment. When this option is added to a command, the command will run only against the named environment. -F FORMAT, --format FORMAT The output format: summary (default), text, json, yaml, and pp. -h, --help Shows help for the command. -k KEY, --key KEY The private key that Knife will use to sign requests made by the API client to the Chef server. --local Use to show files in the local chef-repo instead of a remote location. Default: false. --print-after Use to show data after a destructive operation. --repo-mode MODE The layout of the local chef-repo. Possible values: static, everything, or hosted_everything. Use static for just roles, environments, cookbooks, and data bags. By default, everything and hosted_everything are dynamically selected depending on the server type. Default: everything / hosted_everything. -s URL, --server-url URL The URL for the Chef server. -u USER, --user USER The user name used by Knife to sign requests made by the API client to the Chef server. Authentication will fail if the user name does not match the private key. -v, --version The version of the chef-client. -V, --verbose Set for more verbose outputs. Use -VV for maximum verbosity. -y, --yes Use to respond to all confirmation prompts with "Yes". Knife will not ask for confirmation. -z, --local-mode Use to run the chef-client in local mode. This allows all commands that work against the Chef server to also work against the local chef-repo. 0u
knife-edit(1)
The man page for the knife edit subcommand. The knife edit subcommand is used to edit objects on the Chef server. This subcommand works similar to knife cookbook edit, knife data bag edit, knife environment edit, knife node edit, and knife role edit, but with a single verb (and a single action). Syntax This subcommand has the following syntax: 0.0 3.5 $ knife edit (options) P 0u 0u Options This subcommand has the following options: 0.0 -c CONFIG_FILE, --config CONFIG_FILE The configuration file to use. --chef-repo-path PATH The path to the chef-repo. This setting will override the default path to the chef-repo. Default: same as specified by chef_repo_path in config.rb. --chef-zero-port PORT The port on which chef-zero will listen. --[no-]color Use to view colored output. --concurrency The number of allowed concurrent connections. Default: 10. -d, --disable-editing Use to prevent the $EDITOR from being opened and to accept data as-is. --defaults Use to have Knife use the default value instead of asking a user to provide one. -e EDITOR, --editor EDITOR The $EDITOR that is used for all interactive commands. -E ENVIRONMENT, --environment ENVIRONMENT The name of the environment. When this option is added to a command, the command will run only against the named environment. -F FORMAT, --format FORMAT The output format: summary (default), text, json, yaml, and pp. -h, --help Shows help for the command. -k KEY, --key KEY The private key that Knife will use to sign requests made by the API client to the Chef server. --local Use to show files in the local chef-repo instead of a remote location. Default: false. --print-after Use to show data after a destructive operation. --repo-mode MODE The layout of the local chef-repo. Possible values: static, everything, or hosted_everything. Use static for just roles, environments, cookbooks, and data bags. By default, everything and hosted_everything are dynamically selected depending on the server type. Default: everything / hosted_everything. -s URL, --server-url URL The URL for the Chef server. -u USER, --user USER The user name used by Knife to sign requests made by the API client to the Chef server. Authentication will fail if the user name does not match the private key. -v, --version The version of the chef-client. -V, --verbose Set for more verbose outputs. Use -VV for maximum verbosity. -y, --yes Use to respond to all confirmation prompts with "Yes". Knife will not ask for confirmation. -z, --local-mode Use to run the chef-client in local mode. This allows all commands that work against the Chef server to also work against the local chef-repo. 0u
knife-environment(1)
The man page for the knife environment subcommand. An environment is a way to map an organization's real-life workflow to what can be configured and managed when using Chef server. Every organization begins with a single environment called the _default environment, which cannot be modified (or deleted). Additional environments can be created to reflect each organization's patterns and workflow. For example, creating production, staging, testing, and development environments. Generally, an environment is also associated with one (or more) cookbook versions. The knife environment subcommand is used to manage environments within a single organization on the Chef server.
knife-environment(1)
The man page for the knife environment subcommand. An environment is a way to map an organization's real-life workflow to what can be configured and managed when using Chef server. Every organization begins with a single environment called the _default environment, which cannot be modified (or deleted). Additional environments can be created to reflect each organization's patterns and workflow. For example, creating production, staging, testing, and development environments. Generally, an environment is also associated with one (or more) cookbook versions. The knife environment subcommand is used to manage environments within a single organization on the Chef server.
knife-exec(1)
The man page for the knife exec subcommand. The knife exec subcommand uses the Knife configuration file to execute Ruby scripts in the context of a fully configured chef-client. This subcommand is most often used to run scripts that will only access Chef server one time (or otherwise very infrequently). Use this subcommand any time that an operation does not warrant full usage of the Knife subcommand library. Authenticated API Requests The knife exec subcommand can be used to make authenticated API requests to the Chef server using the following methods: These methods are used with the -E option, which executes that string locally on the workstation using chef-shell. These methods have the following syntax: 0.0 3.5 $ knife exec -E 'api.method(/endpoint)' P 0u 0u where: 0.0 o 2 api.method is the corresponding authentication method --- api.delete, api.get, api.post, or api.put o 2 /endpoint is an endpoint in the Chef Server API 0u For example, to get the data for a node named "Example_Node": 0.0 3.5 $ knife exec -E 'puts api.get("/nodes/Example_Node")' P 0u 0u and to ensure that the output is visible in the console, add the puts in front of the API authorization request: 0.0 3.5 $ knife exec -E 'puts api.get("/nodes/Example_Node")' P 0u 0u where puts is the shorter version of the $stdout.puts predefined variable in Ruby. The following example shows how to add a client named "IBM305RAMAC" and the /clients endpoint, and then return the private key for that user in the console: 0.0 3.5 $ client_desc = { "name" => "IBM305RAMAC", "admin" => false } new_client = api.post("/clients", client_desc) puts new_client["private_key"] P 0u 0u Syntax This subcommand has the following syntax: 0.0 3.5 $ knife exec SCRIPT (options) P 0u 0u Options This subcommand has the following options: 0.0 -c CONFIG_FILE, --config CONFIG_FILE The configuration file to use. --chef-zero-port PORT The port on which chef-zero will listen. --[no-]color Use to view colored output. -d, --disable-editing Use to prevent the $EDITOR from being opened and to accept data as-is. --defaults Use to have Knife use the default value instead of asking a user to provide one. -E CODE, --exec CODE A string of code that will be executed. -e EDITOR, --editor EDITOR The $EDITOR that is used for all interactive commands. --environment ENVIRONMENT The name of the environment. When this option is added to a command, the command will run only against the named environment. -F FORMAT, --format FORMAT The output format: summary (default), text, json, yaml, and pp. -h, --help Shows help for the command. -k KEY, --key KEY The private key that Knife will use to sign requests made by the API client to the Chef server. -p PATH:PATH, --script-path PATH:PATH A colon-separated path at which Ruby scripts are located. --print-after Use to show data after a destructive operation. -s URL, --server-url URL The URL for the Chef server. -u USER, --user USER The user name used by Knife to sign requests made by the API client to the Chef server. Authentication will fail if the user name does not match the private key. -v, --version The version of the chef-client. -V, --verbose Set for more verbose outputs. Use -VV for maximum verbosity. -y, --yes Use to respond to all confirmation prompts with "Yes". Knife will not ask for confirmation. -z, --local-mode Use to run the chef-client in local mode. This allows all commands that work against the Chef server to also work against the local chef-repo. 0u Examples There are three ways to use knife exec to run Ruby script files. For example: 0.0 3.5 $ knife exec /path/to/script_file P 0u 0u Or: 0.0 3.5 $ knife exec -E 'RUBY CODE' P 0u 0u Or: 0.0 3.5 $ knife exec RUBY CODE ^D P 0u 0u To check the status of Knife using a Ruby script named "status.rb" (which looks like): 0.0 3.5 printf "%-5s %-12s %-8s %s\n", "Check In", "Name", "Ruby", "Recipes" nodes.all do |n| checkin = Time.at(n['ohai_time']).strftime("%F %R") rubyver = n['languages']['ruby']['version'] recipes = n.run_list.expand(_default).recipes.join(", ") printf "%-20s %-12s %-8s %s\n", checkin, n.name, rubyver, recipes end P 0u 0u and is located in a directory named "scripts", enter: 0.0 3.5 $ knife exec scripts/status.rb P 0u 0u To show the available free memory for all nodes, enter: 0.0 3.5 $ knife exec -E 'nodes.all {|n| puts "#{n.name} has #{n.memory.total} free memory"}' P 0u 0u To list all of the available search indexes, enter: 0.0 3.5 $ knife exec -E 'puts api.get("search").keys' P 0u 0u To query a node for multiple attributes using a Ruby script named search_attributes.rb (which looks like): 0.0 3.5 % cat scripts/search_attributes.rb query = ARGV[2] attributes = ARGV[3].split(",") puts "Your query: #{query}" puts "Your attributes: #{attributes.join(" ")}" results = {} search(:node, query) do |n| results[n.name] = {} attributes.each {|a| results[n.name][a] = n[a]} end puts results exit 0 P 0u 0u enter: 0.0 3.5 % knife exec scripts/search_attributes.rb "hostname:test_system" ipaddress,fqdn P 0u 0u to return something like: 0.0 3.5 Your query: hostname:test_system Your attributes: ipaddress fqdn {"test_system.example.com"=>{"ipaddress"=>"10.1.1.200", "fqdn"=>"test_system.example.com"}} P 0u 0u
knife-exec(1)
The man page for the knife exec subcommand. The knife exec subcommand uses the Knife configuration file to execute Ruby scripts in the context of a fully configured chef-client. This subcommand is most often used to run scripts that will only access Chef server one time (or otherwise very infrequently). Use this subcommand any time that an operation does not warrant full usage of the Knife subcommand library. Authenticated API Requests The knife exec subcommand can be used to make authenticated API requests to the Chef server using the following methods: These methods are used with the -E option, which executes that string locally on the workstation using chef-shell. These methods have the following syntax: 0.0 3.5 $ knife exec -E 'api.method(/endpoint)' P 0u 0u where: 0.0 o 2 api.method is the corresponding authentication method --- api.delete, api.get, api.post, or api.put o 2 /endpoint is an endpoint in the Chef Server API 0u For example, to get the data for a node named "Example_Node": 0.0 3.5 $ knife exec -E 'puts api.get("/nodes/Example_Node")' P 0u 0u and to ensure that the output is visible in the console, add the puts in front of the API authorization request: 0.0 3.5 $ knife exec -E 'puts api.get("/nodes/Example_Node")' P 0u 0u where puts is the shorter version of the $stdout.puts predefined variable in Ruby. The following example shows how to add a client named "IBM305RAMAC" and the /clients endpoint, and then return the private key for that user in the console: 0.0 3.5 $ client_desc = { "name" => "IBM305RAMAC", "admin" => false } new_client = api.post("/clients", client_desc) puts new_client["private_key"] P 0u 0u Syntax This subcommand has the following syntax: 0.0 3.5 $ knife exec SCRIPT (options) P 0u 0u Options This subcommand has the following options: 0.0 -c CONFIG_FILE, --config CONFIG_FILE The configuration file to use. --chef-zero-port PORT The port on which chef-zero will listen. --[no-]color Use to view colored output. -d, --disable-editing Use to prevent the $EDITOR from being opened and to accept data as-is. --defaults Use to have Knife use the default value instead of asking a user to provide one. -E CODE, --exec CODE A string of code that will be executed. -e EDITOR, --editor EDITOR The $EDITOR that is used for all interactive commands. --environment ENVIRONMENT The name of the environment. When this option is added to a command, the command will run only against the named environment. -F FORMAT, --format FORMAT The output format: summary (default), text, json, yaml, and pp. -h, --help Shows help for the command. -k KEY, --key KEY The private key that Knife will use to sign requests made by the API client to the Chef server. -p PATH:PATH, --script-path PATH:PATH A colon-separated path at which Ruby scripts are located. --print-after Use to show data after a destructive operation. -s URL, --server-url URL The URL for the Chef server. -u USER, --user USER The user name used by Knife to sign requests made by the API client to the Chef server. Authentication will fail if the user name does not match the private key. -v, --version The version of the chef-client. -V, --verbose Set for more verbose outputs. Use -VV for maximum verbosity. -y, --yes Use to respond to all confirmation prompts with "Yes". Knife will not ask for confirmation. -z, --local-mode Use to run the chef-client in local mode. This allows all commands that work against the Chef server to also work against the local chef-repo. 0u Examples There are three ways to use knife exec to run Ruby script files. For example: 0.0 3.5 $ knife exec /path/to/script_file P 0u 0u Or: 0.0 3.5 $ knife exec -E 'RUBY CODE' P 0u 0u Or: 0.0 3.5 $ knife exec RUBY CODE ^D P 0u 0u To check the status of Knife using a Ruby script named "status.rb" (which looks like): 0.0 3.5 printf "%-5s %-12s %-8s %s\n", "Check In", "Name", "Ruby", "Recipes" nodes.all do |n| checkin = Time.at(n['ohai_time']).strftime("%F %R") rubyver = n['languages']['ruby']['version'] recipes = n.run_list.expand(_default).recipes.join(", ") printf "%-20s %-12s %-8s %s\n", checkin, n.name, rubyver, recipes end P 0u 0u and is located in a directory named "scripts", enter: 0.0 3.5 $ knife exec scripts/status.rb P 0u 0u To show the available free memory for all nodes, enter: 0.0 3.5 $ knife exec -E 'nodes.all {|n| puts "#{n.name} has #{n.memory.total} free memory"}' P 0u 0u To list all of the available search indexes, enter: 0.0 3.5 $ knife exec -E 'puts api.get("search").keys' P 0u 0u To query a node for multiple attributes using a Ruby script named search_attributes.rb (which looks like): 0.0 3.5 % cat scripts/search_attributes.rb query = ARGV[2] attributes = ARGV[3].split(",") puts "Your query: #{query}" puts "Your attributes: #{attributes.join(" ")}" results = {} search(:node, query) do |n| results[n.name] = {} attributes.each {|a| results[n.name][a] = n[a]} end puts results exit 0 P 0u 0u enter: 0.0 3.5 % knife exec scripts/search_attributes.rb "hostname:test_system" ipaddress,fqdn P 0u 0u to return something like: 0.0 3.5 Your query: hostname:test_system Your attributes: ipaddress fqdn {"test_system.example.com"=>{"ipaddress"=>"10.1.1.200", "fqdn"=>"test_system.example.com"}} P 0u 0u
knife-list(1)
The man page for the knife list subcommand. The knife list subcommand is used to view a list of objects on the Chef server. This subcommand works similar to knife cookbook list, knife data bag list, knife environment list, knife node list, and knife role list, but with a single verb (and a single action). Syntax This subcommand has the following syntax: 0.0 3.5 $ knife list [PATTERN...] (options) P 0u 0u Options This subcommand has the following options: 0.0 -1 Use to show only one column of results. Default: false. -c CONFIG_FILE, --config CONFIG_FILE The configuration file to use. --chef-repo-path PATH The path to the chef-repo. This setting will override the default path to the chef-repo. Default: same as specified by chef_repo_path in config.rb. --chef-zero-port PORT The port on which chef-zero will listen. --[no-]color Use to view colored output. --concurrency The number of allowed concurrent connections. Default: 10. -d Use to prevent a directory's children from showing when a directory matches a pattern. Default value: false. --defaults Use to have Knife use the default value instead of asking a user to provide one. --disable-editing Use to prevent the $EDITOR from being opened and to accept data as-is. -e EDITOR, --editor EDITOR The $EDITOR that is used for all interactive commands. -E ENVIRONMENT, --environment ENVIRONMENT The name of the environment. When this option is added to a command, the command will run only against the named environment. -f, --flat Use to show a list of file names. Set to false to view ls-like output. Default: false. -F FORMAT, --format FORMAT The output format: summary (default), text, json, yaml, and pp. -h, --help Shows help for the command. -k KEY, --key KEY The private key that Knife will use to sign requests made by the API client to the Chef server. --local Use to return only the contents of the local directory. Default: false. -p Use to show directories with trailing slashes (/). Default: false. --print-after Use to show data after a destructive operation. -R Use to list directories recursively. Default: false. --repo-mode MODE The layout of the local chef-repo. Possible values: static, everything, or hosted_everything. Use static for just roles, environments, cookbooks, and data bags. By default, everything and hosted_everything are dynamically selected depending on the server type. Default: everything / hosted_everything. -s URL, --server-url URL The URL for the Chef server. -u USER, --user USER The user name used by Knife to sign requests made by the API client to the Chef server. Authentication will fail if the user name does not match the private key. -v, --version The version of the chef-client. -V, --verbose Set for more verbose outputs. Use -VV for maximum verbosity. -y, --yes Use to respond to all confirmation prompts with "Yes". Knife will not ask for confirmation. -z, --local-mode Use to run the chef-client in local mode. This allows all commands that work against the Chef server to also work against the local chef-repo. 0u Examples For example, to view a list of roles on the Chef server: 0.0 3.5 $ knife list roles/ P 0u 0u To view a list of roles and environments on the Chef server: 0.0 3.5 $ knife list roles/ environments/ P 0u 0u To view a list of absolutely everything on the Chef server: 0.0 3.5 $ knife list -R / P 0u 0u
knife-list(1)
The man page for the knife list subcommand. The knife list subcommand is used to view a list of objects on the Chef server. This subcommand works similar to knife cookbook list, knife data bag list, knife environment list, knife node list, and knife role list, but with a single verb (and a single action). Syntax This subcommand has the following syntax: 0.0 3.5 $ knife list [PATTERN...] (options) P 0u 0u Options This subcommand has the following options: 0.0 -1 Use to show only one column of results. Default: false. -c CONFIG_FILE, --config CONFIG_FILE The configuration file to use. --chef-repo-path PATH The path to the chef-repo. This setting will override the default path to the chef-repo. Default: same as specified by chef_repo_path in config.rb. --chef-zero-port PORT The port on which chef-zero will listen. --[no-]color Use to view colored output. --concurrency The number of allowed concurrent connections. Default: 10. -d Use to prevent a directory's children from showing when a directory matches a pattern. Default value: false. --defaults Use to have Knife use the default value instead of asking a user to provide one. --disable-editing Use to prevent the $EDITOR from being opened and to accept data as-is. -e EDITOR, --editor EDITOR The $EDITOR that is used for all interactive commands. -E ENVIRONMENT, --environment ENVIRONMENT The name of the environment. When this option is added to a command, the command will run only against the named environment. -f, --flat Use to show a list of file names. Set to false to view ls-like output. Default: false. -F FORMAT, --format FORMAT The output format: summary (default), text, json, yaml, and pp. -h, --help Shows help for the command. -k KEY, --key KEY The private key that Knife will use to sign requests made by the API client to the Chef server. --local Use to return only the contents of the local directory. Default: false. -p Use to show directories with trailing slashes (/). Default: false. --print-after Use to show data after a destructive operation. -R Use to list directories recursively. Default: false. --repo-mode MODE The layout of the local chef-repo. Possible values: static, everything, or hosted_everything. Use static for just roles, environments, cookbooks, and data bags. By default, everything and hosted_everything are dynamically selected depending on the server type. Default: everything / hosted_everything. -s URL, --server-url URL The URL for the Chef server. -u USER, --user USER The user name used by Knife to sign requests made by the API client to the Chef server. Authentication will fail if the user name does not match the private key. -v, --version The version of the chef-client. -V, --verbose Set for more verbose outputs. Use -VV for maximum verbosity. -y, --yes Use to respond to all confirmation prompts with "Yes". Knife will not ask for confirmation. -z, --local-mode Use to run the chef-client in local mode. This allows all commands that work against the Chef server to also work against the local chef-repo. 0u Examples For example, to view a list of roles on the Chef server: 0.0 3.5 $ knife list roles/ P 0u 0u To view a list of roles and environments on the Chef server: 0.0 3.5 $ knife list roles/ environments/ P 0u 0u To view a list of absolutely everything on the Chef server: 0.0 3.5 $ knife list -R / P 0u 0u
knife-raw(1)
The man page for the knife raw subcommand. The knife raw subcommand is used to send a REST request to a specified path using the Chef Server API. Syntax This subcommand has the following syntax: 0.0 3.5 $ knife raw REQUEST_PATH (options) P 0u 0u Options This subcommand has the following options: 0.0 -c CONFIG_FILE, --config CONFIG_FILE The configuration file to use. --chef-zero-port PORT The port on which chef-zero will listen. --[no-]color Use to view colored output. -d, --disable-editing Use to prevent the $EDITOR from being opened and to accept data as-is. --defaults Use to have Knife use the default value instead of asking a user to provide one. -e EDITOR, --editor EDITOR The $EDITOR that is used for all interactive commands. -E ENVIRONMENT, --environment ENVIRONMENT The name of the environment. When this option is added to a command, the command will run only against the named environment. -F FORMAT, --format FORMAT The output format: summary (default), text, json, yaml, and pp. -h, --help Shows help for the command. -i FILE, --input FILE The name of a file to be used with the PUT or a POST request. -k KEY, --key KEY The private key that Knife will use to sign requests made by the API client to the Chef server. -m METHOD, --method METHOD The request method: DELETE, GET, POST, or PUT. Default value: GET. --[no-]pretty Use --no-pretty to disable pretty-print output for JSON. Default: --pretty. --print-after Use to show data after a destructive operation. -s URL, --server-url URL The URL for the Chef server. -u USER, --user USER The user name used by Knife to sign requests made by the API client to the Chef server. Authentication will fail if the user name does not match the private key. -v, --version The version of the chef-client. -V, --verbose Set for more verbose outputs. Use -VV for maximum verbosity. -y, --yes Use to respond to all confirmation prompts with "Yes". Knife will not ask for confirmation. -z, --local-mode Use to run the chef-client in local mode. This allows all commands that work against the Chef server to also work against the local chef-repo. 0u Examples To view information about a client: 0.0 3.5 knife raw /clients/<client_name> P 0u 0u To view information about a node: 0.0 3.5 knife raw /nodes/<node_name> P 0u 0u To delete a data bag, enter a command similar to: 0.0 3.5 $ knife raw -m DELETE /data/foo P 0u 0u to return something similar to: 0.0 3.5 { "name":"foo", "json_class":"Chef::DataBag", "chef_type":"data_bag" } P 0u 0u
knife-raw(1)
The man page for the knife raw subcommand. The knife raw subcommand is used to send a REST request to a specified path using the Chef Server API. Syntax This subcommand has the following syntax: 0.0 3.5 $ knife raw REQUEST_PATH (options) P 0u 0u Options This subcommand has the following options: 0.0 -c CONFIG_FILE, --config CONFIG_FILE The configuration file to use. --chef-zero-port PORT The port on which chef-zero will listen. --[no-]color Use to view colored output. -d, --disable-editing Use to prevent the $EDITOR from being opened and to accept data as-is. --defaults Use to have Knife use the default value instead of asking a user to provide one. -e EDITOR, --editor EDITOR The $EDITOR that is used for all interactive commands. -E ENVIRONMENT, --environment ENVIRONMENT The name of the environment. When this option is added to a command, the command will run only against the named environment. -F FORMAT, --format FORMAT The output format: summary (default), text, json, yaml, and pp. -h, --help Shows help for the command. -i FILE, --input FILE The name of a file to be used with the PUT or a POST request. -k KEY, --key KEY The private key that Knife will use to sign requests made by the API client to the Chef server. -m METHOD, --method METHOD The request method: DELETE, GET, POST, or PUT. Default value: GET. --[no-]pretty Use --no-pretty to disable pretty-print output for JSON. Default: --pretty. --print-after Use to show data after a destructive operation. -s URL, --server-url URL The URL for the Chef server. -u USER, --user USER The user name used by Knife to sign requests made by the API client to the Chef server. Authentication will fail if the user name does not match the private key. -v, --version The version of the chef-client. -V, --verbose Set for more verbose outputs. Use -VV for maximum verbosity. -y, --yes Use to respond to all confirmation prompts with "Yes". Knife will not ask for confirmation. -z, --local-mode Use to run the chef-client in local mode. This allows all commands that work against the Chef server to also work against the local chef-repo. 0u Examples To view information about a client: 0.0 3.5 knife raw /clients/<client_name> P 0u 0u To view information about a node: 0.0 3.5 knife raw /nodes/<node_name> P 0u 0u To delete a data bag, enter a command similar to: 0.0 3.5 $ knife raw -m DELETE /data/foo P 0u 0u to return something similar to: 0.0 3.5 { "name":"foo", "json_class":"Chef::DataBag", "chef_type":"data_bag" } P 0u 0u
knife-role(1)
The man page for the knife role subcommand. A role is a way to define certain patterns and processes that exist across nodes in an organization as belonging to a single job function. Each role consists of zero (or more) attributes and a run list. Each node can have zero (or more) roles assigned to it. When a role is run against a node, the configuration details of that node are compared against the attributes of the role, and then the contents of that role's run list are applied to the node's configuration details. When a chef-client runs, it merges its own attributes and run lists with those contained within each assigned role. The knife role subcommand is used to manage the roles that are associated with one or more nodes on a Chef server.
knife-role(1)
The man page for the knife role subcommand. A role is a way to define certain patterns and processes that exist across nodes in an organization as belonging to a single job function. Each role consists of zero (or more) attributes and a run list. Each node can have zero (or more) roles assigned to it. When a role is run against a node, the configuration details of that node are compared against the attributes of the role, and then the contents of that role's run list are applied to the node's configuration details. When a chef-client runs, it merges its own attributes and run lists with those contained within each assigned role. The knife role subcommand is used to manage the roles that are associated with one or more nodes on a Chef server.
knife-search(1)
The man page for the knife search subcommand. Search indexes allow queries to be made for any type of data that is indexed by the Chef server, including data bags (and data bag items), environments, nodes, and roles. A defined query syntax is used to support search patterns like exact, wildcard, range, and fuzzy. A search is a full-text query that can be done from several locations, including from within a recipe, by using the search subcommand in Knife, or by using the /search or /search/INDEX endpoints in the Chef Server API. The search engine is based on Apache Solr and is run from the Chef server. The knife search subcommand is used run a search query for information that is indexed on a Chef server. Syntax This subcommand has the following syntax: 0.0 3.5 $ knife search INDEX SEARCH_QUERY P 0u 0u where INDEX is one of client, environment, node, role, or the name of a data bag and SEARCH_QUERY is the search query syntax for the query that will be executed. INDEX is implied if omitted, and will default to node. For example: 0.0 3.5 $ knife search '*:*' -i P 0u 0u will return something similar to: 0.0 3.5 8 items found centos-62-dev opensuse-1203 ubuntu-1304-dev ubuntu-1304-orgtest ubuntu-1204-ohai-test ubuntu-1304-ifcfg-test ohai-test win2k8-dev P 0u 0u and is the same search as: 0.0 3.5 $ knife search node '*:*" -i P 0u 0u If the SEARCH_QUERY does not contain a colon character (:), then the default query pattern is tags:*#{@query}* OR roles:*#{@query}* OR fqdn:*#{@query}* OR addresses:*#{@query}*, which means the following two search queries are effectively the same: 0.0 3.5 $ knife search ubuntu P 0u 0u or: 0.0 3.5 $ knife search node "tags:*ubuntu* OR roles:*ubuntu* OR fqdn:*ubuntu* (etc.)" P 0u 0u Options This sub-command has the following options: 0.0 -a ATTR, --attribute ATTR The attribute (or attributes) to show. -b ROW, --start ROW The row at which return results will begin. -c CONFIG_FILE, --config CONFIG_FILE The configuration file to use. --chef-zero-port PORT The port on which chef-zero will listen. --[no-]color Use to view colored output. -d, --disable-editing Use to prevent the $EDITOR from being opened and to accept data as-is. --defaults Use to have Knife use the default value instead of asking a user to provide one. -e EDITOR, --editor EDITOR The $EDITOR that is used for all interactive commands. -E ENVIRONMENT, --environment ENVIRONMENT The name of the environment. When this option is added to a command, the command will run only against the named environment. -F FORMAT, --format FORMAT The output format: summary (default), text, json, yaml, and pp. -h, --help Shows help for the command. -i, --id-only Use to show only matching object IDs. INDEX The name of the index to be queried: client, environment, node, role, or DATA_BAG_NAME. Default index: node. -k KEY, --key KEY The private key that Knife will use to sign requests made by the API client to the Chef server. -l, --long Display long output when searching nodes while using the default summary format. -m, --medium Display more, but not all, of a node's data when searching using the default summary format. -o SORT, --sort SORT The order in which search results will be sorted. --print-after Use to show data after a destructive operation. -q SEARCH_QUERY, --query SEARCH_QUERY Use to protect search queries that start with a hyphen (-). A -q query may be specified as an argument or an option, but not both. -r, --run-list Use to show only the run-list. -R INT, --rows INT The number of rows to be returned. -s URL, --server-url URL The URL for the Chef server. SEARCH_QUERY The search query used to identify a a list of items on a Chef server. This option uses the same syntax as the search sub-command. -u USER, --user USER The user name used by Knife to sign requests made by the API client to the Chef server. Authentication will fail if the user name does not match the private key. -v, --version The version of the chef-client. -V, --verbose Set for more verbose outputs. Use -VV for maximum verbosity. -y, --yes Use to respond to all confirmation prompts with "Yes". Knife will not ask for confirmation. -z, --local-mode Use to run the chef-client in local mode. This allows all commands that work against the Chef server to also work against the local chef-repo. 0u Examples To search for the IDs of all nodes running on the Amazon EC2 platform, enter: 0.0 3.5 $ knife search node 'ec2:*' -i P 0u 0u to return something like: 0.0 3.5 4 items found ip-0A7CA19F.ec2.internal ip-0A58CF8E.ec2.internal ip-0A58E134.ec2.internal ip-0A7CFFD5.ec2.internal P 0u 0u To search for the instance type (flavor) of all nodes running on the Amazon EC2 platform, enter: 0.0 3.5 $ knife search node 'ec2:*' -a ec2.instance_type P 0u 0u to return something like: 0.0 3.5 4 items found ec2.instance_type: m1.large id: ip-0A7CA19F.ec2.internal ec2.instance_type: m1.large id: ip-0A58CF8E.ec2.internal ec2.instance_type: m1.large id: ip-0A58E134.ec2.internal ec2.instance_type: m1.large id: ip-0A7CFFD5.ec2.internal P 0u 0u To search for all nodes running Ubuntu, enter: 0.0 3.5 $ knife search node 'platform:ubuntu' P 0u 0u To search for all nodes running CentOS in the production environment, enter: 0.0 3.5 $ knife search node 'chef_environment:production AND platform:centos' P 0u 0u To find a nested attribute, use a pattern similar to the following: 0.0 3.5 $ knife search node <query_to_run> -a <main_attribute>.<nested_attribute> P 0u 0u To build a search query to use more than one attribute, use an underscore (_) to separate each attribute. For example, the following query will search for all nodes running a specific version of Ruby: 0.0 3.5 $ knife search node "languages_ruby_version:1.9.3" P 0u 0u To build a search query that can find a nested attribute: 0.0 3.5 $ knife search node name:<node_name> -a kernel.machine P 0u 0u To test a search query that will be used in a knife ssh command: 0.0 3.5 $ knife search node "role:web NOT name:web03" P 0u 0u where the query in the previous example will search all servers that have the web role, but not on the server named web03.
knife-search(1)
The man page for the knife search subcommand. Search indexes allow queries to be made for any type of data that is indexed by the Chef server, including data bags (and data bag items), environments, nodes, and roles. A defined query syntax is used to support search patterns like exact, wildcard, range, and fuzzy. A search is a full-text query that can be done from several locations, including from within a recipe, by using the search subcommand in Knife, or by using the /search or /search/INDEX endpoints in the Chef Server API. The search engine is based on Apache Solr and is run from the Chef server. The knife search subcommand is used run a search query for information that is indexed on a Chef server. Syntax This subcommand has the following syntax: 0.0 3.5 $ knife search INDEX SEARCH_QUERY P 0u 0u where INDEX is one of client, environment, node, role, or the name of a data bag and SEARCH_QUERY is the search query syntax for the query that will be executed. INDEX is implied if omitted, and will default to node. For example: 0.0 3.5 $ knife search '*:*' -i P 0u 0u will return something similar to: 0.0 3.5 8 items found centos-62-dev opensuse-1203 ubuntu-1304-dev ubuntu-1304-orgtest ubuntu-1204-ohai-test ubuntu-1304-ifcfg-test ohai-test win2k8-dev P 0u 0u and is the same search as: 0.0 3.5 $ knife search node '*:*" -i P 0u 0u If the SEARCH_QUERY does not contain a colon character (:), then the default query pattern is tags:*#{@query}* OR roles:*#{@query}* OR fqdn:*#{@query}* OR addresses:*#{@query}*, which means the following two search queries are effectively the same: 0.0 3.5 $ knife search ubuntu P 0u 0u or: 0.0 3.5 $ knife search node "tags:*ubuntu* OR roles:*ubuntu* OR fqdn:*ubuntu* (etc.)" P 0u 0u Options This sub-command has the following options: 0.0 -a ATTR, --attribute ATTR The attribute (or attributes) to show. -b ROW, --start ROW The row at which return results will begin. -c CONFIG_FILE, --config CONFIG_FILE The configuration file to use. --chef-zero-port PORT The port on which chef-zero will listen. --[no-]color Use to view colored output. -d, --disable-editing Use to prevent the $EDITOR from being opened and to accept data as-is. --defaults Use to have Knife use the default value instead of asking a user to provide one. -e EDITOR, --editor EDITOR The $EDITOR that is used for all interactive commands. -E ENVIRONMENT, --environment ENVIRONMENT The name of the environment. When this option is added to a command, the command will run only against the named environment. -F FORMAT, --format FORMAT The output format: summary (default), text, json, yaml, and pp. -h, --help Shows help for the command. -i, --id-only Use to show only matching object IDs. INDEX The name of the index to be queried: client, environment, node, role, or DATA_BAG_NAME. Default index: node. -k KEY, --key KEY The private key that Knife will use to sign requests made by the API client to the Chef server. -l, --long Display long output when searching nodes while using the default summary format. -m, --medium Display more, but not all, of a node's data when searching using the default summary format. -o SORT, --sort SORT The order in which search results will be sorted. --print-after Use to show data after a destructive operation. -q SEARCH_QUERY, --query SEARCH_QUERY Use to protect search queries that start with a hyphen (-). A -q query may be specified as an argument or an option, but not both. -r, --run-list Use to show only the run-list. -R INT, --rows INT The number of rows to be returned. -s URL, --server-url URL The URL for the Chef server. SEARCH_QUERY The search query used to identify a a list of items on a Chef server. This option uses the same syntax as the search sub-command. -u USER, --user USER The user name used by Knife to sign requests made by the API client to the Chef server. Authentication will fail if the user name does not match the private key. -v, --version The version of the chef-client. -V, --verbose Set for more verbose outputs. Use -VV for maximum verbosity. -y, --yes Use to respond to all confirmation prompts with "Yes". Knife will not ask for confirmation. -z, --local-mode Use to run the chef-client in local mode. This allows all commands that work against the Chef server to also work against the local chef-repo. 0u Examples To search for the IDs of all nodes running on the Amazon EC2 platform, enter: 0.0 3.5 $ knife search node 'ec2:*' -i P 0u 0u to return something like: 0.0 3.5 4 items found ip-0A7CA19F.ec2.internal ip-0A58CF8E.ec2.internal ip-0A58E134.ec2.internal ip-0A7CFFD5.ec2.internal P 0u 0u To search for the instance type (flavor) of all nodes running on the Amazon EC2 platform, enter: 0.0 3.5 $ knife search node 'ec2:*' -a ec2.instance_type P 0u 0u to return something like: 0.0 3.5 4 items found ec2.instance_type: m1.large id: ip-0A7CA19F.ec2.internal ec2.instance_type: m1.large id: ip-0A58CF8E.ec2.internal ec2.instance_type: m1.large id: ip-0A58E134.ec2.internal ec2.instance_type: m1.large id: ip-0A7CFFD5.ec2.internal P 0u 0u To search for all nodes running Ubuntu, enter: 0.0 3.5 $ knife search node 'platform:ubuntu' P 0u 0u To search for all nodes running CentOS in the production environment, enter: 0.0 3.5 $ knife search node 'chef_environment:production AND platform:centos' P 0u 0u To find a nested attribute, use a pattern similar to the following: 0.0 3.5 $ knife search node <query_to_run> -a <main_attribute>.<nested_attribute> P 0u 0u To build a search query to use more than one attribute, use an underscore (_) to separate each attribute. For example, the following query will search for all nodes running a specific version of Ruby: 0.0 3.5 $ knife search node "languages_ruby_version:1.9.3" P 0u 0u To build a search query that can find a nested attribute: 0.0 3.5 $ knife search node name:<node_name> -a kernel.machine P 0u 0u To test a search query that will be used in a knife ssh command: 0.0 3.5 $ knife search node "role:web NOT name:web03" P 0u 0u where the query in the previous example will search all servers that have the web role, but not on the server named web03.
knife-serve(1)
The man page for the knife serve subcommand. The knife serve subcommand is used to run a persistent chef-zero against the local chef-repo. (chef-zero is a lightweight Chef server that runs in-memory on the local machine.) This is the same as running the chef-client executable with the --local-mode option. The chef_repo_path is located automatically and the Chef server will bind to port 8900 by default. knife serve will print the URL for the local Chef server, so that it may be added to the knife.rb file. Syntax This subcommand has the following syntax: 0.0 3.5 $ knife serve (options) P 0u 0u Options This subcommand has the following options: 0.0 -c CONFIG_FILE, --config CONFIG_FILE The configuration file to use. --chef-zero-port PORT The port on which chef-zero will listen. -d, --disable-editing Use to prevent the $EDITOR from being opened and to accept data as-is. --defaults Use to have Knife use the default value instead of asking a user to provide one. -e EDITOR, --editor EDITOR The $EDITOR that is used for all interactive commands. -E ENVIRONMENT, --environment ENVIRONMENT The name of the environment. When this option is added to a command, the command will run only against the named environment. -F FORMAT, --format FORMAT The output format: summary (default), text, json, yaml, and pp. -h, --help Shows help for the command. -k KEY, --key KEY The private key that Knife will use to sign requests made by the API client to the Chef server. --[no-]color Use to view colored output. --print-after Use to show data after a destructive operation. -s URL, --server-url URL The URL for the Chef server. -u USER, --user USER The user name used by Knife to sign requests made by the API client to the Chef server. Authentication will fail if the user name does not match the private key. -v, --version The version of the chef-client. -V, --verbose Set for more verbose outputs. Use -VV for maximum verbosity. -y, --yes Use to respond to all confirmation prompts with "Yes". Knife will not ask for confirmation. -z, --local-mode Use to run the chef-client in local mode. This allows all commands that work against the Chef server to also work against the local chef-repo. 0u
knife-serve(1)
The man page for the knife serve subcommand. The knife serve subcommand is used to run a persistent chef-zero against the local chef-repo. (chef-zero is a lightweight Chef server that runs in-memory on the local machine.) This is the same as running the chef-client executable with the --local-mode option. The chef_repo_path is located automatically and the Chef server will bind to port 8900 by default. knife serve will print the URL for the local Chef server, so that it may be added to the knife.rb file. Syntax This subcommand has the following syntax: 0.0 3.5 $ knife serve (options) P 0u 0u Options This subcommand has the following options: 0.0 -c CONFIG_FILE, --config CONFIG_FILE The configuration file to use. --chef-zero-port PORT The port on which chef-zero will listen. -d, --disable-editing Use to prevent the $EDITOR from being opened and to accept data as-is. --defaults Use to have Knife use the default value instead of asking a user to provide one. -e EDITOR, --editor EDITOR The $EDITOR that is used for all interactive commands. -E ENVIRONMENT, --environment ENVIRONMENT The name of the environment. When this option is added to a command, the command will run only against the named environment. -F FORMAT, --format FORMAT The output format: summary (default), text, json, yaml, and pp. -h, --help Shows help for the command. -k KEY, --key KEY The private key that Knife will use to sign requests made by the API client to the Chef server. --[no-]color Use to view colored output. --print-after Use to show data after a destructive operation. -s URL, --server-url URL The URL for the Chef server. -u USER, --user USER The user name used by Knife to sign requests made by the API client to the Chef server. Authentication will fail if the user name does not match the private key. -v, --version The version of the chef-client. -V, --verbose Set for more verbose outputs. Use -VV for maximum verbosity. -y, --yes Use to respond to all confirmation prompts with "Yes". Knife will not ask for confirmation. -z, --local-mode Use to run the chef-client in local mode. This allows all commands that work against the Chef server to also work against the local chef-repo. 0u
knife-show(1)
The man page for the knife show subcommand. The knife show subcommand is used to view the details of one (or more) objects on the Chef server. This subcommand works similar to knife cookbook show, knife data bag show, knife environment show, knife node show, and knife role show, but with a single verb (and a single action). Syntax This subcommand has the following syntax: 0.0 3.5 $ knife show [PATTERN...] (options) P 0u 0u Options This subcommand has the following options: 0.0 -a ATTR, --attribute ATTR The attribute (or attributes) to show. -c CONFIG_FILE, --config CONFIG_FILE The configuration file to use. --chef-repo-path PATH The path to the chef-repo. This setting will override the default path to the chef-repo. Default: same as specified by chef_repo_path in config.rb. --chef-zero-port PORT The port on which chef-zero will listen. --[no-]color Use to view colored output. --concurrency The number of allowed concurrent connections. Default: 10. -d, --disable-editing Use to prevent the $EDITOR from being opened and to accept data as-is. --defaults Use to have Knife use the default value instead of asking a user to provide one. -e EDITOR, --editor EDITOR The $EDITOR that is used for all interactive commands. -E ENVIRONMENT, --environment ENVIRONMENT The name of the environment. When this option is added to a command, the command will run only against the named environment. -F FORMAT, --format FORMAT The output format: summary (default), text, json, yaml, and pp. -h, --help Shows help for the command. -k KEY, --key KEY The private key that Knife will use to sign requests made by the API client to the Chef server. --local Use to show local files instead of remote files. --print-after Use to show data after a destructive operation. --repo-mode MODE The layout of the local chef-repo. Possible values: static, everything, or hosted_everything. Use static for just roles, environments, cookbooks, and data bags. By default, everything and hosted_everything are dynamically selected depending on the server type. Default: everything / hosted_everything. -s URL, --server-url URL The URL for the Chef server. -u USER, --user USER The user name used by Knife to sign requests made by the API client to the Chef server. Authentication will fail if the user name does not match the private key. -v, --version The version of the chef-client. -V, --verbose Set for more verbose outputs. Use -VV for maximum verbosity. -y, --yes Use to respond to all confirmation prompts with "Yes". Knife will not ask for confirmation. -z, --local-mode Use to run the chef-client in local mode. This allows all commands that work against the Chef server to also work against the local chef-repo. 0u Examples To show all cookbooks in the cookbooks/ directory: 0.0 3.5 $ knife show cookbooks/ P 0u 0u or, (if already in the cookbooks/ directory in the local chef-repo): 0.0 3.5 $ knife show P 0u 0u 0.0 3.5 $ knife show roles/ environments/ P 0u 0u
knife-show(1)
The man page for the knife show subcommand. The knife show subcommand is used to view the details of one (or more) objects on the Chef server. This subcommand works similar to knife cookbook show, knife data bag show, knife environment show, knife node show, and knife role show, but with a single verb (and a single action). Syntax This subcommand has the following syntax: 0.0 3.5 $ knife show [PATTERN...] (options) P 0u 0u Options This subcommand has the following options: 0.0 -a ATTR, --attribute ATTR The attribute (or attributes) to show. -c CONFIG_FILE, --config CONFIG_FILE The configuration file to use. --chef-repo-path PATH The path to the chef-repo. This setting will override the default path to the chef-repo. Default: same as specified by chef_repo_path in config.rb. --chef-zero-port PORT The port on which chef-zero will listen. --[no-]color Use to view colored output. --concurrency The number of allowed concurrent connections. Default: 10. -d, --disable-editing Use to prevent the $EDITOR from being opened and to accept data as-is. --defaults Use to have Knife use the default value instead of asking a user to provide one. -e EDITOR, --editor EDITOR The $EDITOR that is used for all interactive commands. -E ENVIRONMENT, --environment ENVIRONMENT The name of the environment. When this option is added to a command, the command will run only against the named environment. -F FORMAT, --format FORMAT The output format: summary (default), text, json, yaml, and pp. -h, --help Shows help for the command. -k KEY, --key KEY The private key that Knife will use to sign requests made by the API client to the Chef server. --local Use to show local files instead of remote files. --print-after Use to show data after a destructive operation. --repo-mode MODE The layout of the local chef-repo. Possible values: static, everything, or hosted_everything. Use static for just roles, environments, cookbooks, and data bags. By default, everything and hosted_everything are dynamically selected depending on the server type. Default: everything / hosted_everything. -s URL, --server-url URL The URL for the Chef server. -u USER, --user USER The user name used by Knife to sign requests made by the API client to the Chef server. Authentication will fail if the user name does not match the private key. -v, --version The version of the chef-client. -V, --verbose Set for more verbose outputs. Use -VV for maximum verbosity. -y, --yes Use to respond to all confirmation prompts with "Yes". Knife will not ask for confirmation. -z, --local-mode Use to run the chef-client in local mode. This allows all commands that work against the Chef server to also work against the local chef-repo. 0u Examples To show all cookbooks in the cookbooks/ directory: 0.0 3.5 $ knife show cookbooks/ P 0u 0u or, (if already in the cookbooks/ directory in the local chef-repo): 0.0 3.5 $ knife show P 0u 0u 0.0 3.5 $ knife show roles/ environments/ P 0u 0u
knife-ssh(1)
The man page for the knife ssh subcommand. The knife ssh subcommand is used to invoke SSH commands (in parallel) on a subset of nodes within an organization, based on the results of a search query. Syntax This subcommand has the following syntax: 0.0 3.5 $ knife ssh SEARCH_QUERY SSH_COMMAND (options) P 0u 0u Options This subcommand has the following options: 0.0 -a SSH_ATTR, --attribute SSH_ATTR The attribute that is used when opening the SSH connection. The default attribute is the FQDN of the host. Other possible values include a public IP address, a private IP address, or a hostname. -A, --forward-agent Use to enable SSH agent forwarding. -c CONFIG_FILE, --config CONFIG_FILE The configuration file to use. -C NUM, --concurrency NUM The number of allowed concurrent connections. --chef-zero-port PORT The port on which chef-zero will listen. --[no-]color Use to view colored output. -d, --disable-editing Use to prevent the $EDITOR from being opened and to accept data as-is. --defaults Use to have Knife use the default value instead of asking a user to provide one. -e EDITOR, --editor EDITOR The $EDITOR that is used for all interactive commands. -E ENVIRONMENT, --environment ENVIRONMENT The name of the environment. When this option is added to a command, the command will run only against the named environment. -F FORMAT, --format FORMAT The output format: summary (default), text, json, yaml, and pp. -G GATEWAY, --ssh-gateway GATEWAY The SSH tunnel or gateway that is used to run a bootstrap action on a machine that is not accessible from the workstation. -h, --help Shows help for the command. -i IDENTITY_FILE, --identity-file IDENTIFY_FILE The SSH identity file used for authentication. Key-based authentication is recommended. -k KEY, --key KEY The private key that Knife will use to sign requests made by the API client to the Chef server. -m, --manual-list Use to define a search query as a space-separated list of servers. If there is more than one item in the list, put quotes around the entire list. For example: --manual-list "server01 server 02 server 03" --[no-]host-key-verify Use --no-host-key-verify to disable host key verification. Default setting: --host-key-verify. OTHER The shell type. Possible values: interactive, screen, tmux, macterm, or cssh. (csshx is deprecated in favor of cssh.) -p PORT, --ssh-port PORT The SSH port. -P PASSWORD, --ssh-password PASSWORD The SSH password. This can be used to pass the password directly on the command line. If this option is not specified (and a password is required) Knife will prompt for the password. --print-after Use to show data after a destructive operation. -s URL, --server-url URL The URL for the Chef server. SEARCH_QUERY The search query used to return a list of servers to be accessed using SSH and the specified SSH_COMMAND. This option uses the same syntax as the search sub-command. SSH_COMMAND The command that will be run against the results of a search query. -u USER, --user USER The user name used by Knife to sign requests made by the API client to the Chef server. Authentication will fail if the user name does not match the private key. -v, --version The version of the chef-client. -V, --verbose Set for more verbose outputs. Use -VV for maximum verbosity. -x USER_NAME, --ssh-user USER_NAME The SSH user name. -y, --yes Use to respond to all confirmation prompts with "Yes". Knife will not ask for confirmation. -z, --local-mode Use to run the chef-client in local mode. This allows all commands that work against the Chef server to also work against the local chef-repo. 0u Examples To find the uptime of all of web servers running Ubuntu on the Amazon EC2 platform, enter: 0.0 3.5 $ knife ssh "role:web" "uptime" -x ubuntu -a ec2.public_hostname P 0u 0u to return something like: 0.0 3.5 ec2-174-129-127-206.compute-1.amazonaws.com 13:50:47 up 1 day, 23:26, 1 user, load average: 0.25, 0.18, 0.11 ec2-67-202-63-102.compute-1.amazonaws.com 13:50:47 up 1 day, 23:33, 1 user, load average: 0.12, 0.13, 0.10 ec2-184-73-9-250.compute-1.amazonaws.com 13:50:48 up 16:45, 1 user, load average: 0.30, 0.22, 0.13 ec2-75-101-240-230.compute-1.amazonaws.com 13:50:48 up 1 day, 22:59, 1 user, load average: 0.24, 0.17, 0.11 ec2-184-73-60-141.compute-1.amazonaws.com 13:50:48 up 1 day, 23:30, 1 user, load average: 0.32, 0.17, 0.15 P 0u 0u 0.0 3.5 $ knife ssh 'name:*' 'sudo chef-client' P 0u 0u To force a chef-client run on all of the web servers running Ubuntu on the Amazon EC2 platform, enter: 0.0 3.5 $ knife ssh "role:web" "sudo chef-client" -x ubuntu -a ec2.public_hostname P 0u 0u to return something like: 0.0 3.5 ec2-67-202-63-102.compute-1.amazonaws.com [Fri, 22 Oct 2010 14:18:37 +0000] INFO: Starting Chef Run (Version 0.9.10) ec2-174-129-127-206.compute-1.amazonaws.com [Fri, 22 Oct 2010 14:18:37 +0000] INFO: Starting Chef Run (Version 0.9.10) ec2-184-73-9-250.compute-1.amazonaws.com [Fri, 22 Oct 2010 14:18:38 +0000] INFO: Starting Chef Run (Version 0.9.10) ec2-75-101-240-230.compute-1.amazonaws.com [Fri, 22 Oct 2010 14:18:38 +0000] INFO: Starting Chef Run (Version 0.9.10) ec2-184-73-60-141.compute-1.amazonaws.com [Fri, 22 Oct 2010 14:18:38 +0000] INFO: Starting Chef Run (Version 0.9.10) ec2-174-129-127-206.compute-1.amazonaws.com [Fri, 22 Oct 2010 14:18:39 +0000] INFO: Chef Run complete in 1.419243 seconds ec2-174-129-127-206.compute-1.amazonaws.com [Fri, 22 Oct 2010 14:18:39 +0000] INFO: cleaning the checksum cache ec2-174-129-127-206.compute-1.amazonaws.com [Fri, 22 Oct 2010 14:18:39 +0000] INFO: Running report handlers ec2-174-129-127-206.compute-1.amazonaws.com [Fri, 22 Oct 2010 14:18:39 +0000] INFO: Report handlers complete ec2-67-202-63-102.compute-1.amazonaws.com [Fri, 22 Oct 2010 14:18:39 +0000] INFO: Chef Run complete in 1.578265 seconds ec2-67-202-63-102.compute-1.amazonaws.com [Fri, 22 Oct 2010 14:18:39 +0000] INFO: cleaning the checksum cache ec2-67-202-63-102.compute-1.amazonaws.com [Fri, 22 Oct 2010 14:18:39 +0000] INFO: Running report handlers ec2-67-202-63-102.compute-1.amazonaws.com [Fri, 22 Oct 2010 14:18:39 +0000] INFO: Report handlers complete ec2-184-73-9-250.compute-1.amazonaws.com [Fri, 22 Oct 2010 14:18:40 +0000] INFO: Chef Run complete in 1.638884 seconds ec2-184-73-9-250.compute-1.amazonaws.com [Fri, 22 Oct 2010 14:18:40 +0000] INFO: cleaning the checksum cache ec2-184-73-9-250.compute-1.amazonaws.com [Fri, 22 Oct 2010 14:18:40 +0000] INFO: Running report handlers ec2-184-73-9-250.compute-1.amazonaws.com [Fri, 22 Oct 2010 14:18:40 +0000] INFO: Report handlers complete ec2-75-101-240-230.compute-1.amazonaws.com [Fri, 22 Oct 2010 14:18:40 +0000] INFO: Chef Run complete in 1.540257 seconds ec2-75-101-240-230.compute-1.amazonaws.com [Fri, 22 Oct 2010 14:18:40 +0000] INFO: cleaning the checksum cache ec2-75-101-240-230.compute-1.amazonaws.com [Fri, 22 Oct 2010 14:18:40 +0000] INFO: Running report handlers ec2-75-101-240-230.compute-1.amazonaws.com [Fri, 22 Oct 2010 14:18:40 +0000] INFO: Report handlers complete ec2-184-73-60-141.compute-1.amazonaws.com [Fri, 22 Oct 2010 14:18:40 +0000] INFO: Chef Run complete in 1.502489 seconds ec2-184-73-60-141.compute-1.amazonaws.com [Fri, 22 Oct 2010 14:18:40 +0000] INFO: cleaning the checksum cache ec2-184-73-60-141.compute-1.amazonaws.com [Fri, 22 Oct 2010 14:18:40 +0000] INFO: Running report handlers ec2-184-73-60-141.compute-1.amazonaws.com [Fri, 22 Oct 2010 14:18:40 +0000] INFO: Report handlers complete P 0u 0u To query for all nodes that have the "webserver" role and then use SSH to run the command "sudo chef-client", enter: 0.0 3.5 $ knife ssh "role:webserver" "sudo chef-client" P 0u 0u 0.0 3.5 $ knife ssh name:* "sudo aptitude upgrade -y" P 0u 0u To specify the shell type used on the nodes returned by a search query: 0.0 3.5 $ knife ssh roles:opscode-omnitruck macterm P 0u 0u where screen is one of the following values: cssh, interactive, macterm, screen, or tmux. If the node does not have the shell type installed, Knife will return an error similar to the following: 0.0 3.5 you need the rb-appscript gem to use knife ssh macterm. `(sudo) gem install rb-appscript` to install ERROR: LoadError: cannot load such file -- appscript P 0u 0u
knife-ssh(1)
The man page for the knife ssh subcommand. The knife ssh subcommand is used to invoke SSH commands (in parallel) on a subset of nodes within an organization, based on the results of a search query. Syntax This subcommand has the following syntax: 0.0 3.5 $ knife ssh SEARCH_QUERY SSH_COMMAND (options) P 0u 0u Options This subcommand has the following options: 0.0 -a SSH_ATTR, --attribute SSH_ATTR The attribute that is used when opening the SSH connection. The default attribute is the FQDN of the host. Other possible values include a public IP address, a private IP address, or a hostname. -A, --forward-agent Use to enable SSH agent forwarding. -c CONFIG_FILE, --config CONFIG_FILE The configuration file to use. -C NUM, --concurrency NUM The number of allowed concurrent connections. --chef-zero-port PORT The port on which chef-zero will listen. --[no-]color Use to view colored output. -d, --disable-editing Use to prevent the $EDITOR from being opened and to accept data as-is. --defaults Use to have Knife use the default value instead of asking a user to provide one. -e EDITOR, --editor EDITOR The $EDITOR that is used for all interactive commands. -E ENVIRONMENT, --environment ENVIRONMENT The name of the environment. When this option is added to a command, the command will run only against the named environment. -F FORMAT, --format FORMAT The output format: summary (default), text, json, yaml, and pp. -G GATEWAY, --ssh-gateway GATEWAY The SSH tunnel or gateway that is used to run a bootstrap action on a machine that is not accessible from the workstation. -h, --help Shows help for the command. -i IDENTITY_FILE, --identity-file IDENTIFY_FILE The SSH identity file used for authentication. Key-based authentication is recommended. -k KEY, --key KEY The private key that Knife will use to sign requests made by the API client to the Chef server. -m, --manual-list Use to define a search query as a space-separated list of servers. If there is more than one item in the list, put quotes around the entire list. For example: --manual-list "server01 server 02 server 03" --[no-]host-key-verify Use --no-host-key-verify to disable host key verification. Default setting: --host-key-verify. OTHER The shell type. Possible values: interactive, screen, tmux, macterm, or cssh. (csshx is deprecated in favor of cssh.) -p PORT, --ssh-port PORT The SSH port. -P PASSWORD, --ssh-password PASSWORD The SSH password. This can be used to pass the password directly on the command line. If this option is not specified (and a password is required) Knife will prompt for the password. --print-after Use to show data after a destructive operation. -s URL, --server-url URL The URL for the Chef server. SEARCH_QUERY The search query used to return a list of servers to be accessed using SSH and the specified SSH_COMMAND. This option uses the same syntax as the search sub-command. SSH_COMMAND The command that will be run against the results of a search query. -u USER, --user USER The user name used by Knife to sign requests made by the API client to the Chef server. Authentication will fail if the user name does not match the private key. -v, --version The version of the chef-client. -V, --verbose Set for more verbose outputs. Use -VV for maximum verbosity. -x USER_NAME, --ssh-user USER_NAME The SSH user name. -y, --yes Use to respond to all confirmation prompts with "Yes". Knife will not ask for confirmation. -z, --local-mode Use to run the chef-client in local mode. This allows all commands that work against the Chef server to also work against the local chef-repo. 0u Examples To find the uptime of all of web servers running Ubuntu on the Amazon EC2 platform, enter: 0.0 3.5 $ knife ssh "role:web" "uptime" -x ubuntu -a ec2.public_hostname P 0u 0u to return something like: 0.0 3.5 ec2-174-129-127-206.compute-1.amazonaws.com 13:50:47 up 1 day, 23:26, 1 user, load average: 0.25, 0.18, 0.11 ec2-67-202-63-102.compute-1.amazonaws.com 13:50:47 up 1 day, 23:33, 1 user, load average: 0.12, 0.13, 0.10 ec2-184-73-9-250.compute-1.amazonaws.com 13:50:48 up 16:45, 1 user, load average: 0.30, 0.22, 0.13 ec2-75-101-240-230.compute-1.amazonaws.com 13:50:48 up 1 day, 22:59, 1 user, load average: 0.24, 0.17, 0.11 ec2-184-73-60-141.compute-1.amazonaws.com 13:50:48 up 1 day, 23:30, 1 user, load average: 0.32, 0.17, 0.15 P 0u 0u 0.0 3.5 $ knife ssh 'name:*' 'sudo chef-client' P 0u 0u To force a chef-client run on all of the web servers running Ubuntu on the Amazon EC2 platform, enter: 0.0 3.5 $ knife ssh "role:web" "sudo chef-client" -x ubuntu -a ec2.public_hostname P 0u 0u to return something like: 0.0 3.5 ec2-67-202-63-102.compute-1.amazonaws.com [Fri, 22 Oct 2010 14:18:37 +0000] INFO: Starting Chef Run (Version 0.9.10) ec2-174-129-127-206.compute-1.amazonaws.com [Fri, 22 Oct 2010 14:18:37 +0000] INFO: Starting Chef Run (Version 0.9.10) ec2-184-73-9-250.compute-1.amazonaws.com [Fri, 22 Oct 2010 14:18:38 +0000] INFO: Starting Chef Run (Version 0.9.10) ec2-75-101-240-230.compute-1.amazonaws.com [Fri, 22 Oct 2010 14:18:38 +0000] INFO: Starting Chef Run (Version 0.9.10) ec2-184-73-60-141.compute-1.amazonaws.com [Fri, 22 Oct 2010 14:18:38 +0000] INFO: Starting Chef Run (Version 0.9.10) ec2-174-129-127-206.compute-1.amazonaws.com [Fri, 22 Oct 2010 14:18:39 +0000] INFO: Chef Run complete in 1.419243 seconds ec2-174-129-127-206.compute-1.amazonaws.com [Fri, 22 Oct 2010 14:18:39 +0000] INFO: cleaning the checksum cache ec2-174-129-127-206.compute-1.amazonaws.com [Fri, 22 Oct 2010 14:18:39 +0000] INFO: Running report handlers ec2-174-129-127-206.compute-1.amazonaws.com [Fri, 22 Oct 2010 14:18:39 +0000] INFO: Report handlers complete ec2-67-202-63-102.compute-1.amazonaws.com [Fri, 22 Oct 2010 14:18:39 +0000] INFO: Chef Run complete in 1.578265 seconds ec2-67-202-63-102.compute-1.amazonaws.com [Fri, 22 Oct 2010 14:18:39 +0000] INFO: cleaning the checksum cache ec2-67-202-63-102.compute-1.amazonaws.com [Fri, 22 Oct 2010 14:18:39 +0000] INFO: Running report handlers ec2-67-202-63-102.compute-1.amazonaws.com [Fri, 22 Oct 2010 14:18:39 +0000] INFO: Report handlers complete ec2-184-73-9-250.compute-1.amazonaws.com [Fri, 22 Oct 2010 14:18:40 +0000] INFO: Chef Run complete in 1.638884 seconds ec2-184-73-9-250.compute-1.amazonaws.com [Fri, 22 Oct 2010 14:18:40 +0000] INFO: cleaning the checksum cache ec2-184-73-9-250.compute-1.amazonaws.com [Fri, 22 Oct 2010 14:18:40 +0000] INFO: Running report handlers ec2-184-73-9-250.compute-1.amazonaws.com [Fri, 22 Oct 2010 14:18:40 +0000] INFO: Report handlers complete ec2-75-101-240-230.compute-1.amazonaws.com [Fri, 22 Oct 2010 14:18:40 +0000] INFO: Chef Run complete in 1.540257 seconds ec2-75-101-240-230.compute-1.amazonaws.com [Fri, 22 Oct 2010 14:18:40 +0000] INFO: cleaning the checksum cache ec2-75-101-240-230.compute-1.amazonaws.com [Fri, 22 Oct 2010 14:18:40 +0000] INFO: Running report handlers ec2-75-101-240-230.compute-1.amazonaws.com [Fri, 22 Oct 2010 14:18:40 +0000] INFO: Report handlers complete ec2-184-73-60-141.compute-1.amazonaws.com [Fri, 22 Oct 2010 14:18:40 +0000] INFO: Chef Run complete in 1.502489 seconds ec2-184-73-60-141.compute-1.amazonaws.com [Fri, 22 Oct 2010 14:18:40 +0000] INFO: cleaning the checksum cache ec2-184-73-60-141.compute-1.amazonaws.com [Fri, 22 Oct 2010 14:18:40 +0000] INFO: Running report handlers ec2-184-73-60-141.compute-1.amazonaws.com [Fri, 22 Oct 2010 14:18:40 +0000] INFO: Report handlers complete P 0u 0u To query for all nodes that have the "webserver" role and then use SSH to run the command "sudo chef-client", enter: 0.0 3.5 $ knife ssh "role:webserver" "sudo chef-client" P 0u 0u 0.0 3.5 $ knife ssh name:* "sudo aptitude upgrade -y" P 0u 0u To specify the shell type used on the nodes returned by a search query: 0.0 3.5 $ knife ssh roles:opscode-omnitruck macterm P 0u 0u where screen is one of the following values: cssh, interactive, macterm, screen, or tmux. If the node does not have the shell type installed, Knife will return an error similar to the following: 0.0 3.5 you need the rb-appscript gem to use knife ssh macterm. `(sudo) gem install rb-appscript` to install ERROR: LoadError: cannot load such file -- appscript P 0u 0u
knife-ssl-check(1)
The man page for the knife ssl check subcommand. The knife ssl check subcommand is used to verify the SSL configuration for the Enterprise Chef and/or Open Source Chef servers, or at another location specified by a URL or URI. WARNING: 0.0 3.5 When verification of a remote server's SSL certificate is disabled, the chef-client will issue a warning similar to "SSL validation of HTTPS requests is disabled. HTTPS connections are still encrypted, but the chef-client is not able to detect forged replies or man-in-the-middle attacks." To configure SSL for the chef-client, set ssl_verify_mode to :verify_peer (recommended) or verify_api_cert to true in the client.rb file. 0u 0u Syntax This subcommand has the following syntax: 0.0 3.5 $ knife ssl check URI P 0u 0u Options This subcommand has the following options: 0.0 -a SSH_ATTR, --attribute SSH_ATTR The attribute that is used when opening the SSH connection. The default attribute is the FQDN of the host. Other possible values include a public IP address, a private IP address, or a hostname. -A, --forward-agent Use to enable SSH agent forwarding. -c CONFIG_FILE, --config CONFIG_FILE The configuration file to use. -C NUM, --concurrency NUM The number of allowed concurrent connections. --chef-zero-port PORT The port on which chef-zero will listen. --[no-]color Use to view colored output. -d, --disable-editing Use to prevent the $EDITOR from being opened and to accept data as-is. --defaults Use to have Knife use the default value instead of asking a user to provide one. -e EDITOR, --editor EDITOR The $EDITOR that is used for all interactive commands. -E ENVIRONMENT, --environment ENVIRONMENT The name of the environment. When this option is added to a command, the command will run only against the named environment. -F FORMAT, --format FORMAT The output format: summary (default), text, json, yaml, and pp. -G GATEWAY, --ssh-gateway GATEWAY The SSH tunnel or gateway that is used to run a bootstrap action on a machine that is not accessible from the workstation. -h, --help Shows help for the command. -i IDENTITY_FILE, --identity-file IDENTIFY_FILE The SSH identity file used for authentication. Key-based authentication is recommended. -k KEY, --key KEY The private key that Knife will use to sign requests made by the API client to the Chef server. -m, --manual-list Use to define a search query as a space-separated list of servers. If there is more than one item in the list, put quotes around the entire list. For example: --manual-list "server01 server 02 server 03" --[no-]host-key-verify Use --no-host-key-verify to disable host key verification. Default setting: --host-key-verify. OTHER The shell type. Possible values: interactive, screen, tmux, macterm, or cssh. (csshx is deprecated in favor of cssh.) -p PORT, --ssh-port PORT The SSH port. -P PASSWORD, --ssh-password PASSWORD The SSH password. This can be used to pass the password directly on the command line. If this option is not specified (and a password is required) Knife will prompt for the password. --print-after Use to show data after a destructive operation. -s URL, --server-url URL The URL for the Chef server. SEARCH_QUERY The search query used to return a list of servers to be accessed using SSH and the specified SSH_COMMAND. This option uses the same syntax as the search sub-command. SSH_COMMAND The command that will be run against the results of a search query. -u USER, --user USER The user name used by Knife to sign requests made by the API client to the Chef server. Authentication will fail if the user name does not match the private key. -v, --version The version of the chef-client. -V, --verbose Set for more verbose outputs. Use -VV for maximum verbosity. -x USER_NAME, --ssh-user USER_NAME The SSH user name. -y, --yes Use to respond to all confirmation prompts with "Yes". Knife will not ask for confirmation. -z, --local-mode Use to run the chef-client in local mode. This allows all commands that work against the Chef server to also work against the local chef-repo. 0u Examples The following examples show how to use this Knife subcommand: Verify the SSL configuration for the Chef server 0.0 3.5 $ knife ssl check P 0u 0u Verify the SSL configuration for the chef-client 0.0 3.5 $ knife ssl check -c /etc/chef/client.rb P 0u 0u Verify an external server's SSL certificate 0.0 3.5 $ knife ssl check URL_or_URI P 0u 0u for example: 0.0 3.5 $ knife ssl check https://www.getchef.com P 0u 0u
knife-ssl-check(1)
The man page for the knife ssl check subcommand. The knife ssl check subcommand is used to verify the SSL configuration for the Enterprise Chef and/or Open Source Chef servers, or at another location specified by a URL or URI. WARNING: 0.0 3.5 When verification of a remote server's SSL certificate is disabled, the chef-client will issue a warning similar to "SSL validation of HTTPS requests is disabled. HTTPS connections are still encrypted, but the chef-client is not able to detect forged replies or man-in-the-middle attacks." To configure SSL for the chef-client, set ssl_verify_mode to :verify_peer (recommended) or verify_api_cert to true in the client.rb file. 0u 0u Syntax This subcommand has the following syntax: 0.0 3.5 $ knife ssl check URI P 0u 0u Options This subcommand has the following options: 0.0 -a SSH_ATTR, --attribute SSH_ATTR The attribute that is used when opening the SSH connection. The default attribute is the FQDN of the host. Other possible values include a public IP address, a private IP address, or a hostname. -A, --forward-agent Use to enable SSH agent forwarding. -c CONFIG_FILE, --config CONFIG_FILE The configuration file to use. -C NUM, --concurrency NUM The number of allowed concurrent connections. --chef-zero-port PORT The port on which chef-zero will listen. --[no-]color Use to view colored output. -d, --disable-editing Use to prevent the $EDITOR from being opened and to accept data as-is. --defaults Use to have Knife use the default value instead of asking a user to provide one. -e EDITOR, --editor EDITOR The $EDITOR that is used for all interactive commands. -E ENVIRONMENT, --environment ENVIRONMENT The name of the environment. When this option is added to a command, the command will run only against the named environment. -F FORMAT, --format FORMAT The output format: summary (default), text, json, yaml, and pp. -G GATEWAY, --ssh-gateway GATEWAY The SSH tunnel or gateway that is used to run a bootstrap action on a machine that is not accessible from the workstation. -h, --help Shows help for the command. -i IDENTITY_FILE, --identity-file IDENTIFY_FILE The SSH identity file used for authentication. Key-based authentication is recommended. -k KEY, --key KEY The private key that Knife will use to sign requests made by the API client to the Chef server. -m, --manual-list Use to define a search query as a space-separated list of servers. If there is more than one item in the list, put quotes around the entire list. For example: --manual-list "server01 server 02 server 03" --[no-]host-key-verify Use --no-host-key-verify to disable host key verification. Default setting: --host-key-verify. OTHER The shell type. Possible values: interactive, screen, tmux, macterm, or cssh. (csshx is deprecated in favor of cssh.) -p PORT, --ssh-port PORT The SSH port. -P PASSWORD, --ssh-password PASSWORD The SSH password. This can be used to pass the password directly on the command line. If this option is not specified (and a password is required) Knife will prompt for the password. --print-after Use to show data after a destructive operation. -s URL, --server-url URL The URL for the Chef server. SEARCH_QUERY The search query used to return a list of servers to be accessed using SSH and the specified SSH_COMMAND. This option uses the same syntax as the search sub-command. SSH_COMMAND The command that will be run against the results of a search query. -u USER, --user USER The user name used by Knife to sign requests made by the API client to the Chef server. Authentication will fail if the user name does not match the private key. -v, --version The version of the chef-client. -V, --verbose Set for more verbose outputs. Use -VV for maximum verbosity. -x USER_NAME, --ssh-user USER_NAME The SSH user name. -y, --yes Use to respond to all confirmation prompts with "Yes". Knife will not ask for confirmation. -z, --local-mode Use to run the chef-client in local mode. This allows all commands that work against the Chef server to also work against the local chef-repo. 0u Examples The following examples show how to use this Knife subcommand: Verify the SSL configuration for the Chef server 0.0 3.5 $ knife ssl check P 0u 0u Verify the SSL configuration for the chef-client 0.0 3.5 $ knife ssl check -c /etc/chef/client.rb P 0u 0u Verify an external server's SSL certificate 0.0 3.5 $ knife ssl check URL_or_URI P 0u 0u for example: 0.0 3.5 $ knife ssl check https://www.getchef.com P 0u 0u
knife-ssl-fetch(1)
The man page for the knife ssl fetch subcommand. The knife ssl fetch subcommand is used to copy SSL certificates from an HTTPS server to the trusted_certs_dir directory that is used by Knife and the chef-client to store trusted SSL certificates. When these certificates match the hostname of the remote server, running knife ssl fetch is the only step required to verify a remote server that is accessed by either Knife or the chef-client. WARNING: 0.0 3.5 It is the user's responsibility to verify the authenticity of every SSL certificate before downloading it to the trusted_certs_dir directory. Knife will use any certificate in that directory as if it is a 100% trusted and authentic SSL certificate. Knife will not be able to determine if any certificate in this directory has been tampered with, is forged, malicious, or otherwise harmful. Therefore it is essential that users take the proper steps before downloading certificates into this directory. 0u 0u Syntax This subcommand has the following syntax: 0.0 3.5 $ knife ssl fetch URI_FOR_HTTPS_SERVER P 0u 0u Options This subcommand has the following options: 0.0 -a SSH_ATTR, --attribute SSH_ATTR The attribute that is used when opening the SSH connection. The default attribute is the FQDN of the host. Other possible values include a public IP address, a private IP address, or a hostname. -A, --forward-agent Use to enable SSH agent forwarding. -c CONFIG_FILE, --config CONFIG_FILE The configuration file to use. -C NUM, --concurrency NUM The number of allowed concurrent connections. --chef-zero-port PORT The port on which chef-zero will listen. --[no-]color Use to view colored output. -d, --disable-editing Use to prevent the $EDITOR from being opened and to accept data as-is. --defaults Use to have Knife use the default value instead of asking a user to provide one. -e EDITOR, --editor EDITOR The $EDITOR that is used for all interactive commands. -E ENVIRONMENT, --environment ENVIRONMENT The name of the environment. When this option is added to a command, the command will run only against the named environment. -F FORMAT, --format FORMAT The output format: summary (default), text, json, yaml, and pp. -G GATEWAY, --ssh-gateway GATEWAY The SSH tunnel or gateway that is used to run a bootstrap action on a machine that is not accessible from the workstation. -h, --help Shows help for the command. -i IDENTITY_FILE, --identity-file IDENTIFY_FILE The SSH identity file used for authentication. Key-based authentication is recommended. -k KEY, --key KEY The private key that Knife will use to sign requests made by the API client to the Chef server. -m, --manual-list Use to define a search query as a space-separated list of servers. If there is more than one item in the list, put quotes around the entire list. For example: --manual-list "server01 server 02 server 03" --[no-]host-key-verify Use --no-host-key-verify to disable host key verification. Default setting: --host-key-verify. OTHER The shell type. Possible values: interactive, screen, tmux, macterm, or cssh. (csshx is deprecated in favor of cssh.) -p PORT, --ssh-port PORT The SSH port. -P PASSWORD, --ssh-password PASSWORD The SSH password. This can be used to pass the password directly on the command line. If this option is not specified (and a password is required) Knife will prompt for the password. --print-after Use to show data after a destructive operation. -s URL, --server-url URL The URL for the Chef server. SEARCH_QUERY The search query used to return a list of servers to be accessed using SSH and the specified SSH_COMMAND. This option uses the same syntax as the search sub-command. SSH_COMMAND The command that will be run against the results of a search query. -u USER, --user USER The user name used by Knife to sign requests made by the API client to the Chef server. Authentication will fail if the user name does not match the private key. -v, --version The version of the chef-client. -V, --verbose Set for more verbose outputs. Use -VV for maximum verbosity. -x USER_NAME, --ssh-user USER_NAME The SSH user name. -y, --yes Use to respond to all confirmation prompts with "Yes". Knife will not ask for confirmation. -z, --local-mode Use to run the chef-client in local mode. This allows all commands that work against the Chef server to also work against the local chef-repo. 0u Examples The following examples show how to use this Knife subcommand: Fetch the SSL certificates used by Knife from the Chef server 0.0 3.5 $ knife ssl fetch P 0u 0u Fetch the SSL certificates used by the chef-client from the Chef server 0.0 3.5 $ knife ssl fetch -c /etc/chef/client.rb P 0u 0u Fetch SSL certificates from a URL or URI 0.0 3.5 $ knife ssl fetch URL_or_URI P 0u 0u for example: 0.0 3.5 $ knife ssl fetch https://www.getchef.com P 0u 0u
knife-ssl-fetch(1)
The man page for the knife ssl fetch subcommand. The knife ssl fetch subcommand is used to copy SSL certificates from an HTTPS server to the trusted_certs_dir directory that is used by Knife and the chef-client to store trusted SSL certificates. When these certificates match the hostname of the remote server, running knife ssl fetch is the only step required to verify a remote server that is accessed by either Knife or the chef-client. WARNING: 0.0 3.5 It is the user's responsibility to verify the authenticity of every SSL certificate before downloading it to the trusted_certs_dir directory. Knife will use any certificate in that directory as if it is a 100% trusted and authentic SSL certificate. Knife will not be able to determine if any certificate in this directory has been tampered with, is forged, malicious, or otherwise harmful. Therefore it is essential that users take the proper steps before downloading certificates into this directory. 0u 0u Syntax This subcommand has the following syntax: 0.0 3.5 $ knife ssl fetch URI_FOR_HTTPS_SERVER P 0u 0u Options This subcommand has the following options: 0.0 -a SSH_ATTR, --attribute SSH_ATTR The attribute that is used when opening the SSH connection. The default attribute is the FQDN of the host. Other possible values include a public IP address, a private IP address, or a hostname. -A, --forward-agent Use to enable SSH agent forwarding. -c CONFIG_FILE, --config CONFIG_FILE The configuration file to use. -C NUM, --concurrency NUM The number of allowed concurrent connections. --chef-zero-port PORT The port on which chef-zero will listen. --[no-]color Use to view colored output. -d, --disable-editing Use to prevent the $EDITOR from being opened and to accept data as-is. --defaults Use to have Knife use the default value instead of asking a user to provide one. -e EDITOR, --editor EDITOR The $EDITOR that is used for all interactive commands. -E ENVIRONMENT, --environment ENVIRONMENT The name of the environment. When this option is added to a command, the command will run only against the named environment. -F FORMAT, --format FORMAT The output format: summary (default), text, json, yaml, and pp. -G GATEWAY, --ssh-gateway GATEWAY The SSH tunnel or gateway that is used to run a bootstrap action on a machine that is not accessible from the workstation. -h, --help Shows help for the command. -i IDENTITY_FILE, --identity-file IDENTIFY_FILE The SSH identity file used for authentication. Key-based authentication is recommended. -k KEY, --key KEY The private key that Knife will use to sign requests made by the API client to the Chef server. -m, --manual-list Use to define a search query as a space-separated list of servers. If there is more than one item in the list, put quotes around the entire list. For example: --manual-list "server01 server 02 server 03" --[no-]host-key-verify Use --no-host-key-verify to disable host key verification. Default setting: --host-key-verify. OTHER The shell type. Possible values: interactive, screen, tmux, macterm, or cssh. (csshx is deprecated in favor of cssh.) -p PORT, --ssh-port PORT The SSH port. -P PASSWORD, --ssh-password PASSWORD The SSH password. This can be used to pass the password directly on the command line. If this option is not specified (and a password is required) Knife will prompt for the password. --print-after Use to show data after a destructive operation. -s URL, --server-url URL The URL for the Chef server. SEARCH_QUERY The search query used to return a list of servers to be accessed using SSH and the specified SSH_COMMAND. This option uses the same syntax as the search sub-command. SSH_COMMAND The command that will be run against the results of a search query. -u USER, --user USER The user name used by Knife to sign requests made by the API client to the Chef server. Authentication will fail if the user name does not match the private key. -v, --version The version of the chef-client. -V, --verbose Set for more verbose outputs. Use -VV for maximum verbosity. -x USER_NAME, --ssh-user USER_NAME The SSH user name. -y, --yes Use to respond to all confirmation prompts with "Yes". Knife will not ask for confirmation. -z, --local-mode Use to run the chef-client in local mode. This allows all commands that work against the Chef server to also work against the local chef-repo. 0u Examples The following examples show how to use this Knife subcommand: Fetch the SSL certificates used by Knife from the Chef server 0.0 3.5 $ knife ssl fetch P 0u 0u Fetch the SSL certificates used by the chef-client from the Chef server 0.0 3.5 $ knife ssl fetch -c /etc/chef/client.rb P 0u 0u Fetch SSL certificates from a URL or URI 0.0 3.5 $ knife ssl fetch URL_or_URI P 0u 0u for example: 0.0 3.5 $ knife ssl fetch https://www.getchef.com P 0u 0u
knife-status(1)
The man page for the knife status subcommand. The knife status subcommand is used to display a brief summary of the nodes on a Chef server, including the time of the most recent successful chef-client run. Syntax This subcommand has the following syntax: 0.0 3.5 $ knife status (options) P 0u 0u Options This subcommand has the following options: 0.0 -c CONFIG_FILE, --config CONFIG_FILE The configuration file to use. --chef-zero-port PORT The port on which chef-zero will listen. --[no-]color Use to view colored output. -d, --disable-editing Use to prevent the $EDITOR from being opened and to accept data as-is. --defaults Use to have Knife use the default value instead of asking a user to provide one. -e EDITOR, --editor EDITOR The $EDITOR that is used for all interactive commands. -E ENVIRONMENT, --environment ENVIRONMENT The name of the environment. When this option is added to a command, the command will run only against the named environment. -F FORMAT, --format FORMAT The output format: summary (default), text, json, yaml, and pp. -h, --help Shows help for the command. -H, --hide-healthy Use to hide nodes on which a chef-client run has occurred within the previous hour. -k KEY, --key KEY The private key that Knife will use to sign requests made by the API client to the Chef server. --print-after Use to show data after a destructive operation. SEARCH_QUERY The search query used to identify a a list of items on a Chef server. This option uses the same syntax as the search sub-command. -r RUN_LIST, --run-list RUN_LIST A comma-separated list of roles and/or recipes to be applied. -s, --sort-reverse Use to sort a list by last run time, descending. --server-url URL The URL for the Chef server. -u USER, --user USER The user name used by Knife to sign requests made by the API client to the Chef server. Authentication will fail if the user name does not match the private key. -v, --version The version of the chef-client. -V, --verbose Set for more verbose outputs. Use -VV for maximum verbosity. -y, --yes Use to respond to all confirmation prompts with "Yes". Knife will not ask for confirmation. -z, --local-mode Use to run the chef-client in local mode. This allows all commands that work against the Chef server to also work against the local chef-repo. 0u Examples To include run lists in the status, enter: 0.0 3.5 $ knife status --run-list P 0u 0u to return something like: 0.0 3.5 20 hours ago, dev-vm.chisamore.com, ubuntu 10.04, dev-vm.chisamore.com, 10.66.44.126, role[lb]. 3 hours ago, i-225f954f, ubuntu 10.04, ec2-67-202-63-102.compute-1.amazonaws.com, 67.202.63.102, role[web]. 3 hours ago, i-a45298c9, ubuntu 10.04, ec2-174-129-127-206.compute-1.amazonaws.com, 174.129.127.206, role[web]. 3 hours ago, i-5272a43f, ubuntu 10.04, ec2-184-73-9-250.compute-1.amazonaws.com, 184.73.9.250, role[web]. 3 hours ago, i-226ca64f, ubuntu 10.04, ec2-75-101-240-230.compute-1.amazonaws.com, 75.101.240.230, role[web]. 3 hours ago, i-f65c969b, ubuntu 10.04, ec2-184-73-60-141.compute-1.amazonaws.com, 184.73.60.141, role[web]. P 0u 0u To show the status for nodes on which the chef-client did not run successfully within the past hour, enter: 0.0 3.5 $ knife status --hide-healthy P 0u 0u to return something like: 0.0 3.5 1 hour ago, i-256f884f, ubuntu 12.04, ec2-67-202-63-102.compute-1.amazonaws.com, 67.202.63.102, role[web]. 1 hour ago, i-a47823c9, ubuntu 10.04, ec2-174-129-127-206.compute-1.amazonaws.com, 184.129.143.111, role[lb]. P 0u 0u To show the status of a subset of nodes that are returned by a specific query, enter: 0.0 3.5 $ knife status "role:web" --run-list P 0u 0u to return something like: 0.0 3.5 3 hours ago, i-225f954f, ubuntu 10.04, ec2-67-202-63-102.compute-1.amazonaws.com, 67.202.63.102, role[web]. 3 hours ago, i-a45298c9, ubuntu 10.04, ec2-174-129-127-206.compute-1.amazonaws.com, 174.129.127.206, role[web]. 3 hours ago, i-5272a43f, ubuntu 10.04, ec2-184-73-9-250.compute-1.amazonaws.com, 184.73.9.250, role[web]. 3 hours ago, i-226ca64f, ubuntu 10.04, ec2-75-101-240-230.compute-1.amazonaws.com, 75.101.240.230, role[web]. 3 hours ago, i-f65c969b, ubuntu 10.04, ec2-184-73-60-141.compute-1.amazonaws.com, 184.73.60.141, role[web]. P 0u 0u To view the status of all nodes in the organization, enter: 0.0 3.5 $ knife status P 0u 0u to return something like: 0.0 3.5 20 hours ago, dev-vm.chisamore.com, ubuntu 10.04, dev-vm.chisamore.com, 10.66.44.126 3 hours ago, i-225f954f, ubuntu 10.04, ec2-67-202-63-102.compute-1.amazonaws.com, 67.202.63.102 3 hours ago, i-a45298c9, ubuntu 10.04, ec2-174-129-127-206.compute-1.amazonaws.com, 174.129.127.206 3 hours ago, i-5272a43f, ubuntu 10.04, ec2-184-73-9-250.compute-1.amazonaws.com, 184.73.9.250 3 hours ago, i-226ca64f, ubuntu 10.04, ec2-75-101-240-230.compute-1.amazonaws.com, 75.101.240.230 3 hours ago, i-f65c969b, ubuntu 10.04, ec2-184-73-60-141.compute-1.amazonaws.com, 184.73.60.141 P 0u 0u
knife-status(1)
The man page for the knife status subcommand. The knife status subcommand is used to display a brief summary of the nodes on a Chef server, including the time of the most recent successful chef-client run. Syntax This subcommand has the following syntax: 0.0 3.5 $ knife status (options) P 0u 0u Options This subcommand has the following options: 0.0 -c CONFIG_FILE, --config CONFIG_FILE The configuration file to use. --chef-zero-port PORT The port on which chef-zero will listen. --[no-]color Use to view colored output. -d, --disable-editing Use to prevent the $EDITOR from being opened and to accept data as-is. --defaults Use to have Knife use the default value instead of asking a user to provide one. -e EDITOR, --editor EDITOR The $EDITOR that is used for all interactive commands. -E ENVIRONMENT, --environment ENVIRONMENT The name of the environment. When this option is added to a command, the command will run only against the named environment. -F FORMAT, --format FORMAT The output format: summary (default), text, json, yaml, and pp. -h, --help Shows help for the command. -H, --hide-healthy Use to hide nodes on which a chef-client run has occurred within the previous hour. -k KEY, --key KEY The private key that Knife will use to sign requests made by the API client to the Chef server. --print-after Use to show data after a destructive operation. SEARCH_QUERY The search query used to identify a a list of items on a Chef server. This option uses the same syntax as the search sub-command. -r RUN_LIST, --run-list RUN_LIST A comma-separated list of roles and/or recipes to be applied. -s, --sort-reverse Use to sort a list by last run time, descending. --server-url URL The URL for the Chef server. -u USER, --user USER The user name used by Knife to sign requests made by the API client to the Chef server. Authentication will fail if the user name does not match the private key. -v, --version The version of the chef-client. -V, --verbose Set for more verbose outputs. Use -VV for maximum verbosity. -y, --yes Use to respond to all confirmation prompts with "Yes". Knife will not ask for confirmation. -z, --local-mode Use to run the chef-client in local mode. This allows all commands that work against the Chef server to also work against the local chef-repo. 0u Examples To include run lists in the status, enter: 0.0 3.5 $ knife status --run-list P 0u 0u to return something like: 0.0 3.5 20 hours ago, dev-vm.chisamore.com, ubuntu 10.04, dev-vm.chisamore.com, 10.66.44.126, role[lb]. 3 hours ago, i-225f954f, ubuntu 10.04, ec2-67-202-63-102.compute-1.amazonaws.com, 67.202.63.102, role[web]. 3 hours ago, i-a45298c9, ubuntu 10.04, ec2-174-129-127-206.compute-1.amazonaws.com, 174.129.127.206, role[web]. 3 hours ago, i-5272a43f, ubuntu 10.04, ec2-184-73-9-250.compute-1.amazonaws.com, 184.73.9.250, role[web]. 3 hours ago, i-226ca64f, ubuntu 10.04, ec2-75-101-240-230.compute-1.amazonaws.com, 75.101.240.230, role[web]. 3 hours ago, i-f65c969b, ubuntu 10.04, ec2-184-73-60-141.compute-1.amazonaws.com, 184.73.60.141, role[web]. P 0u 0u To show the status for nodes on which the chef-client did not run successfully within the past hour, enter: 0.0 3.5 $ knife status --hide-healthy P 0u 0u to return something like: 0.0 3.5 1 hour ago, i-256f884f, ubuntu 12.04, ec2-67-202-63-102.compute-1.amazonaws.com, 67.202.63.102, role[web]. 1 hour ago, i-a47823c9, ubuntu 10.04, ec2-174-129-127-206.compute-1.amazonaws.com, 184.129.143.111, role[lb]. P 0u 0u To show the status of a subset of nodes that are returned by a specific query, enter: 0.0 3.5 $ knife status "role:web" --run-list P 0u 0u to return something like: 0.0 3.5 3 hours ago, i-225f954f, ubuntu 10.04, ec2-67-202-63-102.compute-1.amazonaws.com, 67.202.63.102, role[web]. 3 hours ago, i-a45298c9, ubuntu 10.04, ec2-174-129-127-206.compute-1.amazonaws.com, 174.129.127.206, role[web]. 3 hours ago, i-5272a43f, ubuntu 10.04, ec2-184-73-9-250.compute-1.amazonaws.com, 184.73.9.250, role[web]. 3 hours ago, i-226ca64f, ubuntu 10.04, ec2-75-101-240-230.compute-1.amazonaws.com, 75.101.240.230, role[web]. 3 hours ago, i-f65c969b, ubuntu 10.04, ec2-184-73-60-141.compute-1.amazonaws.com, 184.73.60.141, role[web]. P 0u 0u To view the status of all nodes in the organization, enter: 0.0 3.5 $ knife status P 0u 0u to return something like: 0.0 3.5 20 hours ago, dev-vm.chisamore.com, ubuntu 10.04, dev-vm.chisamore.com, 10.66.44.126 3 hours ago, i-225f954f, ubuntu 10.04, ec2-67-202-63-102.compute-1.amazonaws.com, 67.202.63.102 3 hours ago, i-a45298c9, ubuntu 10.04, ec2-174-129-127-206.compute-1.amazonaws.com, 174.129.127.206 3 hours ago, i-5272a43f, ubuntu 10.04, ec2-184-73-9-250.compute-1.amazonaws.com, 184.73.9.250 3 hours ago, i-226ca64f, ubuntu 10.04, ec2-75-101-240-230.compute-1.amazonaws.com, 75.101.240.230 3 hours ago, i-f65c969b, ubuntu 10.04, ec2-184-73-60-141.compute-1.amazonaws.com, 184.73.60.141 P 0u 0u
knife-upload(1)
The man page for the knife upload subcommand. The knife upload subcommand is used to upload roles, cookbooks, environments, and data bags to the Chef server from the current working directory in the chef-repo. This subcommand is often used in conjunction with knife diff, which can be used to see exactly what changes will be uploaded, and then knife download, which does the opposite of knife upload. Syntax This subcommand has the following syntax: 0.0 3.5 $ knife upload [PATTERN...] (options) P 0u 0u Options This subcommand has the following options: 0.0 -c CONFIG_FILE, --config CONFIG_FILE The configuration file to use. --chef-repo-path PATH The path to the chef-repo. This setting will override the default path to the chef-repo. Default: same as specified by chef_repo_path in config.rb. --chef-zero-port PORT The port on which chef-zero will listen. --[no-]color Use to view colored output. --concurrency The number of allowed concurrent connections. Default: 10. -d, --disable-editing Use to prevent the $EDITOR from being opened and to accept data as-is. --defaults Use to have Knife use the default value instead of asking a user to provide one. --[no-]diff Use to upload only new and modified files. Set to false to upload all files. Default: true. -e EDITOR, --editor EDITOR The $EDITOR that is used for all interactive commands. -E ENVIRONMENT, --environment ENVIRONMENT The name of the environment. When this option is added to a command, the command will run only against the named environment. -F FORMAT, --format FORMAT The output format: summary (default), text, json, yaml, and pp. --[no-]force Use --force to upload roles, cookbooks, etc. even if the file in the directory is identical (by default, no POST or PUT is performed unless an actual change would be made). Default: --no-force. --[no-]freeze Use to require changes to a cookbook be included as a new version. Only the --force option can override this setting. Default: false. -h, --help Shows help for the command. -k KEY, --key KEY The private key that Knife will use to sign requests made by the API client to the Chef server. -n, --dry-run Use to take no action and only print out results. Default: false. --print-after Use to show data after a destructive operation. --[no-]purge Use --purge to delete roles, cookbooks, etc. from the Chef server if their corresponding files do not exist in the chef-repo. By default, such objects are left alone and NOT purged. Default: --no-purge. --[no-]recurse Use --no-recurse to disable uploading a directory recursively. Default: --recurse. --repo-mode MODE The layout of the local chef-repo. Possible values: static, everything, or hosted_everything. Use static for just roles, environments, cookbooks, and data bags. By default, everything and hosted_everything are dynamically selected depending on the server type. Default: everything / hosted_everything. -s URL, --server-url URL The URL for the Chef server. -u USER, --user USER The user name used by Knife to sign requests made by the API client to the Chef server. Authentication will fail if the user name does not match the private key. -v, --version The version of the chef-client. -V, --verbose Set for more verbose outputs. Use -VV for maximum verbosity. -y, --yes Use to respond to all confirmation prompts with "Yes". Knife will not ask for confirmation. -z, --local-mode Use to run the chef-client in local mode. This allows all commands that work against the Chef server to also work against the local chef-repo. 0u Examples Browse to the top level of the chef-repo and enter: 0.0 3.5 $ knife upload P 0u 0u or from anywhere in the chef-repo, enter: 0.0 3.5 $ knife upload / P 0u 0u Browse to the top level of the chef-repo and enter: 0.0 3.5 $ knife upload cookbooks P 0u 0u or from anywhere in the chef-repo, enter: 0.0 3.5 $ knife upload /cookbooks P 0u 0u Browse to the top level of the chef-repo and enter: 0.0 3.5 $ knife upload environments P 0u 0u or from anywhere in the chef-repo, enter: 0.0 3.5 $ knife upload /environments P 0u 0u Browse to the top level of the chef-repo and enter: 0.0 3.5 $ knife upload environments/production.json P 0u 0u or from the environments/ directory, enter: 0.0 3.5 $ knife upload production.json P 0u 0u Browse to the top level of the chef-repo and enter: 0.0 3.5 $ knife upload roles P 0u 0u or from anywhere in the chef-repo, enter: 0.0 3.5 $ knife upload /roles P 0u 0u Browse to the top level of the chef-repo and enter: 0.0 3.5 $ knife upload cookbooks/apache\* roles/webserver.json P 0u 0u 0.0 3.5 $ knife upload `knife deps nodes/*.json` P 0u 0u
knife-upload(1)
The man page for the knife upload subcommand. The knife upload subcommand is used to upload roles, cookbooks, environments, and data bags to the Chef server from the current working directory in the chef-repo. This subcommand is often used in conjunction with knife diff, which can be used to see exactly what changes will be uploaded, and then knife download, which does the opposite of knife upload. Syntax This subcommand has the following syntax: 0.0 3.5 $ knife upload [PATTERN...] (options) P 0u 0u Options This subcommand has the following options: 0.0 -c CONFIG_FILE, --config CONFIG_FILE The configuration file to use. --chef-repo-path PATH The path to the chef-repo. This setting will override the default path to the chef-repo. Default: same as specified by chef_repo_path in config.rb. --chef-zero-port PORT The port on which chef-zero will listen. --[no-]color Use to view colored output. --concurrency The number of allowed concurrent connections. Default: 10. -d, --disable-editing Use to prevent the $EDITOR from being opened and to accept data as-is. --defaults Use to have Knife use the default value instead of asking a user to provide one. --[no-]diff Use to upload only new and modified files. Set to false to upload all files. Default: true. -e EDITOR, --editor EDITOR The $EDITOR that is used for all interactive commands. -E ENVIRONMENT, --environment ENVIRONMENT The name of the environment. When this option is added to a command, the command will run only against the named environment. -F FORMAT, --format FORMAT The output format: summary (default), text, json, yaml, and pp. --[no-]force Use --force to upload roles, cookbooks, etc. even if the file in the directory is identical (by default, no POST or PUT is performed unless an actual change would be made). Default: --no-force. --[no-]freeze Use to require changes to a cookbook be included as a new version. Only the --force option can override this setting. Default: false. -h, --help Shows help for the command. -k KEY, --key KEY The private key that Knife will use to sign requests made by the API client to the Chef server. -n, --dry-run Use to take no action and only print out results. Default: false. --print-after Use to show data after a destructive operation. --[no-]purge Use --purge to delete roles, cookbooks, etc. from the Chef server if their corresponding files do not exist in the chef-repo. By default, such objects are left alone and NOT purged. Default: --no-purge. --[no-]recurse Use --no-recurse to disable uploading a directory recursively. Default: --recurse. --repo-mode MODE The layout of the local chef-repo. Possible values: static, everything, or hosted_everything. Use static for just roles, environments, cookbooks, and data bags. By default, everything and hosted_everything are dynamically selected depending on the server type. Default: everything / hosted_everything. -s URL, --server-url URL The URL for the Chef server. -u USER, --user USER The user name used by Knife to sign requests made by the API client to the Chef server. Authentication will fail if the user name does not match the private key. -v, --version The version of the chef-client. -V, --verbose Set for more verbose outputs. Use -VV for maximum verbosity. -y, --yes Use to respond to all confirmation prompts with "Yes". Knife will not ask for confirmation. -z, --local-mode Use to run the chef-client in local mode. This allows all commands that work against the Chef server to also work against the local chef-repo. 0u Examples Browse to the top level of the chef-repo and enter: 0.0 3.5 $ knife upload P 0u 0u or from anywhere in the chef-repo, enter: 0.0 3.5 $ knife upload / P 0u 0u Browse to the top level of the chef-repo and enter: 0.0 3.5 $ knife upload cookbooks P 0u 0u or from anywhere in the chef-repo, enter: 0.0 3.5 $ knife upload /cookbooks P 0u 0u Browse to the top level of the chef-repo and enter: 0.0 3.5 $ knife upload environments P 0u 0u or from anywhere in the chef-repo, enter: 0.0 3.5 $ knife upload /environments P 0u 0u Browse to the top level of the chef-repo and enter: 0.0 3.5 $ knife upload environments/production.json P 0u 0u or from the environments/ directory, enter: 0.0 3.5 $ knife upload production.json P 0u 0u Browse to the top level of the chef-repo and enter: 0.0 3.5 $ knife upload roles P 0u 0u or from anywhere in the chef-repo, enter: 0.0 3.5 $ knife upload /roles P 0u 0u Browse to the top level of the chef-repo and enter: 0.0 3.5 $ knife upload cookbooks/apache\* roles/webserver.json P 0u 0u 0.0 3.5 $ knife upload `knife deps nodes/*.json` P 0u 0u
knife-xargs(1)
The man page for the knife xargs subcommand. The knife xargs subcommand is used to build and execute command lines against objects on a Chef server using standard input. Syntax This subcommand has the following syntax: 0.0 3.5 $ knife xargs [PATTERN...] (options) P 0u 0u Options This subcommand has the following options: 0.0 -0 Indicates that a NULL character (\0) will be used as a separator, instead of white space. Default: false. --chef-repo-path PATH The path to the chef-repo. This setting will override the default path to the chef-repo. Default: same as specified by chef_repo_path in config.rb. --concurrency The number of allowed concurrent connections. Default: 10. --[no-]diff Use to show a diff when a file changes. Default: --diff. --dry-run Use to prevent changes from being uploaded to the Chef server. Default: false. --[no-]force Use to force the upload of files even if they haven't been changed. Default: --no-force. -I REPLACE_STRING, --replace REPLACE_STRING Use to define a string that will be used to replace all occurrences of a file name. Default: nil. -J REPLACE_STRING, --replace-first REPLACE_STRING Use to define a string that will be used to replace the first occurrence of a file name. Default: nil. --local Indicates that a command line will be built or executed against a local file. Set to false to build or execute against a remote file. Default: false. -n MAX_ARGS, --max-args MAX_ARGS The maximum number of arguments per command line. Default: nil. -p [PATTERN...], --pattern [PATTERN...] One (or more) patterns for a command line. If this option is not specified, a list of patterns may be expected on standard input. Default: nil. --repo-mode MODE The layout of the local chef-repo. Possible values: static, everything, or hosted_everything. Use static for just roles, environments, cookbooks, and data bags. By default, everything and hosted_everything are dynamically selected depending on the server type. Default value: default. -s LENGTH, --max-chars LENGTH The maximum size (in characters) for a command line. Default: nil. -t Indicates that the print command will be run on the command line. Default: nil. -c CONFIG_FILE, --config CONFIG_FILE The configuration file to use. --chef-zero-port PORT The port on which chef-zero will listen. -d, --disable-editing Use to prevent the $EDITOR from being opened and to accept data as-is. --defaults Use to have Knife use the default value instead of asking a user to provide one. -e EDITOR, --editor EDITOR The $EDITOR that is used for all interactive commands. -E ENVIRONMENT, --environment ENVIRONMENT The name of the environment. When this option is added to a command, the command will run only against the named environment. -F FORMAT, --format FORMAT The output format: summary (default), text, json, yaml, and pp. -h, --help Shows help for the command. -k KEY, --key KEY The private key that Knife will use to sign requests made by the API client to the Chef server. --[no-]color Use to view colored output. --print-after Use to show data after a destructive operation. --server-url URL The URL for the Chef server. -u USER, --user USER The user name used by Knife to sign requests made by the API client to the Chef server. Authentication will fail if the user name does not match the private key. -v, --version The version of the chef-client. -V, --verbose Set for more verbose outputs. Use -VV for maximum verbosity. -y, --yes Use to respond to all confirmation prompts with "Yes". Knife will not ask for confirmation. -z, --local-mode Use to run the chef-client in local mode. This allows all commands that work against the Chef server to also work against the local chef-repo. 0u Examples 0.0 3.5 $ knife deps nodes/*.json | xargs knife upload P 0u 0u
knife-xargs(1)
The man page for the knife xargs subcommand. The knife xargs subcommand is used to build and execute command lines against objects on a Chef server using standard input. Syntax This subcommand has the following syntax: 0.0 3.5 $ knife xargs [PATTERN...] (options) P 0u 0u Options This subcommand has the following options: 0.0 -0 Indicates that a NULL character (\0) will be used as a separator, instead of white space. Default: false. --chef-repo-path PATH The path to the chef-repo. This setting will override the default path to the chef-repo. Default: same as specified by chef_repo_path in config.rb. --concurrency The number of allowed concurrent connections. Default: 10. --[no-]diff Use to show a diff when a file changes. Default: --diff. --dry-run Use to prevent changes from being uploaded to the Chef server. Default: false. --[no-]force Use to force the upload of files even if they haven't been changed. Default: --no-force. -I REPLACE_STRING, --replace REPLACE_STRING Use to define a string that will be used to replace all occurrences of a file name. Default: nil. -J REPLACE_STRING, --replace-first REPLACE_STRING Use to define a string that will be used to replace the first occurrence of a file name. Default: nil. --local Indicates that a command line will be built or executed against a local file. Set to false to build or execute against a remote file. Default: false. -n MAX_ARGS, --max-args MAX_ARGS The maximum number of arguments per command line. Default: nil. -p [PATTERN...], --pattern [PATTERN...] One (or more) patterns for a command line. If this option is not specified, a list of patterns may be expected on standard input. Default: nil. --repo-mode MODE The layout of the local chef-repo. Possible values: static, everything, or hosted_everything. Use static for just roles, environments, cookbooks, and data bags. By default, everything and hosted_everything are dynamically selected depending on the server type. Default value: default. -s LENGTH, --max-chars LENGTH The maximum size (in characters) for a command line. Default: nil. -t Indicates that the print command will be run on the command line. Default: nil. -c CONFIG_FILE, --config CONFIG_FILE The configuration file to use. --chef-zero-port PORT The port on which chef-zero will listen. -d, --disable-editing Use to prevent the $EDITOR from being opened and to accept data as-is. --defaults Use to have Knife use the default value instead of asking a user to provide one. -e EDITOR, --editor EDITOR The $EDITOR that is used for all interactive commands. -E ENVIRONMENT, --environment ENVIRONMENT The name of the environment. When this option is added to a command, the command will run only against the named environment. -F FORMAT, --format FORMAT The output format: summary (default), text, json, yaml, and pp. -h, --help Shows help for the command. -k KEY, --key KEY The private key that Knife will use to sign requests made by the API client to the Chef server. --[no-]color Use to view colored output. --print-after Use to show data after a destructive operation. --server-url URL The URL for the Chef server. -u USER, --user USER The user name used by Knife to sign requests made by the API client to the Chef server. Authentication will fail if the user name does not match the private key. -v, --version The version of the chef-client. -V, --verbose Set for more verbose outputs. Use -VV for maximum verbosity. -y, --yes Use to respond to all confirmation prompts with "Yes". Knife will not ask for confirmation. -z, --local-mode Use to run the chef-client in local mode. This allows all commands that work against the Chef server to also work against the local chef-repo. 0u Examples 0.0 3.5 $ knife deps nodes/*.json | xargs knife upload P 0u 0u
kripp(1)
is a network passwords sniffer. Its name is an acronym for "kripp is rest in peace, privacy". Supported protocols are icq, aim, pop3, ftp, http and cvs.
ktutilserv(1)
server implementations to test miscellaneous utilities
kvno(1)
print key version numbers of Kerberos principals
kwalitee-metrics(1)
list details of all kwalitee metrics installed on the system
label3d(1, l)
process a Raster3D scene containing labels
latexdiff-vc(1)
wrapper script that calls latexdiff for different versions of a file under version management (CVS, RCS or SVN)
lbdb-fetchaddr(1)
grab addresses from mails add append them to lbdb database
ldapfinger(1)
displays a user/machine/group POSIX account's details.
ldapmodify, ldapadd(1)
LDAP modify entry and LDAP add entry tools
ldns-dane(1)
verify or create TLS authentication with DANE (RFC6698)
ldns-version(1)
print out the version of the ldns-library and tools on this system
leocad, LeoCAD(1)
CAD program for LEGO models.
linkedto, linkedTo(1)
Shellscript to show linked Areas
listfonts.pl(1)
Print details of the fonts used in the PDF
lmdbg-run(1)
runs a program and traces the malloc/realloc/free calls
localinfo(1)
.TH "localinfo" 1 "Fri Mar 11 2011" "Version 1.12.11" "sofia-sip-utils"
ls(1)
????????????????????????????????????
ls(1)
?????????? ?????? ???????? ????????
ls(1)
list directory contents
ls(1B, 1b)
(BSD) list contents of directory
ls, lc(1)
list contents of directory
ls, lc(1)
list contents of directory
ls, lc(1)
list contents of directory
lsar(1)
list archive file contents
lsattr(1)
list file attributes on a Linux second extended file system
lsdic(1)
lsdic
lsdic(1)
Display the user dictionary list
lsdiff(1)
show which files are modified by a patch
lsdvd(1)
read the content info of a DVD
lshal(1)
list HAL devices
lshell(1)
Limited Shell
lsldap(1)
performs a *big* query on the LDAP directory.
lsort(1)
sort transcripts
lspst(1)
list PST (MS Outlook Personal Folders) file data
lsrc(1)
show dotfiles files managed by rcm
lstopo, hwloc-ls, lstopo-no-graphics(1)
Show the topology of the system
lsvfs(1)
list installed virtual file systems
lsvfs(1)
??????????????????????????????????????????????????
lsvfs(1)
?????????? ???? ???? ?????? ?????? ????????
lsw(1)
list windows
lsz, sz, sx, sb(1)
XMODEM, YMODEM, ZMODEM file send
lt-comp(1)
This application is part of the lexical processing modules and tools ( lttoolbox ) This tool is part of the apertium machine translation architecture: http://www.apertium.org.
lt-expand(1)
This application is part of the lexical processing modules and tools ( lttoolbox ) This tool is part of the apertium machine translation architecture: http://www.apertium.org.
lt-print(1)
This application is part of the lexical processing modules and tools ( lttoolbox ) This tool is part of the apertium machine translation architecture: http://www.apertium.org.
lt-proc(1)
This application is part of the lexical processing modules and tools ( lttoolbox ) This tool is part of the apertium machine translation architecture: http://www.apertium.org.
lt-tmxcomp(1)
This application is part of the lexical processing modules and tools ( lttoolbox ) This tool is part of the apertium machine translation architecture: http://apertium.org.
lt-tmxproc(1)
This application is part of the lexical processing modules and tools ( lttoolbox ) This tool is part of the apertium machine translation architecture: http://apertium.org.
lt-trim(1)
This application is part of the lexical processing modules and tools ( lttoolbox ) This tool is part of the apertium machine translation architecture: http://www.apertium.org.
ltm-mkprotodb(1)
Creates a compiled protocols database file
lttng-disable-channel(1)
Disable LTTng channels
lttng-enable-channel(1)
Create or enable LTTng channels
lttng-list(1)
List LTTng tracing sessions, domains, channels, and events
lttng-version(1)
Get the version of LTTng-tools
luit(1)
Locale and ISO 2022 support for Unicode terminals
lv2ls(1)
list all installed LV2 plugins
magic(1)
VLSI layout editor
mail(1)
manual page for mail (GNU Mailutils)
mailinspect(1)
sort an mbox by category and pipe emails to a command.
mailstat.pl(1)
shows mail-arrival statistics
mailsync(1)
Synchronize IMAP mailboxes
mandoc(1)
format and display UNIX manuals
mandoc, mdocml(1)
format and display UNIX manuals
math(1)
- Perform mathematics calculations Synopsis math [-sN] EXPRESSION Description math is used to perform mathematical calculations. It is a very thin wrapper for the bc program, which makes it possible to specify an expression from the command line without using non-standard extensions or a pipeline. For a description of the syntax supported by math, see the manual for the bc program. Keep in mind that parameter expansion takes place on any expressions before they are evaluated. This can be very useful in order to perform calculations involving shell variables or the output of command substitutions, but it also means that parenthesis have to be escaped. The following options are available: o 2 -sN Sets the scale of the result. N must be an integer and defaults to zero. This simply sets bc's scale variable to the provided value. Note that you cannot put a space between -s and N. Return Values If invalid options or no expression is provided the return status is two. If the expression is invalid the return status is three. If bc returns a result of 0 (literally, not 0.0 or similar variants) the return status is one otherwise it's zero. Examples math 1+1 outputs 2. math $status-128 outputs the numerical exit status of the last command minus 128. math 10 / 6 outputs 1. math -s0 10.0 / 6.0 outputs 1. math -s3 10 / 6 outputs 1.666. Cautions Note that the modulo operator (x % y) is not well defined for floating point arithmetic. The bc command produces a nonsensical result rather than emit an error and fail in that case. It doesn't matter if the arguments are integers; e.g., 10 % 4. You'll still get an incorrect result. Do not use the -sN flag with N greater than zero if you want sensible answers when using the modulo operator.
mb2txt, txt2mb(1)
fcitx table related tools
mcron(1)
a program to run tasks at regular (or not) intervals
mdb-hexdump(1)
- Hexdump utility from MDB Tools
mdb-sql(1)
- SQL interface to MDB Tools
megals(1)
List files stored in the cloud
mergechan(1)
merge channels from several RLE files into a single output stream
mergechan(1)
merge channels from several RLE files into a single output stream
mfsarchive, mfschkarchive, mfsclrarchive, mfssetarchive(1)
MooseFS archive storage mode management tools
mfsdiagtools, mfscheckfile, mfsdirinfo, mfsfileinfo, mfsfilepaths, mfsfilerepair(1)
NooseFS diagnostic tools
mfseattr, mfscopyeattr, mfsdeleattr, mfsgeteattr, mfsseteattr(1)
MooseFS extra attributes management tools
mfsgoal, mfscopygoal, mfsgetgoal, mfsrgetgoal, mfsrsetgoal, mfssetgoal(1)
MooseFS goal management tools
mfsquota, mfscopyquota, mfsdelquota, mfsgetquota, mfssetquota(1)
MooseFS quota management tools
mfssclass, mfscopysclass, mfsgetsclass, mfslistsclass, mfssetsclass, mfsxchgsclass(1)
MooseFS storage classes management tools
mfssnapshots, mfsappendchunks, mfsmakesnapshot, mfsrmsnapshot(1)
MooseFS snapshot tools
mfstools(1)
perform MooseFS-specific operations
mfstrashtime, mfscopytrashtime, mfsgettrashtime, mfsrgettrashtime, mfsrsettrashtime, mfssettrashtime(1)
MooseFS trash time (retention) management tools
mincstats(1)
calculate simple statistics across voxels of a minc file
mingw32-c++filt, c++filt(1)
Demangle C++ and Java symbols.
mingw32-dlltool, dlltool(1)
Create files needed to build and use DLLs.
mingw32-nm, nm(1)
list symbols from object files
mingw32-strip, strip(1)
Discard symbols from object files.
mips-freebsd-c++filt, c++filt(1)
Demangle C++ and Java symbols.
mips-freebsd-dlltool, dlltool(1)
Create files needed to build and use DLLs.
mips-freebsd-nm, nm(1)
list symbols from object files
mips-freebsd-strip, strip(1)
Discard symbols from object files.
mips64-freebsd-c++filt, c++filt(1)
Demangle C++ and Java symbols.
mips64-freebsd-dlltool, dlltool(1)
Create files needed to build and use DLLs.
mips64-freebsd-nm, nm(1)
list symbols from object files
mips64-freebsd-strip, strip(1)
Discard symbols from object files.
mjpegtools(1, MJPEG Linux Square)
mjpegtools
mkill(1)
Kills slow queries
mktexlsr, texhash(1)
create ls-R databases
mkThumbs(1)
script to create thumbnails from an ogg video file
mlmmj-receive(1)
receive mails for an mlmmj managed mailinglist
mls(1)
Display useful statistics on email messages
mmencode, mimencode(1)
Translate to and from mail-oriented encoding formats (Same program also installed as "mimencode".)
mmls(1)
Display the partition layout of a volume system (partition tables)
mmstat(1)
Display details about the volume system (partition tables)
mode2, smode2, xmode2(1)
shows the pulse/space length of infrared signals
mogtool(1)
Inject/extract data to/from a MogileFS installation WARNING: this utility is deprecated! See MogileFS::Utils
moreutils-parallel, parallel(1)
run programs in parallel
moreutils-ts, ts(1)
timestamp input
mp3-archive-tools(1)
tools to maintain an archive of mp3 files
mtools(1, 3)
mtools
mtoolsfm(1)
graphical user interface to the mtools diskette package for UNIX
mtoolstest(1)
mtoolstest
mu(1)
a set of tools to deal with Maildirs and message files, in particular to index and search e-mail messages.
mu-extract, mu(1, EXTRACT)
extract is the mu command to display and save message parts (attachments), and open them with other tools.
muttprint(1)
schoener Ausdruck von Mails mit Mutt
muttprint(1)
pretty printing of mails with Mutt
MyBackground(1, 1x)
details how background is to be rendered
mysqlshow(1)
display database, table, and column information
mysqlslap(1)
load emulation client
ncftpls(1)
Internet file transfer program for scripts
netwox, netwox538(1)
examples/tools of the network library netwib
newsbeuter(1)
an RSS/Atom feed reader for text terminals
nextd(1)
- move forward through directory history Synopsis nextd [ -l | --list ] [POS] Description nextd moves forwards POS positions in the history of visited directories; if the end of the history has been hit, a warning is printed. If the -l or --list flag is specified, the current directory history is also displayed. Note that the cd command limits directory history to the 25 most recently visited directories. The history is stored in the $dirprev and $dirnext variables which this command manipulates. Example cd /usr/src Working directory is now /usr/src cd /usr/src/fish-shell Working directory is now /usr/src/fish-shell prevd Working directory is now /usr/src nextd Working directory is now /usr/src/fish-shell
nm(1)
list symbols from object files
normalize(1)
adjusts volume levels of audio files.
normalize-mp3(1)
adjust levels of mp3 or ogg files by running normalize(1), then re-encoding
npm-ls(1)
List installed packages
nut(1)
analyze meals with the USDA Nutrient Database
nytprofcalls(1)
experimental
ocsptool(1)
GnuTLS OCSP tool
oggThumb(1)
creates thumbnails from an ogg video file
ohai(1)
The man page for the ohai command line tool. Ohai is a tool that is used to detect attributes on a node, and then provide these attributes to the chef-client at the start of every chef-client run. Ohai is required by the chef-client and must be present on a node. (Ohai is installed on a node as part of the chef-client install process.) The types of attributes Ohai collects include (but are not limited to): 0.0 o 2 Platform details o 2 Network usage o 2 Memory usage o 2 Processor usage o 2 Kernel data o 2 Host names o 2 Fully qualified domain names o 2 Other configuration details 0u Attributes that are collected by Ohai are automatic attributes, in that these attributes are used by the chef-client to ensure that these attributes remain unchanged after the chef-client is done configuring the node. ohai is the command-line interface for Ohai, a tool that is used to detect attributes on a node, and then provide these attributes to the chef-client at the start of every chef-client run.
oLschema2ldif(1)
Converts LDAP schema's to LDB-compatible LDIF
omindex-list(1)
List URLs of documents indexed by omindex
open(1)
- open file in its default application Synopsis open FILES... Description open opens a file in its default application, using the appropriate tool for the operating system. On GNU/Linux, this requires the common but optional xdg-open utility, from the xdg-utils package. Note that this function will not be used if a command by this name exists (which is the case on macOS or Haiku). Example open *.txt opens all the text files in the current directory using your system's default text editor.
opentool(1)
Command line tool for starting tools
or(1)
- conditionally execute a command Synopsis COMMAND1; or COMMAND2 Description or is used to execute a command if the current exit status (as set by the previous command) is not 0. or statements may be used as part of the condition in an and or while block. See the documentation for if and while for examples. or does not change the current exit status. The exit status of the last foreground command to exit can always be accessed using the $status variable. Example The following code runs the make command to build a program. If the build succeeds, the program is installed. If either step fails, make clean is run, which removes the files created by the build process. make; and make install; or make clean
p11tool(1)
GnuTLS PKCS #11 tool
pacat, pamon, paplay, parec, parecord(1)
Play back or record raw or encoded audio streams on a PulseAudio sound server
pacmd(1)
Reconfigure a PulseAudio sound server during runtime
pactl(1)
Control a running PulseAudio sound server
padsp(1)
PulseAudio OSS Wrapper
panoinfo(1)
List details about the libpano13 library
pasuspender(1)
Temporarily suspend PulseAudio
patchage(1)
Graphically connect JACK and ALSA Audio/MIDI ports
pax11publish(1)
PulseAudio X11 Credential Utility
PDL::Internals(1)
description of some aspects of the current internals
PDL::Tutorials(1)
A guide to PDL's tutorial documentation.
pen(1)
Load balancer for udp and tcp based protocols
percona-toolkit(1)
Advanced command-line tools for MySQL
perldl(1)
Simple shell for PDL (see also pdl2)
perlfaq3(1)
Programming Tools
perlipc(1)
Perl interprocess communication (signals, fifos, pipes, safe subprocesses, sockets, and semaphores)
perlsec(1)
Perl security
perlsh(1)
one-line perl evaluator with line editing function and variable name completion function
perlsolaris(1)
Perl version 5 on Solaris systems
perlsource(1)
A guide to the Perl source tree
perlstyle(1)
Perl style guide
perlsub(1)
Perl subroutines
perlsymbian(1)
Perl version 5 on Symbian OS
perlsyn(1)
Perl syntax
perlsynology(1)
Perl 5 on Synology DSM systems
pfsextractchannels(1)
Extract selected channels from the stream
phoa2d, phod2a(1)
gcin's Bopomofo tools
pilot-install-datebook(1)
Installs one or more new datebook entries onto your Palm handheld.
pilot-install-memo(1)
Installs a new Memo Pad entry onto your Palm handheld.
pkgdb, pkg_which(1)
tools to manage and search the package database
pldes, pl, pl2link -, plmerge, plparse, plser(1)
property list tools
pm3umpdl(1)
Loads a pls file into mpd, musicpd.
podbeuter(1)
a podcast download manage for text terminals
podview(1)
graphical pod viewer DESCRIPTION The small GUI browser for POD format. Given the argument either as a file path, or perl module name (f.ex. File::Copy), displays the documentation found. SEE ALSO perlpod - the Plain Old Documentation format Prima - perl graphic toolkit the viewer is based on Prima::HelpViewer - menu commands explained
pols(1)
pols
polygraph-pgl2acl(1)
translates PGL access rules into Squid Proxy ACLs
pop3d(1)
manual page for pop3d (GNU Mailutils)
popauth(1)
manual page for popauth (GNU Mailutils)
port(1)
FreeBSD Port Tools front-end script
portsdb, ports_glob(1)
tools to manage and look up the ports database file
portupgrade, portinstall(1)
tools to upgrade installed packages or install new ones via ports or packages
postfix-tls(1)
Postfix TLS management
posttls-finger(1)
Probe the TLS properties of an ESMTP or LMTP server.
powerpc64-freebsd-c++filt, c++filt(1)
Demangle C++ and Java symbols.
powerpc64-freebsd-dlltool, dlltool(1)
Create files needed to build and use DLLs.
powerpc64-freebsd-nm, nm(1)
list symbols from object files
powerpc64-freebsd-strip, strip(1)
Discard symbols from object files.
pppclient(1)
Runs PPP over TLS tunnel
pprof(1)
manual page for pprof (part of gperftools)
pqshell, pqshell-2.7(1)
A shell-like to interact with a Postfix mails queue
prevd(1)
- move backward through directory history Synopsis prevd [ -l | --list ] [POS] Description prevd moves backwards POS positions in the history of visited directories; if the beginning of the history has been hit, a warning is printed. If the -l or --list flag is specified, the current history is also displayed. Note that the cd command limits directory history to the 25 most recently visited directories. The history is stored in the $dirprev and $dirnext variables which this command manipulates. Example cd /usr/src Working directory is now /usr/src cd /usr/src/fish-shell Working directory is now /usr/src/fish-shell prevd Working directory is now /usr/src nextd Working directory is now /usr/src/fish-shell
prima-gencls(1)
prima-gencls
printf(1)
- display text according to a format string Synopsis printf format [argument...] Description printf formats the string FORMAT with ARGUMENT, and displays the result. The string FORMAT should contain format specifiers, each of which are replaced with successive arguments according to the specifier. Specifiers are detailed below, and are taken from the C library function printf(3). Unlike echo, printf does not append a new line unless it is specified as part of the string. Valid format specifiers are: o 2 %d: Argument will be used as decimal integer (signed or unsigned) o 2 %i: Argument will be used as a signed integer o 2 %o: An octal unsigned integer o 2 %u: An unsigned decimal integer o 2 %x or %X: An unsigned hexadecimal integer o 2 %f, %g or %G: A floating-point number o 2 %e or %E: A floating-point number in scientific (XXXeYY) notation o 2 %s: A string o 2 %b: As a string, interpreting backslash escapes, except that octal escapes are of the form \0 or \0ooo. %% signifies a literal '%'. Note that conversion may fail, e.g. '102.234' will not losslessly convert to an integer, causing printf to print an error. printf also knows a number of backslash escapes: o 2 \" double quote o 2 \\ backslash o 2 \a alert (bell) o 2 \b backspace o 2 \c produce no further output o 2 \e escape o 2 \f form feed o 2 \n new line o 2 \r carriage return o 2 \t horizontal tab o 2 \v vertical tab o 2 \ooo octal number (ooo is 1 to 3 digits) o 2 \xhh hexadecimal number (hhh is 1 to 2 digits) o 2 \uhhhh 16-bit Unicode character (hhhh is 4 digits) o 2 \Uhhhhhhhh 32-bit Unicode character (hhhhhhhh is 8 digits) The format argument is re-used as many times as necessary to convert all of the given arguments. If a format specifier is not appropriate for the given argument, an error is printed. For example, `printf 'd' '102.234'` produces an error, as '102.234' cannot be formatted as an integer. This file has been imported from the printf in GNU Coreutils version 6.9. If you would like to use a newer version of printf, for example the one shipped with your OS, try command printf. Example printf '%s\t%s\n' flounder fish Will print 'flounder fish' (separated with a tab character), followed by a newline character. This is useful for writing completions, as fish expects completion scripts to output the option followed by the description, separated with a tab character. printf '%s:%d' 'Number of bananas in my pocket' 42 Will print 'Number of bananas in my pocket: 42', without a newline.
prlst2ps(1)
produce PostScript data from rectangle/line-segment data
procenv(1)
display process environment details
prtunnel(1)
tunnels TCP connections through HTTP or SOCKS5 proxies
psktool(1)
GnuTLS PSK tool
psp-c++filt, c++filt(1)
Demangle C++ and Java symbols.
psp-dlltool, dlltool(1)
Create files needed to build and use DLLs.
psp-nm, nm(1)
list symbols from object files
psp-strip, strip(1)
Discard symbols from object files.
pspresent(1)
fullscreen PostScript presentation tool
psub(1)
- perform process substitution Synopsis COMMAND1 ( COMMAND2 | psub [-f] [-s SUFFIX]) Description Posix shells feature a syntax that is a mix between command substitution and piping, called process substitution. It is used to send the output of a command into the calling command, much like command substitution, but with the difference that the output is not sent through commandline arguments but through a named pipe, with the filename of the named pipe sent as an argument to the calling program. psub combined with a regular command substitution provides the same functionality. If the -f or --file switch is given to psub, psub will use a regular file instead of a named pipe to communicate with the calling process. This will cause psub to be significantly slower when large amounts of data are involved, but has the advantage that the reading process can seek in the stream. If the -s or ---suffix switch is given, psub will append SUFFIX to the filename. Example diff (sort a.txt | psub) (sort b.txt | psub) shows the difference between the sorted versions of files a.txt and b.txt. source-highlight -f esc (cpp main.c | psub -s .c) highlights main.c after preprocessing as a C source.
pt-align(1)
Align output from other tools to columns.
PTinfo(1)
Display information about a panotools-generated image
pulseaudio(1)
The PulseAudio Sound System
pulseview, PulseView(1)
Qt-based LA/scope/MSO GUI for sigrok
purge-old-kernels(1)
remove old kernel and header packages from the system
pushd(1)
- push directory to directory stack Synopsis pushd [DIRECTORY] Description The pushd function adds DIRECTORY to the top of the directory stack and makes it the current working directory. popd will pop it off and return to the original directory. Without arguments, it exchanges the top two directories in the stack. pushd +NUMBER rotates the stack counter-clockwise i.e. from bottom to top pushd -NUMBER rotates clockwise i.e. top to bottom. See also dirs and dirs -c. Example pushd /usr/src Working directory is now /usr/src Directory stack contains /usr/src pushd /usr/src/fish-shell Working directory is now /usr/src/fish-shell Directory stack contains /usr/src /usr/src/fish-shell pushd /tmp/ Working directory is now /tmp Directory stack contains /tmp /usr/src /usr/src/fish-shell pushd +1 Working directory is now /usr/src Directory stack contains /usr/src /usr/src/fish-shell /tmp popd Working directory is now /usr/src/fish-shell Directory stack contains /usr/src/fish-shell /tmp
puttygen(1)
public-key generator for the PuTTY tools
pvf, autopvf, basictopvf, lintopvf, pvfamp, pvfcut, pvfecho, pvffft, pvffile, pvffilter, pvfmix, pvfnoise, pvfreverse, pvfsine, pvfspeed, pvftoau, pvftobasic, pvftolin, pvftormd, pvftovoc, pvftowav, rmdfile, rmdtopvf, voctopvf, wavtopvf(1)
tools - utilities to convert various sound formats 0
pycard-import(1)
import email addresses from mails from stdin
qrls(1, 1B)
release hold on pbs batch jobs
r.fillnulls(1)
r.fillnulls
r.random.cells(1)
r.random.cells
radsecproxy(1)
a generic RADIUS proxy that provides both RADIUS UDP and TCP/TLS (RadSec) transport.
ralabel(1)
inserts fixed form or free form metadata labels into argus(8). ralabel supports a number of strategies for labeling including 1) address based, providing free form metadata, country code, geo data and fully qualified domain name (FQDN) labeling; 2)port based, providing free form labels using IANA port definitions, and 3) flow filter, providing free form labels based on argus filter specicfications.
rast(1)
translate output of sgmls to RAST format
rblsmtpd(1)
blocks mail from RBL-listed sites. It works with any SMTP server that can run under tcpserver (1)
realpath(1)
- Convert a path to an absolute path without symlinks Synopsis realpath path Description This is implemented as a function and a builtin. The function will attempt to use an external realpath command if one can be found. Otherwise it falls back to the builtin. The builtin does not support any options. It's meant to be used only by scripts which need to be portable. The builtin implementation behaves like GNU realpath when invoked without any options (which is the most common use case). In general scripts should not invoke the builtin directly. They should just use realpath. If the path is invalid no translated path will be written to stdout and an error will be reported.
resolve_stack_dump(1)
resolve numeric stack trace dump to symbols
retawq(1)
a multi-threaded web browser for text terminals
return(1)
- stop the current inner function Synopsis function NAME; [COMMANDS...;] return [STATUS]; [COMMANDS...;] end Description return halts a currently running function. The exit status is set to STATUS if it is given. It is usually added inside of a conditional block such as an if statement or a switch statement to conditionally stop the executing function and return to the caller, but it can also be used to specify the exit status of a function. Example The following code is an implementation of the false command as a fish function function false return 1 end
rhythmbox-client(1)
controls a running instance of rhythmbox
riscv64-freebsd-c++filt, c++filt(1)
Demangle C++ and Java symbols.
riscv64-freebsd-dlltool, dlltool(1)
Create files needed to build and use DLLs.
riscv64-freebsd-nm, nm(1)
list symbols from object files
riscv64-freebsd-strip, strip(1)
Discard symbols from object files.
rleprint(1)
Print the values of all the pixels in the file.
rleprint(1)
Print the values of all the pixels in the file.
rleswap(1)
swap the channels in an RLE file.
rleswap(1)
swap the channels in an RLE file.
rmic(1)
Generates stub, skeleton, and tie classes for remote objects that use the Java Remote Method Protocol (JRMP) or Internet Inter-Orb protocol (IIOP). Also generates Object Management Group (OMG) Interface Definition Language (IDL)
rods(1, l)
Raster3D preprocessor for ball-and-stick models
roll(1)
Command line interface for dice rolls
s3qlstat(1)
Gather S3QL file system statistics
s_client(1)
SSL/TLS client program
s_client(1)
SSL/TLS client program
s_server(1)
SSL/TLS server program
s_server(1)
SSL/TLS server program
s_time(1)
SSL/TLS performance timing program
s_time(1)
SSL/TLS performance timing program
samesame(1)
introduction to the samesame tools
samtools(1)
Utilities for the Sequence Alignment/Map (SAM) format
sc-mkf77sym(1)
The sc-mkf77sym program is used to generate symbols for linking FORTRAN subroutines into MPQC.
schismtracker(1)
tracked music editor based on Impulse Tracker
scls(1)
The scls program is used to list objects in checkpoint files.
scriptmgr3, scriptmgr(1)
utility for controlling other skytools scripts.
serialsmtp(1)
blast files across SMTP
sess_id(1)
SSL/TLS session handling utility
sess_id(1)
SSL/TLS session handling utility
set_color(1)
- set the terminal color Synopsis set_color [OPTIONS] VALUE Description set_color is used to control the color and styling of text in the terminal. VALUE corresponds to a reserved color name such as red or a RGB color value given as 3 or 6 hexadecimal digits. The br-, as in 'bright', forms are full-brightness variants of the 8 standard-brightness colors on many terminals. brblack has higher brightness than black - towards gray. A special keyword normal resets text formatting to terminal defaults. Valid colors include: o 2 black, red, green, yellow, blue, magenta, cyan, white o 2 brblack, brred, brgreen, bryellow, brblue, brmagenta, brcyan, brwhite An RGB value with three or six hex digits, such as A0FF33 or f2f can be used. fish will choose the closest supported color. A three digit value is equivalent to specifying each digit twice; e.g., set_color 2BC is the same as set_color 22BBCC. Hexadecimal RGB values can be in lower or uppercase. Depending on the capabilities of your terminal (and the level of support set_color has for it) the actual color may be approximated by a nearby matching reserved color name or set_color may not have an effect on color. A second color may be given as a desired fallback color. e.g. set_color 124212 brblue will instruct set_color to use brblue if a terminal is not capable of the exact shade of grey desired. This is very useful when an 8 or 16 color terminal might otherwise not use a color. The following options are available: o 2 -b, --background COLOR sets the background color. o 2 -c, --print-colors prints a list of the 16 named colors. o 2 -o, --bold sets bold mode. o 2 -d, --dim sets dim mode. o 2 -i, --italics sets italics mode. o 2 -r, --reverse sets reverse mode. o 2 -u, --underline sets underlined mode. Using the normal keyword will reset foreground, background, and all formatting back to default. Notes 1. 4 Using the normal keyword will reset both background and foreground colors to whatever is the default for the terminal. 2. 4 Setting the background color only affects subsequently written characters. Fish provides no way to set the background color for the entire terminal window. Configuring the window background color (and other attributes such as its opacity) has to be done using whatever mechanisms the terminal provides. 3. 4 Some terminals use the --bold escape sequence to switch to a brighter color set rather than increasing the weight of text. 4. 4 set_color works by printing sequences of characters to stdout. If used in command substitution or a pipe, these characters will also be captured. This may or may not be desirable. Checking the exit code of isatty stdout before using set_color can be useful to decide not to colorize output in a script. Examples set_color red; echo 'Roses are red' set_color blue; echo 'Violets are blue' set_color 62A; echo 'Eggplants are dark purple' set_color normal; echo 'Normal is nice' # Resets the background too Terminal Capability Detection Fish uses a heuristic to decide if a terminal supports the 256-color palette as opposed to the more limited 16 color palette of older terminals. Support can be forced on by setting fish_term256 to 1. If $TERM contains '256color' (e.g., xterm-256color), 256-color support is enabled. If $TERM contains xterm, 256 color support is enabled (except for MacOS: $TERM_PROGRAM and $TERM_PROGRAM_VERSION are used to detect Terminal.app from MacOS 10.6; support is disabled here it because it is known that it reports xterm and only supports 16 colors. If terminfo reports 256 color support for a terminal, support will always be enabled. To debug color palette problems, tput colors may be useful to see the number of colors in terminfo for a terminal. Fish launched as fish -d2 will include diagnostic messages that indicate the color support mode in use. Many terminals support 24-bit (i.e., true-color) color escape sequences. This includes modern xterm, Gnome Terminal, Konsole, and iTerm2. Fish attempts to detect such terminals through various means in config.fish You can explicitly force that support via set fish_term24bit 1. The set_color command uses the terminfo database to look up how to change terminal colors on whatever terminal is in use. Some systems have old and incomplete terminfo databases, and may lack color information for terminals that support it. Fish will assume that all terminals can use the ANSI X3.64 escape sequences if the terminfo definition indicates a color below 16 is not supported. Support for italics, dim, reverse, and other modes is not guaranteed in all terminal emulators. Fish attempts to determine if the terminal supports these modes even if the terminfo database may not be up-to-date.
sgmlpre(1)
handle SGML conditionalization for SGML-tools
sgmls(1)
a validating SGML parser An SGML System Conforming to International Standard ISO 8879 -- Standard Generalized Markup Language
sgmlsasp(1)
translate output of sgmls using ASP replacement files
sharesec(1)
Set or get share ACLs
shellsnoop(1, 1m)
snoop live shell activity. Uses DTrace.
shtool-tarball, shtool(1)
tarball - GNU shtool command for rolling standardized tarballs
siege2csv, bombardment(1)
Run siege with an ever-increasing number of users SYNOPSIS bombardment [urlfile] [clients] [increment] [trials] [delay] bombardment urls.txt 5 10 20 1
sieve-filter(1)
Pigeonhole's Sieve mailbox filter tool WARNING: This tool is still experimental. Read this manual carefully, and backup any important mail before using this tool. Also note that some of the features documented here are not actually implemented yet; this is clearly indicated where applicable.
sip-date(1)
.TH "sip-date" 1 "Fri Mar 11 2011" "Version 1.12.11" "sofia-sip-utils"
sip-dig(1)
.TH "sip-dig" 1 "Fri Mar 11 2011" "Version 1.12.11" "sofia-sip-utils"
sip-options(1)
.TH "sip-options" 1 "Fri Mar 11 2011" "Version 1.12.11" "sofia-sip-utils"
skytools_upgrade3, skytools_upgrade(1)
utility for upgrading Skytools code in databases.
sls(1)
list information about file(s) and directories
slsh(1)
Interpreter for S-Lang scripts
smbcacls(1)
Set or get ACLs on an NT file or directory names
snmpcmd(1)
options and behaviour common to most of the Net-SNMP command-line tools
SOAPsh.pl(1)
Interactive shell for SOAP calls
soldumper(1)
Gnash Local Shared Object (LSO) File Dumper
source(1)
- evaluate contents of file. Synopsis source FILENAME [ARGUMENTS...] Description source evaluates the commands of the specified file in the current shell. This is different from starting a new process to perform the commands (i.e. fish < FILENAME) since the commands will be evaluated by the current shell, which means that changes in shell variables will affect the current shell. If additional arguments are specified after the file name, they will be inserted into the $argv variable. The $argv variable will not include the name of the sourced file. If no file is specified, or if the file name '-' is used, stdin will be read. The return status of source is the return status of the last job to execute. If something goes wrong while opening or reading the file, source exits with a non-zero status. . (a single period) is an alias for the source command. The use of . is deprecated in favour of source, and . will be removed in a future version of fish. Example source ~/.config/fish/config.fish Causes fish to re-read its initialization file. Caveats In fish versions prior to 2.3.0 the $argv variable would have a single element (the name of the sourced file) if no arguments are present. Otherwise it would contain arguments without the name of the sourced file. That behavior was very confusing and unlike other shells such as bash and zsh.
spamass-milter(1, 8)
sendmail milter for passing emails through SpamAssassin
sparc64-freebsd-c++filt, c++filt(1)
Demangle C++ and Java symbols.
sparc64-freebsd-dlltool, dlltool(1)
Create files needed to build and use DLLs.
sparc64-freebsd-nm, nm(1)
list symbols from object files
sparc64-freebsd-strip, strip(1)
Discard symbols from object files.
speaker-test(1)
command-line speaker test tone generator for ALSA
sqlsharp(1)
Mono SQL Query command-line tool
srptool(1)
GnuTLS SRP tool
sslscan(1)
Fast SSL/TLS scanner
sslsplit(1)
transparent SSL/TLS interception
sslswamp, swamp(1)
SSL/TLS load-tester based on OpenSSL
start-pulseaudio-x11(1)
PulseAudio Sound Server X11 Startup Script
status(1)
- query fish runtime information Synopsis status status is-login status is-interactive status is-block status is-command-substitution status is-no-job-control status is-full-job-control status is-interactive-job-control status current-filename status current-line-number status print-stack-trace status job-control CONTROL-TYPE Description With no arguments, status displays a summary of the current login and job control status of the shell. The following operations (sub-commands) are available: o 2 is-command-sub returns 0 if fish is currently executing a command substitution. Also -c or --is-command-substitution. o 2 is-block returns 0 if fish is currently executing a block of code. Also -b or --is-block. o 2 is-interactive returns 0 if fish is interactive - that is, connected to a keyboard. Also -i or --is-interactive. o 2 is-login returns 0 if fish is a login shell - that is, if fish should perform login tasks such as setting up the PATH. Also -l or --is-login. o 2 is-full-job-control returns 0 if full job control is enabled. Also --is-full-job-control (no short flag). o 2 is-interactive-job-control returns 0 if interactive job control is enabled. Also, --is-interactive-job-control (no short flag). o 2 is-no-job-control returns 0 if no job control is enabled. Also --is-no-job-control (no short flag). o 2 current-filename prints the filename of the currently running script. Also -f or --current-filename. o 2 current-line-number prints the line number of the currently running script. Also -n or --current-line-number. o 2 job-control CONTROL-TYPE sets the job control type, which can be none, full, or interactive. Also -j CONTROL-TYPE or --job-control=CONTROL-TYPE. o 2 print-stack-trace prints a stack trace of all function calls on the call stack. Also -t or --print-stack-trace. Notes For backwards compatibility each subcommand can also be specified as a long or short option. For example, rather than status is-login you can type status --is-login. The flag forms are deprecated and may be removed in a future release (but not before fish 3.0). You can only specify one subcommand per invocation even if you use the flag form of the subcommand.
strip(1)
Discard symbols from object files.
stunc(1)
.TH "stunc" 1 "Fri Mar 11 2011" "Version 1.12.11" "sofia-sip-utils"
svg_validate(1)
This script scans a directory full of *.svg files and checks them to see if they have proper metadata. If so, it copies them into a target directory and creates a png of it. It also creates a list of PASS and FAIL for the different criteria.
sw2asc(1)
converts a SWITCAP2 output file into ASCII data files that other tools can read
switch(1)
- conditionally execute a block of commands Synopsis switch VALUE; [case [WILDCARD...]; [COMMANDS...]; ...] end Description switch performs one of several blocks of commands, depending on whether a specified value equals one of several wildcarded values. case is used together with the switch statement in order to determine which block should be executed. Each case command is given one or more parameters. The first case command with a parameter that matches the string specified in the switch command will be evaluated. case parameters may contain wildcards. These need to be escaped or quoted in order to avoid regular wildcard expansion using filenames. Note that fish does not fall through on case statements. Only the first matching case is executed. Note that command substitutions in a case statement will be evaluated even if its body is not taken. All substitutions, including command substitutions, must be performed before the value can be compared against the parameter. Example If the variable $animal contains the name of an animal, the following code would attempt to classify it: switch $animal case cat echo evil case wolf dog human moose dolphin whale echo mammal case duck goose albatross echo bird case shark trout stingray echo fish case '*' echo I have no idea what a $animal is end If the above code was run with $animal set to whale, the output would be mammal.
sxacl-volshow(1)
list an access control list for a volume
sxls(1)
list available volumes and their contents
t3d(1)
clock using flying balls to display the time
talkfilters, b1ff, brooklyn, chef, cockney, drawl, fudd, funetak, jethro, jive, kraut, pansy, pirate, postmodern, redneck, valspeak, warez(1, 6)
GNU talk filters
tape2pulses(1)
Sinclair ZX Spectrum tape pulse dumper
tdadmin(1)
a command line utility to edit devices and controllers for Telldus TellStick
tdtool(1)
a command line utility to send commands to a Telldus TellStick
telldusd(1)
background service for Telldus TellStick, must be running to control TellStick
terminator, Terminator(1)
Multiple GNOME terminals in one window
tgif(1, 1L)
Xlib based interactive 2-D drawing facility under X11. Supports hierarchical construction of drawings and easy navigation between sets of drawings. It's also a hyper-graphics (or hyper-structured-graphics) browser on the World-Wide-Web.
tlsdate(1)
secure parasitic rdate replacement
tlsdate-helper(1)
secure parasitic rdate replacement
tlsme(1)
TLS/SSL proxy
torrus_acledit, acledit(1)
Manage Torrus access control lists (ACLs).
tpage, Template::Tools::tpage(1)
Process templates from command line
tpic2pdftex(1)
convert tpic \specials for use by pdftex
tpmtool(1)
GnuTLS TPM tool
tragesym(1)
create gEDA symbols from structured textfiles
transmission-edit(1)
command-line utility to modify .torrent files' announce URLs
trap(1)
- perform an action when the shell receives a signal Synopsis trap [OPTIONS] [[ARG] SIGSPEC ... ] Description trap is a wrapper around the fish event delivery framework. It exists for backwards compatibility with POSIX shells. For other uses, it is recommended to define an event handler. The following parameters are available: o 2 ARG is the command to be executed on signal delivery. o 2 SIGSPEC is the name of the signal to trap. o 2 -l or --list-signals prints a list of signal names. o 2 -p or --print prints all defined signal handlers. If ARG and SIGSPEC are both specified, ARG is the command to be executed when the signal specified by SIGSPEC is delivered. If ARG is absent (and there is a single SIGSPEC) or -, each specified signal is reset to its original disposition (the value it had upon entrance to the shell). If ARG is the null string the signal specified by each SIGSPEC is ignored by the shell and by the commands it invokes. If ARG is not present and -p has been supplied, then the trap commands associated with each SIGSPEC are displayed. If no arguments are supplied or if only -p is given, trap prints the list of commands associated with each signal. Signal names are case insensitive and the SIG prefix is optional. The return status is 1 if any SIGSPEC is invalid; otherwise trap returns 0. Example trap 'status --print-stack-trace' SIGUSR1 Prints a stack trace each time the SIGUSR1 signal is sent to the shell.
traptoemail(1)
snmptrapd handler script to convert snmp traps into emails
true, false(1)
provide truth values
truss(1)
trace system calls
tsa2d32, tsd2a, tsd2a32, tsin2gtab-phrase(1)
gcin's Tsin tools
ttree, Template::Tools::ttree(1)
Process entire directory trees of templates
tttrace(1, user cmd)
trace ToolTalk calls and messages
turnutils(1)
turnutils
turnutils_natdiscovery(1)
turnutils_natdiscovery
turnutils_oauth(1)
turnutils_oauth
turnutils_peer(1)
turnutils_peer
turnutils_stunclient(1)
turnutils_stunclient
turnutils_uclient(1)
turnutils_uclient
tv_count(1)
Count (and print) the number of channels and programmes in an XMLTV file.
tv_grep(1)
Filter programmes and channels from an XMLTV listings file.
tz_convert(1)
Timezone converter from operating system tz format into libical format used by Orage and several other calander tools.
ufdb_analyse_urls(1)
retrieve a list of URLs from the log files
ufdb_analyse_users(1)
retrieve a list of URLs from the log files
ufdb_top_urls(1)
retrieve the most frequently used URLs from the log files
ulimit(1)
- set or get resource usage limits Synopsis ulimit [OPTIONS] [LIMIT] Description ulimit builtin sets or outputs the resource usage limits of the shell and any processes spawned by it. If a new limit value is omitted, the current value of the limit of the resource is printed; otherwise, the specified limit is set to the new value. Use one of the following switches to specify which resource limit to set or report: o 2 -c or --core-size: the maximum size of core files created. By setting this limit to zero, core dumps can be disabled. o 2 -d or --data-size: the maximum size of a process' data segment. o 2 -f or --file-size: the maximum size of files created by the shell. o 2 -l or --lock-size: the maximum size that may be locked into memory. o 2 -m or --resident-set-size: the maximum resident set size. o 2 -n or --file-descriptor-count: the maximum number of open file descriptors (most systems do not allow this value to be set). o 2 -s or --stack-size: the maximum stack size. o 2 -t or --cpu-time: the maximum amount of CPU time in seconds. o 2 -u or --process-count: the maximum number of processes available to a single user. o 2 -v or --virtual-memory-size The maximum amount of virtual memory available to the shell. Note that not all these limits are available in all operating systems. The value of limit can be a number in the unit specified for the resource or one of the special values hard, soft, or unlimited, which stand for the current hard limit, the current soft limit, and no limit, respectively. If limit is given, it is the new value of the specified resource. If no option is given, then -f is assumed. Values are in kilobytes, except for -t, which is in seconds and -n and -u, which are unscaled values. The return status is 0 unless an invalid option or argument is supplied, or an error occurs while setting a new limit. ulimit also accepts the following switches that determine what type of limit to set: o 2 -H or --hard sets hard resource limit o 2 -S or --soft sets soft resource limit A hard limit can only be decreased. Once it is set it cannot be increased; a soft limit may be increased up to the value of the hard limit. If neither -H nor -S is specified, both the soft and hard limits are updated when assigning a new limit value, and the soft limit is used when reporting the current value. The following additional options are also understood by ulimit: o 2 -a or --all prints all current limits The fish implementation of ulimit should behave identically to the implementation in bash, except for these differences: o 2 Fish ulimit supports GNU-style long options for all switches o 2 Fish ulimit does not support the -p option for getting the pipe size. The bash implementation consists of a compile-time check that empirically guesses this number by writing to a pipe and waiting for SIGPIPE. Fish does not do this because it this method of determining pipe size is unreliable. Depending on bash version, there may also be further additional limits to set in bash that do not exist in fish. o 2 Fish ulimit does not support getting or setting multiple limits in one command, except reporting all values using the -a switch Example ulimit -Hs 64 sets the hard stack size limit to 64 kB.
umask(1)
- set or get the file creation mode mask Synopsis umask [OPTIONS] [MASK] Description umask displays and manipulates the 'umask', or file creation mode mask, which is used to restrict the default access to files. The umask may be expressed either as an octal number, which represents the rights that will be removed by default, or symbolically, which represents the only rights that will be granted by default. Access rights are explained in the manual page for the chmod(1) program. With no parameters, the current file creation mode mask is printed as an octal number. o 2 -h or --help prints this message. o 2 -S or --symbolic prints the umask in symbolic form instead of octal form. o 2 -p or --as-command outputs the umask in a form that may be reused as input If a numeric mask is specified as a parameter, the current shell's umask will be set to that value, and the rights specified by that mask will be removed from new files and directories by default. If a symbolic mask is specified, the desired permission bits, and not the inverse, should be specified. A symbolic mask is a comma separated list of rights. Each right consists of three parts: o 2 The first part specifies to whom this set of right applies, and can be one of u, g, o or a, where u specifies the user who owns the file, g specifies the group owner of the file, o specific other users rights and a specifies all three should be changed. o 2 The second part of a right specifies the mode, and can be one of =, + or -, where = specifies that the rights should be set to the new value, + specifies that the specified right should be added to those previously specified and - specifies that the specified rights should be removed from those previously specified. o 2 The third part of a right specifies what rights should be changed and can be any combination of r, w and x, representing read, write and execute rights. If the first and second parts are skipped, they are assumed to be a and =, respectively. As an example, r,u+w means all users should have read access and the file owner should also have write access. Note that symbolic masks currently do not work as intended. Example umask 177 or umask u=rw sets the file creation mask to read and write for the owner and no permissions at all for any other users.
unicorn_rails(1)
unicorn launcher for Rails 1.x and 2.x users
unifdef, unifdefall(1)
remove preprocessor conditionals from code
unshield(1)
extract CAB files from an InstallShield installer archive
usb-devices(1)
print USB device details
usbhidaction(1)
perform actions according to USB HID controls
valgrind(1)
a suite of tools for debugging and profiling programs
vcftools(1, man)
v0.1.13 - Utilities for the variant call format (VCF) and binary variant call format (BCF)
vifm-convert-dircolors(1)
converts ls colorscheme to vifm colorscheme
vipsthumbnail(1)
make thumbnails of image files
vos_endtrans(1)
Ends a volserver transaction
w3mman(1)
an interface to the on-line reference manuals via w3m(1)
w3mman(1)
an interface to the on-line reference manuals via w3m(1)
while(1)
- perform a command multiple times Synopsis while CONDITION; COMMANDS...; end Description while repeatedly executes CONDITION, and if the exit status is 0, then executes COMMANDS. If the exit status of CONDITION is non-zero on the first iteration, COMMANDS will not be executed at all. You can use and or or for complex conditions. Even more complex control can be achieved with while true containing a break. Example while test -f foo.txt; or test -f bar.txt ; echo file exists; sleep 10; end outputs 'file exists' at 10 second intervals as long as the file foo.txt or bar.txt exists.
whirlpoolsum(1)
Print or check WHIRLPOOL checksums
wmlsc(1)
WMLScript compiler
wmlsdasm(1)
WMLScript disassembler
wxglade(1)
python program to build user interfaces based on the wxWidgets toolset.
x86_64-freebsd-c++filt, c++filt(1)
Demangle C++ and Java symbols.
x86_64-freebsd-dlltool, dlltool(1)
Create files needed to build and use DLLs.
x86_64-freebsd-nm, nm(1)
list symbols from object files
x86_64-freebsd-strip, strip(1)
Discard symbols from object files.
x86_64-unknown-cloudabi-c++filt, c++filt(1)
Demangle C++ and Java symbols.
x86_64-unknown-cloudabi-strip, strip(1)
Discard symbols from object files.
xbelld(1)
replace X11 terminal bells with different sounds
xca(1)
X Certificate and key management A GUI for handling X509 certificates, RSA/DSA/EC keys, PKCS#10 Requests and CRLs in Software and on Smartcards.
xenstore-ls(1)
list Xenstore keys and values
xfce4-mixer(1)
adjust volume levels
xlhtml(1)
A program for converting Microsoft Excel Files .xls
xls2csv(1)
reads MS-Excel file and puts its content as comma-separated data on standard output
xlsatoms(1)
list interned atoms defined on server
xlsclients(1)
list client applications running on a display
xlsfonts(1)
server font list displayer for X
xmlsec1(1)
sign, verify, encrypt and decrypt XML documents
xmlsec1-config(1)
detail installed version of xmlsec library
xmlstarlet(1)
command line XML/XSLT toolkit
xmode2, mode2, smode2(1)
shows the pulse/space length of infrared signals
xotclsh(1)
Simple shell containing NSF/XOTcl2 interpreter
xplsprinters(1)
shows a list of Xprint printers and it's attributes
xvidcap, XVidCap(1)
Nimmt Bereiche der X11 Anzeige als Video auf
yang2dsdl(1)
translates YANG data models to DSDL schemas and validates instance documents.
yarn(1)
scenario testing of Unix command line tools
yodlstriproff(1)
strip ASCII control characters
yuvmedianfilter(1)
A filter for yuv images produced by the mjpeg tools
zipdetails(1)
display the internal structure of zip files
zpak(1)
create pak files with gzipped internals
zpu-elf-c++filt, c++filt(1)
Demangle C++ and Java symbols.
zpu-elf-dlltool, dlltool(1)
Create files needed to build and use DLLs.
zpu-elf-nm, nm(1)
list symbols from object files
zpu-elf-strip, strip(1)
Discard symbols from object files.
zshcalsys(1)
zsh calendar system
cap_enter, cap_getmode(2)
Capability mode system calls
cap_fcntls_limit, cap_fcntls_get(2)
manage allowed fcntl commands
cap_ioctls_limit, cap_ioctls_get(2)
manage allowed ioctl commands
extattr_get_fd, extattr_delete_fd, extattr_delete_file, extattr_delete_link, extattr_get_file, extattr_get_link, extattr_list_fd, extattr_list_file, extattr_list_link, extattr_set_fd, extattr_set_file, extattr_set_link, extattr(2)
system calls to manipulate VFS extended attributes
intro, errno(2)
introduction to system calls and error numbers
jail, jail_attach, jail_get, jail_remove, jail_set(2)
create and manage system jails
lseek(2)
reposition read/write file offset
lseek(2)
?????? / ??????????????????????????????????????
lseek(2)
???? / ???? ???? ??????(offset) ?????? ????????
ntp_adjtime, ntp_gettime(2)
Network Time Protocol (NTP) daemon interface system calls
pdfork, pdgetpid, pdkill, pdwait4(2)
System calls to manage process descriptors
sigpause, sighold, sigignore, sigrelse, sigset, xsi_sigpause(2)
legacy interface for signal management
sigpending(2)
get pending signals
sigsuspend(2)
atomically release blocked signals and wait for interrupt
sigtimedwait, sigwaitinfo(2)
wait for queued signals (REALTIME)
sigwait(2)
select a set of signals
stat, fstat, fstatat, lstat(2)
get file status
stat, fstat, lstat(2)
????????????????????????
aa_imgheight(3)
returns height of the emulated image in pixels.
aa_imgwidth(3)
returns width of the emulated image in pixels.
Ace::Model(3)
Get information about AceDB models
Acme::ButFirst(3)
Do something, but first do something else.
afInitSampleFormat, afInitByteOrder, afInitChannels, afInitRate(3)
initialize audio data format for a track in an audio file setup
afOpenFile(3)
open an audio file and create a file handle structure used for subsequent calls to the Audio File Library
afSetVirtualByteOrder, afSetVirtualChannels, afSetVirtualPCMMapping, afSetVirtualSampleFormat(3)
set the virtual data format for a track in an audio file
AI::Genetic::Individual(3)
Base class for AI::Genetic Individuals.
al_get_audio_stream_channels(3)
Allegro 5 API
al_get_mixer_channels(3)
Allegro 5 API
al_get_sample_channels(3)
Allegro 5 API
al_get_sample_instance_channels(3)
Allegro 5 API
al_get_voice_channels(3)
Allegro 5 API
Algorithm::Evolutionary::Op::Creator(3)
Operator that generates groups of individuals, of the intended class
Algorithm::Evolutionary::Op::Replace_Different(3)
Incorporate individuals into the population replacing the worst ones but only if they are different.
Algorithm::Evolutionary::Op::Replace_Worst(3)
Incorporate individuals into the population replacing the worst ones
Algorithm::Evolutionary::Op::Tournament_Selection(3)
Tournament selector, takes individuals from one population and puts them into another
Algorithm::Evolutionary::Utils(3)
Container module with a hodgepodge of functions
Algorithm::Interval2Prefix(3)
Generate prefixes from intervals
AllPlanes, BlackPixel, ConnectionNumber, DefaultColormap, DefaultDepth, DefaultGC, DefaultRootWindow, DefaultScreen, DefaultScreenOfDisplay, DefaultVisual, DisplayCells, DisplayPlanes, DisplayString, LastKnownRequestProcessed, NextRequest, ProtocolRevision, ProtocolVersion, QLength, RootWindow, ScreenCount, ScreenOfDisplay, ServerVendor, VendorRelease, WhitePixel, XExtendedMaxRequestSize, XListDepths, XMaxRequestSize(3)
Display macros and functions
Alzabo::FAQ(3)
Frequently Asked Questions How can I generate the SQL to turn one schema into another? Assuming you have schema objects representing these already created (through reverse engineering for example) and both schemas are for the same RDBMS, you can simply do this: CW my @sql = $schema1->rules->schema_diff( old => $schema1, new => $schema2 ); R The @sql array will contain all the SQL statements necessary to transform the schema in $schema1 into the schema in $schema2. If you want to sync a schema object to the current state of the RDBMS backend's schema, check out the "Alzabo::Create::Schema->sync_backend" method. How can I make a local copy of the documentation as HTML? Alzabo comes with a script called "make_html_docs.pl". It takes three arguments. The first is the source file directory root. The second is the target directory. The last is the absolute URL path that this target directory represents. If you have perl 5.6.0 or greated installed, it is recommended that you use it to run this script as the Pod::Html module included with more recent Perls does a much better job of making HTML. If you were in the root of the source directory you might run this as: CW perl ./make_html_docs.pl ./lib /usr/local/apache/htdocs/Alzabo_docs /Alzabo_docs R The script will create an index.html file as well as turning the documentation into HTML. How can I optimize memory usage under mod_perl? You should simply preload the Alzabo::Runtime module (which loads all the other modules it needs). In addition, if you are using Alzabo::MethodMaker, make sure it runs in the parent. This module can create a lot of methods on the fly and each method eats up some memory. Finally, you can preload one or more schema objects. The easiest way to do this is to simply pass its name to Alzabo::Runtime when you use it, like this: CW use Alzabo::Runtime qw( schema1 schema2 ); R How can I get objects for tables linked via the Mason GUI? 4 For example, if I have a websites2categories table which maps a list of categories that a given web site should display -- and uses website_id and category_id in a 1..n relationship -- what is the proper way to set that up in the GUI and then in my code? In the GUI, you can simply create a relationship from websites to categories, and declare it n..n. Alzabo will automatically create a table called websites_categories, and you're free to change the name to whatever you want. Then if you use "Alzabo::MethodMaker", Alzabo will see that you have a table with 2 cols, both of which are part of the PK, and that it has 1..n relationships with 2 other tables, and it will create the appropriate methods. You can see what methods are being created by setting the "ALZABO_DEBUG" environment variable to "METHODMAKER" before loading Alzabo::MethodMaker. It'll spit everything out to STDERR. There's also the generated documentation, which is available via the "docs_as_pod()" schema method after MethodMaker does its thing.
Alzabo::Utils, Alzabo::SQLMaker(3)
Utility functions for other Alzabo modules
AnyEvent::FAQ(3)
frequently asked questions The newest version of this document can be found at <http://pod.tst.eu/http://cvs.schmorp.de/AnyEvent/lib/AnyEvent/FAQ.pod>. My program exits before doing anything, what's going on? Programmers new to event-based programming often forget that you can actually do other stuff while "waiting" for an event to occur and therefore forget to actually wait when they do not, in fact, have anything else to do. Here is an example: CW use AnyEvent; my $timer = AnyEvent->timer (after => 5, cb => sub { say "hi" }); R The expectation might be for the program to print "hi" after 5 seconds and then probably to exit. However, if you run this, your program will exit almost instantly: Creating the timer does not wait for it, instead the "timer" method returns immediately and perl executes the rest of the program. But there is nothing left to execute, so perl exits. To force AnyEvent to wait for something, use a condvar: CW use AnyEvent; my $quit_program = AnyEvent->condvar; my $timer = AnyEvent->timer (after => 5, cb => sub { $quit_program->send }); $quit_program->recv; R Here the program doesn't immediately exit, because it first waits for the "quit_program" condition. In most cases, your main program should call the event library "loop" function directly: CW use EV; use AnyEvent; ... EV::loop; R Why is my "tcp_connect" callback never called? Tricky: "tcp_connect" (and a few other functions in AnyEvent::Socket) is critically sensitive to the caller context. In void context, it will just do its thing and eventually call the callback. In any other context, however, it will return a special "guard" object - when it is destroyed (e.g. when you don't store it but throw it away), tcp_connect will no longer try to connect or call any callbacks. Often this happens when the "tcp_connect" call is at the end of a function: CW sub do_connect { tcp_connect "www.example.com", 80, sub { ... lengthy code }; } R Then the caller decides whether there is a void context or not. One can avoid these cases by explicitly returning nothing: CW sub do_connect { tcp_connect "www.example.com", 80, sub { ... lengthy code }; () # return nothing } R Why do some backends use a lot of CPU in "AE::cv->recv"? Many people try out this simple program, or its equivalent: CW use AnyEvent; AnyEvent->condvar->recv; R They are then shocked to see that this basically idles with the Perl backend, but uses 100% CPU with the EV backend, which is supposed to be sooo efficient. The key to understand this is to understand that the above program is actually buggy: Nothing calls "->send" on the condvar, ever. Worse, there are no event watchers whatsoever. Basically, it creates a deadlock: there is no way to make progress, this program doesn't do anything useful, and this will not change in the future: it is already an ex-parrot. Some backends react to this by freezing, some by idling, and some do a 100% CPU loop. Since this program is not useful (and behaves as documented with all backends, as AnyEvent makes no CPU time guarantees), this shouldn't be a big deal: as soon as your program actually implements something, the CPU usage will be normal. Why does this FAQ not deal with AnyEvent::Handle questions? Because AnyEvent::Handle has a NONFAQ on its own that already deals with common issues. How can I combine Win32::GUI applications with AnyEvent? Well, not in the same OS thread, that's for sure :) What you can do is create another ithread (or fork) and run AnyEvent inside that thread, or better yet, run all your GUI code in a second ithread. For example, you could load Win32::GUI and AnyEvent::Util, then create a portable socketpair for GUI->AnyEvent communication. Then fork/create a new ithread, in there, create a Window and send the "$WINDOW->{-Handle}" to the AnyEvent ithread so it can "PostMessage". GUI to AnyEvent communication could work by pushing some data into a Thread::Queue and writing a byte into the socket. The AnyEvent watcher on the other side will then look at the queue. AnyEvent to GUI communications can also use a Thread::Queue, but to wake up the GUI thread, it would instead use "Win32::GUI::PostMessage $WINDOW, 1030, 0, """, and the GUI thread would listen for these messages by using "$WINDOW->Hook (1030 (), sub { ... })". My callback dies and... It must not - part of the contract betwene AnyEvent and user code is that callbacks do not throw exceptions (and don't do even more evil things, such as using "last" outside a loop :). If your callback might die sometimes, you need to use "eval". If you want to track down such a case and you can reproduce it, you can enable wrapping (by calling "AnyEvent::Debug::wrap" or by setting "PERL_ANYEVENT_DEBUG_WRAP=1" before starting your program). This will wrap every callback into an eval and will report any exception complete with a backtrace and some information about which watcher died, where it was created and so on.
AnyEvent::Filesys::Notify::Role::Fallback(3)
Fallback method of file watching (check in regular intervals)
AnyEvent::Socket(3)
useful IPv4 and IPv6 stuff. also unix domain sockets. and stuff.
AnyEvent::TLS(3)
SSLv2/SSLv3/TLSv1 contexts for use in AnyEvent::Handle
AnyEvent::XMPP::Error::MUC(3)
MUC error Subclass of AnyEvent::XMPP::Error METHODS type 4 This method returns either: 4 join_timeout 4 If the joining of the room took too long. no_config_form 4 If the room we requested the configuration from didn't provide a data form. subject_change_forbidden 4 If changing the subject of a room is not allowed. message_error 4 If this is an unidentified message error. 4 If we got a presence error the method "presence_error" returns a AnyEvent::XMPP::Error::Presence object with further details. However, this class tries to provide a mapping for you (the developer) to ease the load of figuring out which error means what. To make identification of the errors with XEP-0045 more clear I included the error codes and condition names. Here are the more descriptive types: password_required 4 Entering a room Inform user that a password is required. (Condition: not-authorized, Code: 401) banned 4 Entering a room Inform user that he or she is banned from the room (Condition: forbidden, Code: 403) room_locked 4 Entering a room Inform user that the room does not exist and someone is currently creating it. (Condition: item-not-found, Code: 404) room_not_creatable 4 Entering a room Inform user that room creation is restricted (Condition: not-allowed, Code: 405) use_reserved_nick 4 Entering a room Inform user that the reserved roomnick must be used (Condition: not-acceptable, Code: 406) not_on_memberlist 4 Entering a room Inform user that he or she is not on the member list (Condition: registration-required, Code: 407) nickname_in_use 4 Entering a room Inform user that his or her desired room nickname is in use or registered by another user (Condition: conflict, Code: 409) room_full 4 Entering a room Inform user that the maximum number of users has been reached (Condition: service-unavailable, Code: 503) 4 The condition and code are also available through the AnyEvent::XMPP::Error::Presence object returned by "presence_error", see below. text 4 This method returns a human readable text if one is available. presence_error 4 Returns a AnyEvent::XMPP::Error::Presence object if this error origins to such an error and not some internal error. message_error 4 Returns a AnyEvent::XMPP::Error::Message object if this error origins to such an error and not some internal error.
AnyEvent::XMPP::SimpleConnection(3)
Low level TCP/TLS connection
Apache2::ConnectionUtil(3)
Perl API for Apache connection utils
Apache2::PerlSections(3)
write Apache configuration files in Perl
Apache2::RequestUtil(3)
Perl API for Apache request record utils
Apache2::ServerUtil(3)
Perl API for Apache server record utils
Apache2::SiteControl::User(3)
User representations SYNOPSIS CW my $user = Apache2::SiteControl->getCurrentUser($r); # $r is the apache request object # Checking out the user's name: if($user->getUsername eq 'sam') { ... } ... # Working with attributes (session persistent data) my $ssn = $user->getAttribute('ssn'); $user->setAttribute($r, 'ssn', '333-555-6666'); # Removing/invalidating session for the user $user->logout($r); R DESCRIPTION The SiteControl system has a base concept of a user which includes the user's name, persistent attributes (which are persistent via session), and support for user logout. It is assumed that you will be working from mod_perl, and some of the methods require an Apache request object. The request object is used by some methods to coordinate access to the actual session information in the underlying system (for storing attributes and implementing logout). User objects are created by a factory (by default Apache2::SiteControl::UserFactory), so if you subclass User, you must understand the complete interaction between the factory (which is responsible for interfacing with persistence), the SiteControl, etc. The default implementation of User and UserFactory use AuthCookie to manage the sessions, and Apache::Session::File to store the various details about a user to disk. If you are using Apache2::SiteControl::User and Apache::SiteControl::UserFactory (the default and recommended), then you should configure the following parameters in your apache configuration file: CW # This is where the session data files will be stored SiteControlSessions directory_name # This is where the locks will be stored SiteControlLocks directory_name R These two directories should be different, and should be readable and writable by the apache daemon only. They must exist before trying to use SiteControl.
App::Cmd::Subdispatch(3)
an App::Cmd::Command that is also an App::Cmd
App::GitHub(3)
GitHub Command Tools
App::perlbrew(3)
Manage perl installations in your "$HOME" SYNOPSIS CW # Installation curl -L https://install.perlbrew.pl | bash # Initialize perlbrew init # See what is available perlbrew available # Install some Perls perlbrew install 5.18.2 perlbrew install perl-5.8.1 perlbrew install perl-5.19.9 # See what were installed perlbrew list # Swith to an installation and set it as default perlbrew switch perl-5.18.2 # Temporarily use another version only in current shell. perlbrew use perl-5.8.1 perl -v # Or turn it off completely. Useful when you messed up too deep. # Or want to go back to the system Perl. perlbrew off # Use 'switch' command to turn it back on. perlbrew switch perl-5.12.2 # Exec something with all perlbrew-ed perls perlbrew exec -- perl -E 'say $]' R DESCRIPTION perlbrew is a program to automate the building and installation of perl in an easy way. It provides multiple isolated perl environments, and a mechanism for you to switch between them. Everything are installed unter "~/perl5/perlbrew". You then need to include a bashrc/cshrc provided by perlbrew to tweak the PATH for you. You then can benefit from not having to run "sudo" commands to install cpan modules because those are installed inside your "HOME" too. For the documentation of perlbrew usage see perlbrew command on MetaCPAN <https://metacpan.org/>, or by running "perlbrew help", or by visiting perlbrew's official website <https://perlbrew.pl/>. The following documentation features the API of "App::perlbrew" module, and may not be remotely close to what your want to read. INSTALLATION It is the simplest to use the perlbrew installer, just paste this statement to your terminal: CW curl -L https://install.perlbrew.pl | bash R Or this one, if you have "fetch" (default on FreeBSD): CW fetch -o- https://install.perlbrew.pl | sh R After that, "perlbrew" installs itself to "~/perl5/perlbrew/bin", and you should follow the instruction on screen to modify your shell rc file to put it in your PATH. The installed perlbrew command is a standalone executable that can be run with system perl. The minimum system perl version requirement is 5.8.0, which should be good enough for most of the OSes these days. A fat-packed version of patchperl is also installed to "~/perl5/perlbrew/bin", which is required to build old perls. The directory "~/perl5/perlbrew" will contain all install perl executables, libraries, documentations, lib, site_libs. In the documentation, that directory is referred as "perlbrew root". If you need to set it to somewhere else because, say, your "HOME" has limited quota, you can do that by setting "PERLBREW_ROOT" environment variable before running the installer: CW export PERLBREW_ROOT=/opt/perl5 curl -L https://install.perlbrew.pl | bash R As a result, different users on the same machine can all share the same perlbrew root directory (although only original user that made the installation would have the permission to perform perl installations.) You may also install perlbrew from CPAN: CW cpan App::perlbrew R In this case, the perlbrew command is installed as "/usr/bin/perlbrew" or "/usr/local/bin/perlbrew" or others, depending on the location of your system perl installation. Please make sure not to run this with one of the perls brewed with perlbrew. It's the best to turn perlbrew off before you run that, if you're upgrading. CW perlbrew off cpan App::perlbrew R You should always use system cpan (like /usr/bin/cpan) to install "App::perlbrew" because it will be installed under a system PATH like "/usr/bin", which is not affected by perlbrew "switch" or "use" command. The "self-upgrade" command will not upgrade the perlbrew installed by cpan command, but it is also easy to upgrade perlbrew by running "cpan App::perlbrew" again. METHODS (Str) current_perl 4 Return the "current perl" object attribute string, or, if absent, the value of "PERLBREW_PERL" environment variable. (Str) current_perl (Str) 4 Set the "current_perl" object attribute to the given value. PROJECT DEVELOPMENT perlbrew project <https://perlbrew.pl/> uses github <https://github.com/gugod/App-perlbrew/issues> and RT <https://rt.cpan.org/Dist/Display.html?Queue=App-perlbrew> for issue tracking. Issues sent to these two systems will eventually be reviewed and handled. See <https://github.com/gugod/App-perlbrew/contributors> for a list of project contributors.
App::TLSMe(3)
TLS/SSL tunnel
App::TLSMe::Connection(3)
Connection class
App::TLSMe::Connection::http(3)
HTTP connection class
App::TLSMe::Connection::raw(3)
Raw connection class
App::TLSMe::Pool(3)
Connection pool
applybddnodeite(3)
computes the IF-THEN-ELSE logical operation.
APR::Pool(3)
Perl API for APR pools
Array::PrintCols(3)
Print or format array elements in vertically sorted columns.
ArrayLabels(3, 3o)
Array operations.
asa(3)
Lets your class/object say it works like something else
ASN1_STRING_new, ASN1_STRING_free, ASN1_STRING_type_new, ASN1_BIT_STRING_free, ASN1_BIT_STRING_new, ASN1_BMPSTRING_free, ASN1_BMPSTRING_new, ASN1_ENUMERATED_free, ASN1_ENUMERATED_new, ASN1_GENERALIZEDTIME_free, ASN1_GENERALIZEDTIME_new, ASN1_GENERALSTRING_free, ASN1_GENERALSTRING_new, ASN1_IA5STRING_free, ASN1_IA5STRING_new, ASN1_INTEGER_free, ASN1_INTEGER_new, ASN1_OCTET_STRING_free, ASN1_OCTET_STRING_new, ASN1_PRINTABLE_free, ASN1_PRINTABLE_new, ASN1_PRINTABLESTRING_free, ASN1_PRINTABLESTRING_new, ASN1_T61STRING_free, ASN1_T61STRING_new, ASN1_TIME_free, ASN1_TIME_new, ASN1_UNIVERSALSTRING_free, ASN1_UNIVERSALSTRING_new, ASN1_UTCTIME_free, ASN1_UTCTIME_new, ASN1_UTF8STRING_free, ASN1_UTF8STRING_new, ASN1_VISIBLESTRING_free, ASN1_VISIBLESTRING_new(3)
ASN1_STRING allocation functions
Astro::App::Satpass2::Utils(3)
Utilities for Astro::App::Satpass2
Astro::Catalog::Query::CMC(3)
A query request to the Carlsberg Meridian Catalog
Astro::Coord::ECI::TLE(3)
Compute satellite locations using NORAD orbit propagation models
Astro::Coord::ECI::Utils(3)
Utility routines for astronomical calculations
atf-c++, atf-c++-api, atf::utils::cat_file, atf::utils::compare_file, atf::utils::copy_file, atf::utils::create_file, atf::utils::file_exists, atf::utils::fork, atf::utils::grep_collection, atf::utils::grep_file, atf::utils::grep_string, atf::utils::redirect, atf::utils::wait, ATF_ADD_TEST_CASE, ATF_CHECK_ERRNO, ATF_FAIL, ATF_INIT_TEST_CASES, ATF_PASS, ATF_REQUIRE, ATF_REQUIRE_EQ, ATF_REQUIRE_ERRNO, ATF_REQUIRE_IN, ATF_REQUIRE_MATCH, ATF_REQUIRE_NOT_IN, ATF_REQUIRE_THROW, ATF_REQUIRE_THROW_RE, ATF_SKIP, ATF_TEST_CASE, ATF_TEST_CASE_BODY, ATF_TEST_CASE_CLEANUP, ATF_TEST_CASE_HEAD, ATF_TEST_CASE_NAME, ATF_TEST_CASE_USE, ATF_TEST_CASE_WITH_CLEANUP, ATF_TEST_CASE_WITHOUT_HEAD(3)
C++ API to write ATF-based test programs
atf-c++, atf-c-api++, atf::utils::cat_file, atf::utils::compare_file, atf::utils::copy_file, atf::utils::create_file, atf::utils::file_exists, atf::utils::fork, atf::utils::grep_collection, atf::utils::grep_file, atf::utils::grep_string, atf::utils::redirect, atf::utils::wait, ATF_ADD_TEST_CASE, ATF_CHECK_ERRNO, ATF_FAIL, ATF_INIT_TEST_CASES, ATF_PASS, ATF_REQUIRE, ATF_REQUIRE_EQ, ATF_REQUIRE_ERRNO, ATF_REQUIRE_IN, ATF_REQUIRE_MATCH, ATF_REQUIRE_NOT_IN, ATF_REQUIRE_THROW, ATF_REQUIRE_THROW_RE, ATF_SKIP, ATF_TEST_CASE, ATF_TEST_CASE_BODY, ATF_TEST_CASE_CLEANUP, ATF_TEST_CASE_HEAD, ATF_TEST_CASE_NAME, ATF_TEST_CASE_USE, ATF_TEST_CASE_WITH_CLEANUP, ATF_TEST_CASE_WITHOUT_HEAD(3)
C++ API to write ATF-based test programs
atf-c, atf-c-api, ATF_CHECK, ATF_CHECK_EQ, ATF_CHECK_EQ_MSG, ATF_CHECK_ERRNO, ATF_CHECK_MATCH, ATF_CHECK_MATCH_MSG, ATF_CHECK_MSG, ATF_CHECK_STREQ, ATF_CHECK_STREQ_MSG, atf_no_error, ATF_REQUIRE, ATF_REQUIRE_EQ, ATF_REQUIRE_EQ_MSG, ATF_REQUIRE_ERRNO, ATF_REQUIRE_MATCH, ATF_REQUIRE_MATCH_MSG, ATF_REQUIRE_MSG, ATF_REQUIRE_STREQ, ATF_REQUIRE_STREQ_MSG, ATF_TC, ATF_TC_BODY, ATF_TC_BODY_NAME, ATF_TC_CLEANUP, ATF_TC_CLEANUP_NAME, atf_tc_expect_death, atf_tc_expect_exit, atf_tc_expect_fail, atf_tc_expect_pass, atf_tc_expect_signal, atf_tc_expect_timeout, atf_tc_fail, atf_tc_fail_nonfatal, atf_tc_get_config_var, atf_tc_get_config_var_as_bool, atf_tc_get_config_var_as_bool_wd, atf_tc_get_config_var_as_long, atf_tc_get_config_var_as_long_wd, atf_tc_get_config_var_wd, ATF_TC_HEAD, ATF_TC_HEAD_NAME, ATF_TC_NAME, atf_tc_pass, atf_tc_skip, ATF_TC_WITH_CLEANUP, ATF_TC_WITHOUT_HEAD, ATF_TP_ADD_TC, ATF_TP_ADD_TCS, atf_utils_cat_file, atf_utils_compare_file, atf_utils_copy_file, atf_utils_create_file, atf_utils_file_exists, atf_utils_fork, atf_utils_free_charpp, atf_utils_grep_file, atf_utils_grep_string, atf_utils_readline, atf_utils_redirect, atf_utils_wait(3)
C API to write ATF-based test programs
atf-c, atf-c-api, ATF_CHECK, ATF_CHECK_EQ, ATF_CHECK_EQ_MSG, ATF_CHECK_ERRNO, ATF_CHECK_MATCH, ATF_CHECK_MATCH_MSG, ATF_CHECK_MSG, ATF_CHECK_STREQ, ATF_CHECK_STREQ_MSG, atf_no_error, ATF_REQUIRE, ATF_REQUIRE_EQ, ATF_REQUIRE_EQ_MSG, ATF_REQUIRE_ERRNO, ATF_REQUIRE_MATCH, ATF_REQUIRE_MATCH_MSG, ATF_REQUIRE_MSG, ATF_REQUIRE_STREQ, ATF_REQUIRE_STREQ_MSG, ATF_TC, ATF_TC_BODY, ATF_TC_BODY_NAME, ATF_TC_CLEANUP, ATF_TC_CLEANUP_NAME, atf_tc_expect_death, atf_tc_expect_exit, atf_tc_expect_fail, atf_tc_expect_pass, atf_tc_expect_signal, atf_tc_expect_timeout, atf_tc_fail, atf_tc_fail_nonfatal, atf_tc_get_config_var, atf_tc_get_config_var_as_bool, atf_tc_get_config_var_as_bool_wd, atf_tc_get_config_var_as_long, atf_tc_get_config_var_as_long_wd, atf_tc_get_config_var_wd, ATF_TC_HEAD, ATF_TC_HEAD_NAME, ATF_TC_NAME, atf_tc_pass, atf_tc_skip, ATF_TC_WITH_CLEANUP, ATF_TC_WITHOUT_HEAD, ATF_TP_ADD_TC, ATF_TP_ADD_TCS, atf_utils_cat_file, atf_utils_compare_file, atf_utils_copy_file, atf_utils_create_file, atf_utils_file_exists, atf_utils_fork, atf_utils_free_charpp, atf_utils_grep_file, atf_utils_grep_string, atf_utils_readline, atf_utils_redirect, atf_utils_wait(3)
C API to write ATF-based test programs
Audio::M4P(3)
Perl QuickTime / MP4 / iTunes Music Store audio / video file tools
Audio::M4P::QuickTime(3)
Perl M4P/MP4/M4a audio / video tools
B::BUtils, B::Utils(3)
Helper functions for op tree manipulation
B::Utils(3)
Helper functions for op tree manipulation
B::Utils::OP(3)
op related utility functions for perl
backtrace, backtrace_symbols, backtrace_symbols_fd, backtrace_symbols_fd_fmt, backtrace_symbols_fmt(3)
fill in the backtrace of the currently executing thread
Badger::Utils(3)
various utility functions
Bash::Completion::Utils(3)
Set of utility functions that help writting plugins
Biber::DataModel(3)
new CW Initialize a Biber::DataModel object R is_field CW Returns boolean to say if a field is a legal field Allows intermediate temp custom fields which are used when a driver source field doesn't have an obvious 1:1 mapping to a datamodel field. Such intermediates are defined in the target field mapping of a sourcemap. Also allows for fields with script form and optional lang suffix R is_entrytype CW Returns boolean to say if an entrytype is a legal entrytype R is_field_for_entrytype CW Returns boolean to say if a field is legal for an entrytype R entrytype_is_skipout CW Returns boolean depending on whether an entrytype is to be skipped on output R get_fields_of_fieldtype CW Retrieve fields of a certain biblatex fieldtype from data model Return in sorted order so that bbl order doesn't change when changing .bcf. This really messes up tests otherwise. R get_fields_of_fieldformat CW Retrieve fields of a certain format from data model Return in sorted order so that bbl order doesn't change when changing .bcf. This really messes up tests otherwise. R get_fields_of_datatype CW Retrieve fields of a certain biblatex datatype from data model Return in sorted order so that bbl order doesn't change when changing .bcf. This really messes up tests otherwise. R get_fields_of_type CW Retrieve fields of a certain biblatex type from data model Return in sorted order so that bbl order doesn't change when changing .bcf. This really messes up tests otherwise. R get_fieldtype CW Returns the fieldtype of a field R get_datatype CW Returns the datatype of a field R get_fieldformat CW Returns the format of a field R get_dm_for_field CW Returns the fieldtype and datatype of a field R field_is_fieldtype CW Returns boolean depending on whether a field is a certain biblatex fieldtype R field_is_datatype CW Returns boolean depending on whether a field is a certain biblatex datatype R field_is_nullok CW Returns boolean depending on whether a field is ok to be null R field_is_skipout CW Returns boolean depending on whether a field is to be skipped on output R check_mandatory_constraints CW Checks constraints of type "mandatory" on entry and returns an arry of warnings, if any R check_conditional_constraints CW Checks constraints of type "conditional" on entry and returns an arry of warnings, if any R check_data_constraints CW Checks constraints of type "data" on entry and returns an array of warnings, if any R dump CW Dump Biber::DataModel object R
Biber::Entry::Name(3)
new CW Initialize a Biber::Entry::Name object, optionally with key=>value arguments. Ex: Biber::Entry::Name->new( lastname=>"Bolzmann", firstname=>"Anna Maria", prefix => "von" ) R TO_JSON CW Serialiser for JSON::XS::encode R notnull CW Test for an empty object R was_stripped CW Return boolean to tell if the passed field had braces stripped from the original R set_hash CW Set a hash for the name R get_hash CW Get a hash for the name R set_index CW Set a field telling what position in the name list the name is R get_index CW Get the index of a Biber::Entry::Name object R set_uniquename CW Set uniquename for a visible Biber::Entry::Name object Sets global flag to say that some uniquename value has changed R set_uniquename_all CW Set uniquename for a Biber::Entry::Name object R get_uniquename CW Get uniquename for a visible Biber::Entry::Name object R get_uniquename_all CW Get uniquename for a Biber::Entry::Name object R reset_uniquename CW Reset uniquename for a Biber::Entry::Name object R set_minimal_info CW Set the string of lastnames and string of fullnames Used to track uniquename=5 or 6 R get_minimal_info CW Get the name context used to track uniquename=5 or 6 R get_namepart CW Get a namepart by passed name R set_firstname CW Set firstname for a Biber::Entry::Name object R get_firstname CW Get firstname for a Biber::Entry::Name object R get_firstname_i CW Get firstname initials for a Biber::Entry::Name object R set_middlename CW Set middlename for a Biber::Entry::Name object R get_middlename CW Get middlename for a Biber::Entry::Name object R get_middlename_i CW Get middlename initials for a Biber::Entry::Name object R set_lastname CW Set lastname for a Biber::Entry::Name object R get_lastname CW Get lastname for a Biber::Entry::Name object R get_lastname_i CW Get lastname initials for a Biber::Entry::Name object R set_suffix CW Set suffix for a Biber::Entry::Name object R get_suffix CW Get suffix for a Biber::Entry::Name object R get_suffix_i CW Get suffix initials for a Biber::Entry::Name object R set_prefix CW Set prefix for a Biber::Entry::Name object R get_prefix CW Get prefix for a Biber::Entry::Name object R get_prefix_i CW Get prefix initials for a Biber::Entry::Name object R set_gender CW Set gender for a Biber::Entry::Name object R get_gender CW Get gender for a Biber::Entry::Name object R set_namestring CW Set namestring for a Biber::Entry::Name object R get_namestring CW Get namestring for a Biber::Entry::Name object R set_nameinitstring CW Set nameinitstring for a Biber::Entry::Name object R get_nameinitstring CW Get nameinitstring for a Biber::Entry::Name object R name_to_biblatexml { CW Create biblatexml data for a name R name_to_bbl { CW Return bbl data for a name R dump CW Dump Biber::Entry::Name object R
Biber::Internals(3)
Internal methods for processing the bibliographic data
Biber::Section(3)
new CW Initialize a Biber::Section object R reset_caches CW Reset section caches which need it R set_keytods CW Save information about citekey->datasource name mapping. Used for error reporting. R get_keytods CW Get information about citekey->datasource name mapping. Used for error reporting. R has_badcasekey CW Returns a value to say if we've seen a key differing only in case before <previouskey> - we've seen a differently cased variant of this key so we can warn about this undef - Not seen this key at all in any case variant before R add_related CW Record that a key is used as a related entry R is_related CW Check if a key is used as a related entry key R keytorelclone CW Record a key<->clone key mapping. R get_keytorelclone CW Fetch a related entry clone key, given a cite key R get_relclonetokey CW Fetch a related entry key, given a clone key R has_keytorelclone CW Return boolean saying if a cite key has a related entry clone in the current section R has_relclonetokey CW Return boolean saying if a related clone key has a citekey in the current section R add_everykey CW Adds a datasource key to the section list of all datasource keys R del_everykeys CW Delete everykey cache. For use in tests. R has_everykey CW Returns a boolean to say if we've seen a key in any datasource for this section. This used to be an array ref which was checked using first() and it was twenty times slower. R set_allkeys CW Sets flag to say citekey '*' occurred in citekeys We allow setting it to false too because it's useful in tests R is_allkeys CW Checks flag which says citekey '*' occurred in citekeys R bibentry CW Returns a Biber::Entry object for the given citation key Understands citekey aliases R bibentries CW Return Biber::Entries object for this section R del_bibentries CW Delete all Biber::Entry objects from the Biber::Section object R set_citekeys CW Sets the citekeys in a Biber::Section object R set_orig_order_citekeys CW Sets the original order of citekeys in a Biber::Section object R get_citekeys CW Gets the citekeys of a Biber::Section object Returns a normal array R get_static_citekeys CW Gets the citekeys of a Biber::Section object excluding dynamic set entry keys Returns a normal array R add_undef_citekey CW Adds a citekey to the Biber::Section object as an undefined key. This allows us to output this information to the .bbl and so biblatex can do better reporting to external utils like latexmk R get_undef_citekeys CW Gets the list of undefined citekeys of a Biber::Section object Returns a normal array R get_orig_order_citekeys CW Gets the citekeys of a Biber::Section object in their original order This is just to ensure we have a method that will return this, just in case we mess about with the order at some point. This is needed by citeorder sorting. R has_citekey CW Returns true when $key is in the Biber::Section object Understands key alaises R del_citekey CW Deletes a citekey from a Biber::Section object R del_citekeys CW Deletes all citekeys from a Biber::Section object R add_citekeys CW Adds citekeys to the Biber::Section object R set_citekey_alias CW Set citekey alias information R get_citekey_alias CW Get citekey alias information R del_citekey_alias CW Delete citekey alias R get_citekey_aliases CW Get a list of all citekey aliases for the section R set_labelcache_v CW Sets the variable label disambiguation cache for a field R get_labelcache_v CW Gets the variable label disambiguation cache for a field R set_labelcache_l CW Sets the list label disambiguation cache for a field R get_labelcache_l CW Gets the list label disambiguation cache for a field R is_dynamic_set CW Test if a key is a dynamic set R set_dynamic_set CW Record a mapping of dynamic key to member keys R get_dynamic_set CW Retrieve member keys for a dynamic set key Check that reference returning anything to stop spurious warnings about empty dereference in return. R dynamic_set_keys CW Retrieve all dynamic set keys R has_dynamic_sets CW Returns true of false depending on whether the section has any dynamic set keys R add_datasource CW Adds a data source to a section R set_datasources CW Sets the data sources for a section R get_datasources CW Gets an array of data sources for this section R add_sort_cache CW Adds a scheme/keys pair to the sort cache: [$scheme, $keys, $sortinitdata, $extraalphadata, $extrayeardata ] R get_sort_cache CW Retrieves the sort cache R number CW Gets the section number of a Biber::Section object R
Biber::SortLists(3)
new CW Initialize a Biber::SortLists object R add_list CW Adds a section list to this section R get_lists CW Returns an array ref of all sort lists R get_lists_for_section CW Returns an array ref of all sort lists for a given section Using numeric equals as section identifiers are numbers R get_list CW Returns a specific list by section, name, type, sortscheme R has_lists_of_type_for_section CW Returns boolean saying whether there is a sort list for a section of a specified type R
Biber::UCollate(3)
new CW Instantiate new Unicode::Collate::Locale object with some extra reporting checks. We need this also so that we can chain some things during sorting object construction. Without an object, we would need to call a regular subroutine but due to the special semantics of Schwartzian transforms, we need to chain all sorting elements so that they return a boolean value (see Biber.pm). This is much tidier with Foo->new()->change()->cmp than with something messy like "my $uc = create_uc_object; $uc->change()->cmp()" etc. R
Biber::Utils(3)
Various utility subs used in Biber
Bio::Assembly::Tools::ContigSpectrum(3)
create and manipulate contig spectra
Bio::Coordinate::Utils(3)
Additional methods to create Bio::Coordinate objects.
Bio::Das::AGPServer::SQLStorage(3)
Bio::Das::AGPServer::SQLStorage
Bio::Das::AGPServer::SQLStorage::CSV::DB(3)
Bio::Das::AGPServer::SQLStorage::CSV::DB
Bio::Das::AGPServer::SQLStorage::MySQL::DB(3)
Bio::Das::AGPServer::SQLStorage::MySQL::DB
Bio::DB::GFF::RelSegment(3)
Sequence segment with relative coordinate support
Bio::Graphics::RendererI(3)
A renderer for the Bio::Graphics class that renders Bio::SeqFeature::CollectionI objects onto Bio::Graphics::Panels using configuration information provided by a Bio::Graphics::ConfiguratorI.
Bio::MolEvol::CodonModel(3)
Codon Evolution Models
Bio::NEXUS::Tools::GraphicsParams, Graphics(3)
represents a character block (Data or Characters) of a NEXUS file
Bio::NEXUS::Tools::NexModifier, Bio::NEXUS::Tools::Modifier(3)
NEXUS file content modifier ( exclude/select/rename options on OTUs).
Bio::NEXUS::Tools::NexPlotter, nexplot.pl(3)
PostScript plot of tree + data table (from NEXUS infile) CW =head1 SYNOPSIS nexplot.pl [options] foo.nex [tree_name] > foo.ps =head1 OPTIONS -h Brief help message -d Full documentation -v Verbose mode -V Print version information and quit R -f Specify output file (default: STDOUT) CW INFORMATION TO DISPLAY -b Turn on bootstrap values, if any -i Turn on internal node labeling -t Tree only (ignore any characters) -I Specify character block (by "Title") to be used in matrix (e.g. "dna", "protein", "intron") -m Matrix only (ignore any trees) -c Cladogram mode: (auto if no branch lengths present in tree) normal: all branch lengths equal accelerated: same as normal except OTUs are aligned at end -U Display taxa sets in color (-U "set1 color1 [set2 color2 ...]") Color options are red, orange, green, forest, aqua, blue, purple, pink, brown, gray, black PLOT FORMATTING -r Right-justify labels (default: left-justified) -C Columns of characters per block (default = 10) -T Specify tree width (longest branch; default: 10") -S Spacing (vertically) between OTUs (default: .25") -R Ratio of font height to Spacing (default: 0.8; rec: 0.5-1) -F Font to use for labels and titles -B Draw a box indicating postscript\'s bounds of the plot area -g Include gray lines after OTU labels, even if -t (tree only) option is used PAGE SETUP -s Print on multiple pages, but shrink to page height -o Print on multiple pages at actual size -W Specify output page width (default: 8.5") -H Specify output page height (default: 11") -a Change page dimensions to fit plot =head1 DESCRIPTION B<This program> will read a NEXUS file and output a PostScript display of trees (one file for each tree in the tree block), as well as any character matrix (e.g. sequences) if present in the file. =head1 FILES =over 4 =back =head1 VERSION $Id: NexPlotter.pm,v 1.2 2008/06/16 19:53:41 astoltzfus Exp $ R
Bio::Phylo::EvolutionaryModels(3)
Evolutionary models for phylogenetic trees and methods to sample these Klaas Hartmann, September 2007
Bio::Phylo::Util::Logger(3)
Logger of internal messages of several severity levels
Bio::PopGen::Population(3)
A population of individuals
Bio::Search::BlastUtils(3)
Utility functions for Bio::Search:: BLAST objects
Bio::Search::SearchUtils(3)
Utility functions for Bio::Search:: objects
Bio::Search::Tiling::MapTileUtils(3)
utilities for manipulating closed intervals for an HSP tiling algorithm
Bio::SeqFeature::Tools::FeatureNamer(3)
generates unique persistent names for features
Bio::SeqFeature::Tools::IDHandler(3)
maps $seq_feature->primary_tag
Bio::SeqFeature::Tools::TypeMapper(3)
maps $seq_feature->primary_tag
Bio::SeqFeature::Tools::Unflattener(3)
turns flat list of genbank-sourced features into a nested SeqFeatureI hierarchy
Bio::SeqIO::game::gameHandler(3)
PerlSAX handler for game-XML
Bio::SeqUtils(3)
Additional methods for PrimarySeq objects
Bio::Tools::AlignFactory(3)
Base object for alignment factories
Bio::Tools::Alignment::Consed(3)
A module to work with objects from consed .ace files
Bio::Tools::Alignment::Trim(3)
A kludge to do specialized trimming of sequence based on quality.
Bio::Tools::AmpliconSearch(3)
Find amplicons in a template using degenerate PCR primers
Bio::Tools::Analysis::DNA::ESEfinder(3)
a wrapper around ESEfinder server
Bio::Tools::Analysis::Protein::Domcut(3)
a wrapper around Domcut server
Bio::Tools::Analysis::Protein::ELM(3)
a wrapper around the ELM server which predicts short functional motifs on amino acid sequences
Bio::Tools::Analysis::Protein::GOR4(3)
a wrapper around GOR4 protein secondary structure prediction server
Bio::Tools::Analysis::Protein::HNN(3)
a wrapper around the HNN protein secondary structure prediction server
Bio::Tools::Analysis::Protein::NetPhos(3)
a wrapper around NetPhos server
Bio::Tools::Analysis::Protein::Scansite(3)
a wrapper around the Scansite server
Bio::Tools::Analysis::Protein::Sopma(3)
a wrapper around the Sopma protein secondary structure prediction server
Bio::Tools::Analysis::SimpleAnalysisBase(3)
abstract superclass for SimpleAnalysis implementations
Bio::Tools::AnalysisResult(3)
Base class for analysis result objects and parsers
Bio::Tools::Blat(3)
parser for Blat program
Bio::Tools::CodonTable(3)
Codon table object
Bio::Tools::Coil(3)
parser for Coil output
Bio::Tools::dpAlign(3)
Perl extension to do pairwise dynamic programming sequence alignment
Bio::Tools::ECnumber(3)
representation of EC numbers (Enzyme Classification)
Bio::Tools::EMBOSS::Palindrome(3)
parse EMBOSS palindrome output
Bio::Tools::EPCR(3)
Parse ePCR output and make features
Bio::Tools::Eponine(3)
Results of one Eponine run
Bio::Tools::Est2Genome(3)
Parse est2genome output, makes simple Bio::SeqFeature::Generic objects
Bio::Tools::ESTScan(3)
Results of one ESTScan run
Bio::Tools::Fgenesh(3)
parse results of one Fgenesh run
Bio::Tools::FootPrinter(3)
write sequence features in FootPrinter format
Bio::Tools::Gel(3)
Calculates relative electrophoretic migration distances
Bio::Tools::Geneid(3)
Results of one geneid run
Bio::Tools::Genemark(3)
Results of one Genemark run
Bio::Tools::Genewise(3)
Results of one Genewise run
Bio::Tools::Genomewise(3)
Results of one Genomewise run
Bio::Tools::Genscan(3)
Results of one Genscan run
Bio::Tools::GFF(3)
A Bio::SeqAnalysisParserI compliant GFF format parser
Bio::Tools::Glimmer(3)
parser for Glimmer 2.X/3.X prokaryotic and GlimmerM/GlimmerHMM eukaryotic gene predictions
Bio::Tools::Grail(3)
Results of one Grail run
Bio::Tools::GuessSeqFormat(3)
Module for determining the sequence format of the contents of a file, a string, or through a filehandle.
Bio::Tools::HMMER::Domain(3)
One particular domain hit from HMMER
Bio::Tools::HMMER::Results(3)
Object representing HMMER output results
Bio::Tools::HMMER::Set(3)
Set of identical domains from HMMER matches
Bio::Tools::Hmmpfam(3)
Parser for Hmmpfam program
Bio::Tools::ipcress(3)
Parse ipcress output and make features
Bio::Tools::isPcr(3)
Parse isPcr output and make features
Bio::Tools::IUPAC(3)
Generates unique sequence objects or regular expressions from an ambiguous IUPAC sequence
Bio::Tools::Lucy(3)
Object for analyzing the output from Lucy, a vector and quality trimming program from TIGR
Bio::Tools::Match(3)
Parses output from Transfac's match(TM)
Bio::Tools::MZEF(3)
Results of one MZEF run
Bio::Tools::OddCodes(3)
Object holding alternative alphabet coding for one protein sequence
Bio::Tools::Phylo::Gerp(3)
Parses output from GERP
Bio::Tools::Phylo::Gumby(3)
Parses output from gumby
Bio::Tools::Phylo::Molphy(3)
parser for Molphy output
Bio::Tools::Phylo::Molphy::Result(3)
container for data parsed from a ProtML run
Bio::Tools::Phylo::PAML(3)
Parses output from the PAML programs codeml, baseml, basemlg, codemlsites and yn00
Bio::Tools::Phylo::PAML::Codeml(3)
Parses output from the PAML program codeml.
Bio::Tools::Phylo::PAML::ModelResult(3)
A container for NSSite Model Result from PAML
Bio::Tools::Phylo::PAML::Result(3)
A PAML result set object
Bio::Tools::Phylo::Phylip::ProtDist(3)
parser for ProtDist output
Bio::Tools::pICalculator(3)
calculate the isoelectric point of a protein
Bio::Tools::Prediction::Exon(3)
A predicted exon feature
Bio::Tools::Prediction::Gene(3)
a predicted gene structure feature
Bio::Tools::Primer3(3)
Create input for and work with the output from the program primer3
Bio::Tools::Primer::Assessor::Base(3)
base class for common assessor things
Bio::Tools::Primer::AssessorI(3)
interface for assessing primer pairs
Bio::Tools::Primer::Feature(3)
position of a single primer
Bio::Tools::Primer::Pair(3)
two primers on left and right side
Bio::Tools::Prints(3)
Parser for FingerPRINTScanII program
Bio::Tools::Profile(3)
parse Profile output
Bio::Tools::Promoterwise(3)
parser for Promoterwise tab format output
Bio::Tools::PrositeScan(3)
Parser for ps_scan result
Bio::Tools::Protparam(3)
submit to and parse output from protparam ;
Bio::Tools::Pseudowise(3)
Results of one Pseudowise run
Bio::Tools::pSW(3)
pairwise Smith Waterman object
Bio::Tools::QRNA(3)
A Parser for qrna output
Bio::Tools::RandomDistFunctions(3)
A set of routines useful for generating random data in different distributions
Bio::Tools::RepeatMasker(3)
a parser for RepeatMasker output
Bio::Tools::Run::Alignment::Amap(3)
Object for the calculation of an iterative multiple sequence alignment from a set of unaligned sequences or alignments using the Amap (2.0) program
Bio::Tools::Run::Alignment::Blat(3)
Bio::Tools::Run::Alignment::Blat
Bio::Tools::Run::Alignment::Clustalw(3)
Object for the calculation of a multiple sequence alignment from a set of unaligned sequences or alignments using the Clustalw program
Bio::Tools::Run::Alignment::DBA(3)
Object for the alignment of two sequences using the DNA Block Aligner program.
Bio::Tools::Run::Alignment::Exonerate(3)
Bio::Tools::Run::Alignment::Exonerate
Bio::Tools::Run::Alignment::Gmap(3)
Wrapper for running gmap.
Bio::Tools::Run::Alignment::Kalign(3)
Object for the calculation of an iterative multiple sequence alignment from a set of unaligned sequences or alignments using the KALIGN program
Bio::Tools::Run::Alignment::Lagan(3)
Object for the local execution of the LAGAN suite of tools (including MLAGAN for multiple sequence alignments)
Bio::Tools::Run::Alignment::MAFFT(3)
run the MAFFT alignment tools
Bio::Tools::Run::Alignment::MSAProbs(3)
Object for the calculation of a multiple sequence alignment (MSA) from a set of unaligned sequences using the MSAProbs program
Bio::Tools::Run::Alignment::Muscle(3)
Object for the calculation of an iterative multiple sequence alignment from a set of unaligned sequences or alignments using the MUSCLE program
Bio::Tools::Run::Alignment::Pal2Nal(3)
Wrapper for Pal2Nal
Bio::Tools::Run::Alignment::Probalign(3)
Object for the calculation of a multiple sequence alignment from a set of unaligned sequences or alignments using the Probalign program
Bio::Tools::Run::Alignment::Probcons(3)
Object for the calculation of an iterative multiple sequence alignment from a set of unaligned sequences or alignments using the Probcons program
Bio::Tools::Run::Alignment::Proda(3)
Object for the calculation of sets of multiple sequence alignments from a set of unaligned sequences or alignments using the Proda program.
Bio::Tools::Run::Alignment::Sim4(3)
Wrapper for Sim4 program that allows for alignment of cdna to genomic sequences
Bio::Tools::Run::Alignment::StandAloneFasta(3)
Object for the local execution of the Fasta3 programs ((t)fasta3, (t)fastx3, (t)fasty3 ssearch3)
Bio::Tools::Run::Alignment::TCoffee(3)
Object for the calculation of a multiple sequence alignment from a set of unaligned sequences or alignments using the TCoffee program
Bio::Tools::Run::Analysis(3)
Module representing any (remote or local) analysis tool
Bio::Tools::Run::Analysis::soap(3)
A SOAP-based access to the analysis tools
Bio::Tools::Run::AnalysisFactory(3)
A directory of analysis tools
Bio::Tools::Run::AnalysisFactory::soap(3)
A SOAP-based access to the list of analysis tools
Bio::Tools::Run::AssemblerBase(3)
base class for wrapping external assemblers
Bio::Tools::Run::BEDTools(3)
Run wrapper for the BEDTools suite of programs *BETA*
Bio::Tools::Run::BEDTools::Config(3)
Configuration data for bowtie commands
Bio::Tools::Run::BlastPlus(3)
A wrapper for NCBI's blast+ suite
Bio::Tools::Run::Bowtie(3)
Run wrapper for the Bowtie short-read assembler *BETA*
Bio::Tools::Run::Bowtie::Config(3)
Configuration data for bowtie commands
Bio::Tools::Run::BWA(3)
Run wrapper for the BWA short-read assembler *BETA*
Bio::Tools::Run::BWA::Config(3)
Configuration data for BWA commands
Bio::Tools::Run::Cap3(3)
wrapper for CAP3
Bio::Tools::Run::Coil(3)
wrapper for ncoils program
Bio::Tools::Run::EMBOSSacd(3)
class for EMBOSS Application qualifiers
Bio::Tools::Run::EMBOSSApplication(3)
class for EMBOSS Applications
Bio::Tools::Run::Ensembl(3)
A simplified front-end for setting up the registry for, and then using an Ensembl database with the Ensembl Perl API.
Bio::Tools::Run::Eponine(3)
Object for execution of the Eponine which is a mammalian TSS predictor
Bio::Tools::Run::ERPIN(3)
Wrapper for local execution of the ERPIN suite of programs.
Bio::Tools::Run::FootPrinter(3)
wrapper for the FootPrinter program
Bio::Tools::Run::Genemark(3)
Wrapper for local execution of the GeneMark family of programs.
Bio::Tools::Run::GenericParameters(3)
An object for the parameters used to run programs
Bio::Tools::Run::Genewise(3)
Object for predicting genes in a given sequence given a protein
Bio::Tools::Run::Genscan(3)
Object for identifying genes in a given sequence given a matrix(for appropriate organisms).
Bio::Tools::Run::Glimmer(3)
Wrapper for local execution of Glimmer, GlimmerM and GlimmerHMM.
Bio::Tools::Run::Hmmer(3)
Wrapper for local execution of hmmalign, hmmbuild, hmmcalibrate, hmmemit, hmmpfam, hmmsearch
Bio::Tools::Run::Infernal(3)
Wrapper for local execution of cmalign, cmbuild, cmsearch, cmscore
Bio::Tools::Run::Maq(3)
Run wrapper for the Maq short-read assembler *BETA*
Bio::Tools::Run::Maq::Config(3)
Configuration data for maq commands
Bio::Tools::Run::Match(3)
Wrapper for Transfac's match(TM)
Bio::Tools::Run::MCS(3)
Wrapper for MCS
Bio::Tools::Run::Mdust, Mdust(3)
Perl extension for Mdust nucleotide filtering
Bio::Tools::Run::Meme(3)
Wrapper for Meme Program
Bio::Tools::Run::Minimo, CW(3)
Bio::Tools::Run::Minimo - Wrapper for local execution of the Minimo assembler R
Bio::Tools::Run::Newbler, CW(3)
Bio::Tools::Run::Newbler - Wrapper for local execution of Newbler R
Bio::Tools::Run::ParametersI(3)
A Base object for the parameters used to run programs
Bio::Tools::Run::Phrap(3)
a wrapper for running Phrap
Bio::Tools::Run::Phylo::FastTree(3)
Bio::Tools::Run::Phylo::FastTree
Bio::Tools::Run::Phylo::Gerp, Bio::Tools::Run::Gerp(3)
Wrapper for GERP
Bio::Tools::Run::Phylo::Gumby(3)
Wrapper for gumby
Bio::Tools::Run::Phylo::Hyphy::Base(3)
Hyphy wrapping base methods
Bio::Tools::Run::Phylo::Hyphy::BatchFile(3)
Wrapper for custom execution of Hyphy batch files
Bio::Tools::Run::Phylo::Hyphy::FEL(3)
Wrapper around the Hyphy FEL analysis
Bio::Tools::Run::Phylo::Hyphy::Modeltest(3)
Wrapper around the Hyphy Modeltest analysis
Bio::Tools::Run::Phylo::Hyphy::REL(3)
Wrapper around the Hyphy REL analysis
Bio::Tools::Run::Phylo::Hyphy::SLAC(3)
Wrapper around the Hyphy SLAC analysis
Bio::Tools::Run::Phylo::LVB(3)
Object for using the LVB program to create an array of Bio::Tree objects from a nucleotide multiple alignment file or a nucleotide SimpleAlign object. Works with LVB version 2.1.
Bio::Tools::Run::Phylo::Molphy::ProtML(3)
A wrapper for the Molphy pkg app ProtML
Bio::Tools::Run::Phylo::Njtree::Best(3)
Wrapper around the Njtree (Njtree/phyml) best program.
Bio::Tools::Run::Phylo::PAML::Baseml(3)
Wrapper aroud the PAML program baseml
Bio::Tools::Run::Phylo::PAML::Codeml(3)
Wrapper aroud the PAML program codeml
Bio::Tools::Run::Phylo::PAML::Evolver(3)
Wrapper aroud the PAML program evolver
Bio::Tools::Run::Phylo::PAML::Yn00(3)
Wrapper aroud the PAML program yn00
Bio::Tools::Run::Phylo::Phast::PhastCons(3)
Wrapper for footprinting using phastCons
Bio::Tools::Run::Phylo::Phast::PhyloFit(3)
Wrapper for phyloFit
Bio::Tools::Run::Phylo::Phylip::Base(3)
Base object for Phylip modules
Bio::Tools::Run::Phylo::Phylip::Consense(3)
Wrapper for the phylip program Consense
Bio::Tools::Run::Phylo::Phylip::DrawGram(3)
use Phylip DrawTree program to draw phylograms or phenograms
Bio::Tools::Run::Phylo::Phylip::DrawTree(3)
use Phylip DrawTree program to draw trees
Bio::Tools::Run::Phylo::Phylip::Neighbor(3)
Wrapper for the phylip program neighbor by Joseph Felsenstein for creating a phylogenetic tree(either through Neighbor or UPGMA) based on protein distances based on amino substitution rate. 14 Nov 2002 Shawn Works with Phylip version 3.6
Bio::Tools::Run::Phylo::Phylip::PhylipConf(3)
Bio::Tools::Run::Phylo::Phylip::PhylipConf
Bio::Tools::Run::Phylo::Phylip::ProtDist(3)
Wrapper for the phylip program protdist
Bio::Tools::Run::Phylo::Phylip::ProtPars(3)
Object for creating a Bio::Tree object from a multiple alignment file or a SimpleAlign object 14 Nov 2002 Shawn Works with Phylip version 3.6
Bio::Tools::Run::Phylo::Phylip::SeqBoot(3)
Wrapper for the phylip program SeqBoot
Bio::Tools::Run::Phylo::PhyloBase, Bio::Tools::Run::Phylo::PhyloBase-(3)
base module for phylo wrappers
Bio::Tools::Run::Phylo::Phyml(3)
Wrapper for rapid reconstruction of phylogenies using Phyml
Bio::Tools::Run::Phylo::QuickTree(3)
Wrapper for rapid reconstruction of phylogenies using QuickTree
Bio::Tools::Run::Phylo::Raxml(3)
Bio::Tools::Run::Phylo::Raxml
Bio::Tools::Run::Phylo::Semphy(3)
Wrapper for Semphy
Bio::Tools::Run::Phylo::SLR(3)
Wrapper around the SLR program
Bio::Tools::Run::Primate, Wrapper(3)
for Primate, Guy Slater's near exact match finder for short sequence tags.
Bio::Tools::Run::Primer3(3)
Create input for and work with the output from the program primer3
Bio::Tools::Run::Prints(3)
Bio::Tools::Run::Prints
Bio::Tools::Run::Profile(3)
Bio::Tools::Run::Profile
Bio::Tools::Run::Promoterwise(3)
Wrapper for aligning two sequences using promoterwise
Bio::Tools::Run::Pseudowise(3)
Object for prediting pseudogenes in a given sequence given a protein and a cdna sequence
Bio::Tools::Run::RemoteBlast(3)
Object for remote execution of the NCBI Blast via HTTP
Bio::Tools::Run::RepeatMasker(3)
Wrapper for RepeatMasker Program
Bio::Tools::Run::RNAMotif(3)
Wrapper for local execution of rnamotif, rm2ct, rmfmt, rmprune
Bio::Tools::Run::Samtools(3)
a run wrapper for the samtools suite *BETA*
Bio::Tools::Run::Samtools::Config(3)
configurator for Bio::Tools::Run::Samtools
Bio::Tools::Run::Seg(3)
Object for identifying low complexity regions in a given protein seequence.
Bio::Tools::Run::Signalp(3)
Bio::Tools::Run::Signalp
Bio::Tools::Run::Simprot(3)
Wrapper around the Simprot program. Wrapper for the calculation of a multiple sequence alignment from a phylogenetic tree
Bio::Tools::Run::StandAloneBlast(3)
Object for the local execution of the NCBI BLAST program suite (blastall, blastpgp, bl2seq). There is experimental support for WU-Blast and NCBI rpsblast.
Bio::Tools::Run::StandAloneBlastPlus(3)
Compute with NCBI's blast+ suite *ALPHA*
Bio::Tools::Run::StandAloneBlastPlus::BlastMethods(3)
Provides BLAST methods to StandAloneBlastPlus
Bio::Tools::Run::StandAloneNCBIBlast(3)
Object for the local execution of the NCBI BLAST program suite (blastall, blastpgp, bl2seq). With experimental support for NCBI rpsblast.
Bio::Tools::Run::StandAloneWUBlast(3)
Object for the local execution of WU-Blast.
Bio::Tools::Run::TigrAssembler(3)
Wrapper for local execution of TIGR Assembler v2
Bio::Tools::Run::Tmhmm(3)
Object for identifying transmembrane helixes in a given protein seequence.
Bio::Tools::Run::TribeMCL(3)
Bio::Tools::Run::TribeMCL
Bio::Tools::Run::tRNAscanSE(3)
Wrapper for local execution of tRNAscan-SE
Bio::Tools::Run::Vista(3)
Wrapper for Vista
Bio::Tools::Run::WrapperBase(3)
A Base object for wrappers around executables
Bio::Tools::Run::WrapperBase::CommandExts(3)
Extensions to WrapperBase for handling programs with commands *ALPHA*
Bio::Tools::Seg(3)
parse "seg" output
Bio::Tools::SeqPattern(3)
represent a sequence pattern or motif
Bio::Tools::SeqPattern::Backtranslate(3)
Bio::Tools::SeqPattern::Backtranslate
Bio::Tools::SeqStats(3)
Object holding statistics for one particular sequence
Bio::Tools::SeqWords(3)
Object holding n-mer statistics for a sequence
Bio::Tools::Sigcleave(3)
Bioperl object for sigcleave analysis
Bio::Tools::Signalp(3)
parser for Signalp output
Bio::Tools::Signalp::ExtendedSignalp(3)
enhanced parser for Signalp output
Bio::Tools::Sim4::Exon(3)
A single exon determined by an alignment
Bio::Tools::Sim4::Results(3)
Results of one Sim4 run
Bio::Tools::SiRNA, SiRNA(3)
Perl object for designing small inhibitory RNAs.
Bio::Tools::SiRNA::Ruleset::saigo(3)
Perl object implementing the Saigo group's rules for designing small inhibitory RNAs
Bio::Tools::SiRNA::Ruleset::tuschl(3)
Perl object implementing the tuschl group's rules for designing small inhibitory RNAs
Bio::Tools::Spidey::Exon(3)
A single exon determined by an alignment
Bio::Tools::Spidey::Results(3)
Results of a Spidey run
Bio::Tools::TandemRepeatsFinder(3)
a parser for Tandem Repeats Finder output
Bio::Tools::TargetP(3)
Results of one TargetP run
Bio::Tools::Tmhmm(3)
parse TMHMM output (TransMembrane HMM)
Bio::Tools::tRNAscanSE(3)
A parser for tRNAscan-SE output
BlackPixelOfScreen, CellsOfScreen, DefaultColormapOfScreen, DefaultDepthOfScreen, DefaultGCOfScreen, DefaultVisualOfScreen, DisplayOfScreen, DoesBackingStore, DoesSaveUnders, EventMaskOfScreen, HeightMMOfScreen, HeightOfScreen, MaxCmapsOfScreen, MinCmapsOfScreen, PlanesOfScreen, RootWindowOfScreen, WhitePixelOfScreen, WidthMMOfScreen, WidthOfScreen, XScreenNumberOfScreen(3)
screen information functions and macros
Blog::Spam::Plugin::lotsaurls(3)
Reject comments containing multiple URLs.
Blog::Spam::Plugin::multilinks(3)
Reject opportunistic use of URLs.
Blog::Spam::Plugin::surbl(3)
Discard comments with surbl-listed URLs.
BN_set_bit, BN_clear_bit, BN_is_bit_set, BN_lshift, BN_lshift1, BN_mask_bits, BN_rshift, BN_rshift1(3)
bit operations on BIGNUMs
BN_set_bit, BN_clear_bit, BN_is_bit_set, BN_lshift, BN_lshift1, BN_mask_bits, BN_rshift, BN_rshift1(3)
bit operations on BIGNUMs
BSinit(3)
Initializes BlockSolve and MPI. BSinit() calls MPI_Init() if it has not already been called.
BytesLabels(3, 3o)
Byte sequence operations.
BZ::Client::XMLRPC, CW(3)
BZ::Client::XMLRPC - Performs XML-RPC calls on behalf of the client. R
Cache::CacheUtils(3)
miscellaneous utility routines
Cache::RemovalStrategy(3)
abstract Removal Strategy interface for a Cache
Cache::RemovalStrategy::FIFO(3)
FIFO Removal Strategy for a Cache
Cache::RemovalStrategy::LRU(3)
LRU Removal Strategy for a Cache
Cache::Simple::TimedExpiry(3)
EXAMPLE CW package main; use strict; use warnings; $,=' '; $|++; use Cache::Simple::TimedExpiry; my $h = Cache::Simple::TimedExpiry->new; $h->set( DieQuick => "No duration!", 0); print $h->elements; do { $h->set($_,"Value of $_", 1); sleep 2;} for qw(Have a nice day you little monkey); print $h->elements; $h->dump; sleep 4; print $h->elements; $h->dump; print time; R new Set up a new cache object expire_after SECONDS Set the cache's expiry policy to expire entries after SECONDS seconds. Setting this changes the expiry policy for pre-existing cache entries and for new ones. has_key KEY Return true if the cache has an entry with the key KEY fetch KEY Return the cache entry with key KEY. Returns undef if there is no such entry (Can also be called as get) store KEY VALUE Store VALUE in the cache with accessor KEY. Expire it from the cache at or after EXPIRYTIME. (Can also be called as set)
Carp::Datum::MakeMaker(3)
Offer to strip Carp::Datum calls statically
Carp::Datum::Strip(3)
strips most Carp::Datum calls lexically
Carton::Doc::Bundle(3)
Bundle cached tarballs in vendor/cache
Catalyst::Component::ACCEPT_CONTEXT(3)
Make the current Catalyst request context available in Models and Views.
Catalyst::Devel(3)
Catalyst Development Tools
Catalyst::Helper::Model::CDBI(3)
Helper for CDBI Models
Catalyst::Helper::Model::DBIC::Plain(3)
Helper for DBIC Plain Models
Catalyst::Helper::Model::DBIC::Schema(3)
Helper for DBIC Schema Models
Catalyst::Helper::Model::Enzyme::CDBI(3)
Helper for Catalyst::Enzyme CDBI Models
Catalyst::Helper::Model::LDAP(3)
Helper for LDAP models
Catalyst::Manual::Deployment::Apache::FastCGI(3)
Deploying Catalyst with FastCGI on Apache Setup 1. Install Apache with mod_fastcgi mod_fastcgi for Apache is a third-party module, and can be found at <http://www.fastcgi.com/>. It is also packaged in many distributions (for example, libapache2-mod-fastcgi in Debian). You will also need to install the FCGI module from CPAN. Important Note! If you experience difficulty properly rendering pages, try disabling Apache's mod_deflate (Deflate Module), e.g. 'a2dismod deflate'. Apache 1.x, 2.x Apache requires the mod_fastcgi module. The same module supports both Apache 1 and 2. There are three ways to run your application under FastCGI on Apache: server, static, and dynamic. Standalone server mode CW FastCgiExternalServer /tmp/myapp.fcgi -socket /tmp/myapp.socket Alias /myapp/ /tmp/myapp.fcgi/ # Or, run at the root Alias / /tmp/myapp.fcgi/ # Optionally, rewrite the path when accessed without a trailing slash RewriteRule ^/myapp$ myapp/ [R] R The FastCgiExternalServer directive tells Apache that when serving /tmp/myapp to use the FastCGI application listening on the socket /tmp/mapp.socket. Note that /tmp/myapp.fcgi MUST NOT exist -- it's a virtual file name. With some versions of "mod_fastcgi" or "mod_fcgid", you can use any name you like, but some require that the virtual filename end in ".fcgi". It's likely that Apache is not configured to serve files in /tmp, so the Alias directive maps the url path /myapp/ to the (virtual) file that runs the FastCGI application. The trailing slashes are important as their use will correctly set the PATH_INFO environment variable used by Catalyst to determine the request path. If you would like to be able to access your app without a trailing slash (http://server/myapp), you can use the above RewriteRule directive. Static mode The term 'static' is misleading, but in static mode Apache uses its own FastCGI Process Manager to start the application processes. This happens at Apache startup time. In this case you do not run your application's fastcgi.pl script -- that is done by Apache. Apache then maps URIs to the FastCGI script to run your application. CW FastCgiServer /path/to/myapp/script/myapp_fastcgi.pl -processes 3 Alias /myapp/ /path/to/myapp/script/myapp_fastcgi.pl/ R FastCgiServer tells Apache to start three processes of your application at startup. The Alias command maps a path to the FastCGI application. Again, the trailing slashes are important. Dynamic mode In FastCGI dynamic mode, Apache will run your application on demand, typically by requesting a file with a specific extension (e.g. .fcgi). ISPs often use this type of setup to provide FastCGI support to many customers. In this mode it is often enough to place or link your *_fastcgi.pl script in your cgi-bin directory with the extension of .fcgi. In dynamic mode Apache must be able to run your application as a CGI script so ExecCGI must be enabled for the directory. CW AddHandler fastcgi-script .fcgi R The above tells Apache to run any .fcgi file as a FastCGI application. Here is a complete example: CW <VirtualHost *:80> ServerName www.myapp.com DocumentRoot /path/to/MyApp # Allow CGI script to run <Directory /path/to/MyApp> Options +ExecCGI </Directory> # Tell Apache this is a FastCGI application <Files myapp_fastcgi.pl> SetHandler fastcgi-script </Files> </VirtualHost> R Then a request for /script/myapp_fastcgi.pl will run the application. For more information on using FastCGI under Apache, visit <http://www.fastcgi.com/mod_fastcgi/docs/mod_fastcgi.html> Authorization header with mod_fastcgi or mod_cgi By default, mod_fastcgi/mod_cgi do not pass along the Authorization header, so modules like "Catalyst::Plugin::Authentication::Credential::HTTP" will not work. To enable pass-through of this header, add the following mod_rewrite directives: CW RewriteCond %{HTTP:Authorization} ^(.+) RewriteRule ^(.*)$ $1 [E=HTTP_AUTHORIZATION:%1,PT] R 2. Configure your application CW # Serve static content directly DocumentRoot /var/www/MyApp/root Alias /static /var/www/MyApp/root/static FastCgiServer /var/www/MyApp/script/myapp_fastcgi.pl -processes 3 Alias /myapp/ /var/www/MyApp/script/myapp_fastcgi.pl/ # Or, run at the root Alias / /var/www/MyApp/script/myapp_fastcgi.pl/ R The above commands will launch 3 app processes and make the app available at /myapp/ Standalone server mode While not as easy as the previous method, running your app as an external server gives you much more flexibility. First, launch your app as a standalone server listening on a socket. CW script/myapp_fastcgi.pl -l /tmp/myapp.socket -n 5 -p /tmp/myapp.pid -d R You can also listen on a TCP port if your web server is not on the same machine. CW script/myapp_fastcgi.pl -l :8080 -n 5 -p /tmp/myapp.pid -d R You will probably want to write an init script to handle starting/stopping of the app using the pid file. Now, we simply configure Apache to connect to the running server. CW # 502 is a Bad Gateway error, and will occur if the backend server is down # This allows us to display a friendly static page that says "down for # maintenance" Alias /_errors /var/www/MyApp/root/error-pages ErrorDocument 502 /_errors/502.html FastCgiExternalServer /tmp/myapp.fcgi -socket /tmp/myapp.socket Alias /myapp/ /tmp/myapp.fcgi/ # Or, run at the root Alias / /tmp/myapp.fcgi/ R More Info Catalyst::Manual::Deployment::FastCGI.
Catalyst::Manual::Internals(3)
Catalyst Internals
Catalyst::Model::CDBI::Plain(3)
A Plain base class for Class::DBI models
Catalyst::Model::Memcached(3)
Wrapper for memcached imitating Catalyst models
Catalyst::Plugin::Authentication::Internals(3)
All about authentication Stores and Credentials
Catalyst::Plugin::Email(3)
(DEPRECATED) Send emails with Catalyst
Catalyst::Plugin::Params::Nested(3)
Nested form parameters (ala Ruby on Rails).
Catalyst::Plugin::Params::Nested::Expander(3)
CGI::Expand subclass with rails like tokenization.
Catalyst::Plugin::Server(3)
Base Server plugin for RPC-able protocols
Catalyst::Utils(3)
The Catalyst Utils
CatalystX::SimpleLogin::Manual(3)
How to use and customise CatalystX::SimpleLogin. Tutorial We're using a sample application here, to make the instructions a little easier. This assumes that you have Catalyst, Catalyst::Devel, Template Toolkit, and the Catalyst authentication and session plugins installed. CW catalyst.pl MyApp cd MyApp script/myapp_create.pl view HTML TT R Edit lib/MyApp.pm and add CatalystX::SimpleLogin, Authenticate, and the Session plugins to the use Catalyst plugin list: CW use Catalyst qw/-Debug ConfigLoader +CatalystX::SimpleLogin Authentication Session Session::Store::File Session::State::Cookie Static::Simple/; R Add the following config for authentication, including two sample users: CW __PACKAGE__->config( 'Plugin::Authentication' => { default => { credential => { class => 'Password', password_field => 'password', password_type => 'clear' }, store => { class => 'Minimal', users => { bob => { password => "bobpw", }, william => { password => "billpw", }, }, }, }, }, ); R Execute " script/myapp_server.pl " and, as part of the debug output, you should see: CW [debug] Loaded Chained actions: .-------------------------------------+--------------------------------------. | Path Spec | Private | +-------------------------------------+--------------------------------------+ | /login | /login/login | | /logout | /login/logout | '-------------------------------------+--------------------------------------' R Go to " localhost:3000 " and you should see the Catalyst welcome screen. Go to " localhost:3000/login " and you should get a login screen containing username and password text fields, a 'Remember' checkbox, and a 'Login' button. Enter 'bob' and 'bobpw'. You should be logged in and taken to the welcome screen. If you execute " localhost:3000/logout " you will be logged out, and should see this in the debug output (the welcome screen will stay the same). Now go to " lib/MyApp/Controller/Root.pm " and remove the lines saying: CW use strict; use warnings; use parent 'Catalyst::Controller'; R and add the following lines: CW use Moose; use namespace::autoclean; BEGIN { extends 'Catalyst::Controller' } R Now add a new action to " lib/MyApp/Controller/Root.pm " and include " Does('NeedsLogin') " to use the Catalyst ActionRole that is part of SimpleLogin: CW sub hello_user : Local Does('NeedsLogin') { my ( $self, $c ) = @_; $c->res->body('<h2>Hello, user!</h2>'); } R Restart the server and you can see the new action. Go to "htp://localhost:3000/hello_user" and you'll get the 'Hello, user!' page. Now execute "http://localhost:3000/logout" and try "http://localhost:3000/hello_user" again. You will be presented with a login screen. Authorization CatalystX::SimpleLogin also provides /login/required and /login/not_required for easy chaining off of for actions which should only be available to authenticated users. CW package MyApp::Controller::Secure; sub setup : Chained('/login/required') PathPart('') CaptureArgs(1) { my ( $self, $c, $id ) = @_; # setup actions for authenticated-user-only access $c->stash->{id} = $id; } sub something_secure : Chained('setup') PathPart Args(0) { my ( $self, $c ) = @_; # only authenticated users will have access to this action } sub open_to_all : Chained('/login/not_required') PathPart Args(0) { my ( $self, $c ) = @_; # this is available to everyone } R For more fine-grained control, you can use ACL checks to refine access control policies. This functionality is provided via Catalyst::ActionRole::ACL. Please consult the ACL documentation for steps to setup your application. The ACL checks work by allowing you to add additional attributes on your actions which control the particular role(s) required or allowed. CW package MyApp; __PACKAGE__->config( 'Controller::Login' => { actions => { required => { Does => ['ACL'], AllowedRole => ['admin', 'poweruser'], # ANY of these # RequiresRole => ['extranet'], # ALL of these ACLDetachTo => 'login', }, }, }, ); package MyApp::Controller::Foo; BEGIN { extends 'Catalyst::Controller' } sub do_something : Chained('/login/required') : Does('ACL') RequiresRole('createinvoice') ACLDetachTo('/login') {} R You can also add a message, which will be put into the flash key 'error_msg'. Add the following to the hello_user action: CW : LoginRedirectMessage('Please Login to view this Action') R Now we'll create a Template Toolkit template that can be customized. Create a " root/login/login.tt " file with the following lines. CW [% error_msg %] [% render_login_form %] R Now edit " lib/MyApp.pm " and add the config shown below to remove the 'RenderAsTTTemplate' trait, and add 'flash_to_stash' for Catalyst::Plugin::Session (to allow the error message to be passed to the next request): CW __PACKAGE__->config( 'Plugin::Session' => { flash_to_stash => 1 }, 'Controller::Login' => { traits => ['-RenderAsTTTemplate'], }, # Other config.. ); R Restart the server and try to view the hello_user page without being logged in. You should be redireced to the login page with the error message displayed at the top. You can replace " [% render_login_form %] " with your own html, and customize it as you please. CW <div class="error">[% error_msg %]</div> <form id="login_form" method="post" > <fieldset class="main_fieldset"> <div><label class="label" for="username">Username: </label><input type="text" name="username" id="username" value="" /> </div> <div><label class="label" for="password">Password: </label> <input type="password" name="password" id="password" value="" /> </div> <div><label class="label" for="remember">Remember: </label> <input type="checkbox" name="remember" id="remember" value="1" /> </div> <div><input type="submit" name="submit" id="submit" value="Login" /> </div> </fieldset></form> R Or you can customize it using HTML::FormHandler HTML rendering features, and the 'login_form_args' config key. To alter the amount the remember me extends the session by alter the "remember_me_expiry" configuration setting. CW __PACKAGE__->config( 'Controller::Login' => { remember_me_expiry => 999999999, # the default is about 32 years. }, # Other config.. ); R
cdk_matrix, activateCDKMatrix, cleanCDKMatrix, cleanCDKMatrixCell, destroyCDKMatrix, drawCDKMatrix, eraseCDKMatrix, getCDKMatrixBox, getCDKMatrixCell, getCDKMatrixCol, getCDKMatrixRow, injectCDKMatrix, jumpToCell, moveToCDKMatrixCell, newCDKMatrix, setCDKMatrix, setCDKMatrixBackgroundAttrib, setCDKMatrixBackgroundColor, setCDKMatrixBox, setCDKMatrixBoxAttribute, setCDKMatrixCB, setCDKMatrixCell, setCDKMatrixCells, setCDKMatrixHorizontalChar, setCDKMatrixLLChar, setCDKMatrixLRChar, setCDKMatrixPostProcess, setCDKMatrixPreProcess, setCDKMatrixULChar, setCDKMatrixURChar, setCDKMatrixVerticalChar(3)
curses matrix widget.
cgels.f(3)
cgelsd.f(3)
cgelss.f(3)
cgelsx.f(3)
cgelsy.f(3)
cgglse.f(3)
CGI::Application::Plugin::Authentication::Display::Basic(3)
XHTML compliant no frills login display driver
CGI::Ex::Die(3)
A CGI::Carp::FatalsToBrowser type utility.
CGI::Utils(3)
Utilities for retrieving information through the Common Gateway Interface
CGI::Utils::UploadFile, CW(3)
CGI::Utils::UploadFile - R
cgiRedirect(3)
Redirect the browser somewhere else
charnames(3)
access to Unicode character names and named character sequences; also define character names
Chemistry::File::VRML(3)
Generate VRML models for molecules
clals0.f(3)
clalsa.f(3)
clalsd.f(3)
Class::BlackHole(3)
base class to treat unhandled method calls as no-ops
Class::Default(3)
Static calls apply to a default instantiation
Class::MakeMethods::Evaled(3)
Make methods with simple string evals
Class::Std::Utils(3)
Utility subroutines for building "inside-out" objects
Class::WhiteHole(3)
base class to treat unhandled method calls as errors
Class::Workflow::Transition::Validate(3)
Provide a hook for validating a transition (conditionals, input validators, etc).
CMS_add0_cert, CMS_add0_crl, CMS_add1_cert, CMS_add1_crl, CMS_get1_certs, CMS_get1_crls(3)
CMS certificate and CRL utility functions
CMS_add0_cert, CMS_add0_crl, CMS_add1_cert, CMS_add1_crl, CMS_get1_certs, CMS_get1_crls(3)
COLORS, COLOR_PAIRS, COLS, curscr, ESCDELAY, LINES, newscr, stdscr, TABSIZE, curs_variables(3, 3X, 3x)
curses global variables
Config::Model(3)
Create tools to validate, migrate and edit configuration files
Config::Model::Lister(3)
List available models and applications
Config::Model::models::Fstab(3)
Configuration class Fstab
Config::Model::models::Fstab::FsLine(3)
Configuration class Fstab::FsLine
Config::Model::models::Multistrap(3)
Configuration class Multistrap
Config::Model::models::Multistrap::Section(3)
Configuration class Multistrap::Section
Config::Model::models::PopCon(3)
Configuration class PopCon
Config::Model::Role::Grab(3)
Role to grab data from elsewhere in the tree
Config::Model::Utils::GenClassPod(3)
generate pod documentation from configuration models
config_is_hooked(3)
Tells if a config section has custom hooks. Allegro game programming library.
constant::boolean(3)
Define TRUE and FALSE constants.
Convert::NLS_DATE_FORMAT(3)
Convert Oracle NLS_DATE_FORMAT <-> strftime Format Strings
Coro::Signal(3)
thread signals (binary semaphores)
CosEventChannelAdmin_ProxyPullSupplier(3)
This module implements a ProxyPullSupplier interface which acts as a middleman between pull consumer and the event channel.
CosNotifyChannelAdmin_ProxyPullSupplier(3)
This module implements the OMG CosNotifyChannelAdmin::ProxyPullSupplier interface.
CosNotifyChannelAdmin_SequenceProxyPullSupplier(3)
This module implements the OMG CosNotifyChannelAdmin::SequenceProxyPullSupplier interface.
CosNotifyChannelAdmin_StructuredProxyPullSupplier(3)
This module implements the OMG CosNotifyChannelAdmin::StructuredProxyPullSupplier interface.
CPAN::HandleConfig(3)
internal configuration handling for CPAN.pm "CLASS->safe_quote ITEM" Quotes an item to become safe against spaces in shell interpolation. An item is enclosed in double quotes if: CW - the item contains spaces in the middle - the item does not start with a quote R This happens to avoid shell interpolation problems when whitespace is present in directory names. This method uses "commands_quote" to determine the correct quote. If "commands_quote" is a space, no quoting will take place. if it starts and ends with the same quote character: leave it as it is if it contains no whitespace: leave it as it is if it contains whitespace, then if it contains quotes: better leave it as it is else: quote it with the correct quote type for the box we're on
CPAN::Perl::Releases(3)
Mapping Perl releases on CPAN to the location of the tarballs
CPANPLUS::Internals(3)
CPANPLUS internals
CPANPLUS::Internals::Extract(3)
internals for archive extraction
CPANPLUS::Internals::Fetch(3)
internals for fetching files
CPANPLUS::Internals::Report(3)
internals for sending test reports
CPANPLUS::Internals::Search(3)
internals for searching for modules
CPANPLUS::Internals::Source(3)
internals for updating source files
CPANPLUS::Internals::Source::Memory(3)
In memory implementation $cb->__memory_retrieve_source(name => $name, [path => $path, uptodate => BOOL, verbose => BOOL]) This method retrieves a storabled tree identified by $name. It takes the following arguments: name 4 The internal name for the source file to retrieve. uptodate 4 A flag indicating whether the file-cache is up-to-date or not. path 4 The absolute path to the directory holding the source files. verbose 4 A boolean flag indicating whether or not to be verbose. Will get information from the config file by default. Returns a tree on success, false on failure. $cb->__memory_save_source([verbose => BOOL, path => $path]) This method saves all the parsed trees in storabled format if "Storable" is available. It takes the following arguments: path 4 The absolute path to the directory holding the source files. verbose 4 A boolean flag indicating whether or not to be verbose. Will get information from the config file by default. Returns true on success, false on failure.
CPANPLUS::Internals::Source::SQLite(3)
SQLite implementation
CPANPLUS::Internals::Utils(3)
convenience functions for CPANPLUS
CPANPLUS::Shell(3)
base class for CPANPLUS shells
create_color_table(3)
Fills a color mapping table for customised effects. Allegro game programming library.
create_light_table(3)
Fills a color mapping table for lighting effects. Allegro game programming library.
create_trans_table(3)
Fills a color mapping table for translucency effects. Allegro game programming library.
Crypt::OpenSSL::CA::Resources(3)
A bibliography of documentations and tools that I found helpful for implementing X509 PKIs in Perl over all these years.
CSS::SAC::Selector::Conditional(3)
SAC ConditionalSelector
curl_multi_info_read(3)
read multi stack informationals
curl_multi_wait(3)
polls on all easy handles in a multi handle
CURLINFO_CERTINFO(3)
get the TLS certificate chain
CURLINFO_TLS_SESSION(3)
get TLS session info
CURLINFO_TLS_SSL_PTR, CURLINFO_TLS_SESSION(3)
get TLS session info
CURLOPT_FTPSSLAUTH(3)
set order in which to attempt TLS vs SSL when using FTP
CURLOPT_PROTOCOLS(3)
set allowed protocols
CURLOPT_PROXY_SSL_CIPHER_LIST(3)
specify ciphers to use for proxy TLS
CURLOPT_PROXY_SSLKEY(3)
specify private keyfile for TLS and SSL proxy client cert
CURLOPT_PROXY_SSLVERSION(3)
set preferred proxy TLS/SSL version
CURLOPT_PROXY_TLSAUTH_PASSWORD(3)
password to use for proxy TLS authentication
CURLOPT_PROXY_TLSAUTH_TYPE(3)
set proxy TLS authentication methods
CURLOPT_PROXY_TLSAUTH_USERNAME(3)
user name to use for proxy TLS authentication
CURLOPT_REDIR_PROTOCOLS(3)
set protocols allowed to redirect to
CURLOPT_SSL_CIPHER_LIST(3)
specify ciphers to use for TLS
CURLOPT_SSL_CTX_FUNCTION(3)
SSL context callback for OpenSSL, wolfSSL/CyaSSL or mbedTLS
CURLOPT_SSL_FALSESTART(3)
enable TLS false start
CURLOPT_SSLKEY(3)
specify private keyfile for TLS and SSL client cert
CURLOPT_SSLVERSION(3)
set preferred TLS/SSL version
CURLOPT_TLSAUTH_PASSWORD(3)
password to use for TLS authentication
CURLOPT_TLSAUTH_TYPE(3)
set TLS authentication methods
CURLOPT_TLSAUTH_USERNAME(3)
user name to use for TLS authentication
CURLOPT_UNRESTRICTED_AUTH(3)
send credentials to other hosts too
CURLOPT_USE_SSL(3)
request using SSL / TLS for the transfer
current, nx::current(3)
Return information about the method callstack
curs_variables, COLORS, COLOR_PAIRS, COLS, curscr, ESCDELAY, LINES, newscr, stdscr, TABSIZE(3, 3X)
curses global variables
d2i_X509, d2i_ACCESS_DESCRIPTION, d2i_ASIdentifierChoice, d2i_ASIdentifiers, d2i_ASIdOrRange, d2i_ASN1_BIT_STRING, d2i_ASN1_BMPSTRING, d2i_ASN1_ENUMERATED, d2i_ASN1_GENERALIZEDTIME, d2i_ASN1_GENERALSTRING, d2i_ASN1_IA5STRING, d2i_ASN1_INTEGER, d2i_ASN1_NULL, d2i_ASN1_OBJECT, d2i_ASN1_OCTET_STRING, d2i_ASN1_PRINTABLE, d2i_ASN1_PRINTABLESTRING, d2i_ASN1_SEQUENCE_ANY, d2i_ASN1_SET_ANY, d2i_ASN1_T61STRING, d2i_ASN1_TIME, d2i_ASN1_TYPE, d2i_ASN1_UINTEGER, d2i_ASN1_UNIVERSALSTRING, d2i_ASN1_UTCTIME, d2i_ASN1_UTF8STRING, d2i_ASN1_VISIBLESTRING, d2i_ASRange, d2i_AUTHORITY_INFO_ACCESS, d2i_AUTHORITY_KEYID, d2i_BASIC_CONSTRAINTS, d2i_CERTIFICATEPOLICIES, d2i_CMS_bio, d2i_CMS_ContentInfo, d2i_CMS_ReceiptRequest, d2i_CRL_DIST_POINTS, d2i_DHxparams, d2i_DIRECTORYSTRING, d2i_DISPLAYTEXT, d2i_DIST_POINT, d2i_DIST_POINT_NAME, d2i_DSA_PUBKEY_bio, d2i_DSA_PUBKEY_fp, d2i_DSA_SIG, d2i_DSAparams, d2i_DSAPrivateKey, d2i_DSAPrivateKey_bio, d2i_DSAPrivateKey_fp, d2i_DSAPublicKey, d2i_EC_PUBKEY, d2i_EC_PUBKEY_bio, d2i_EC_PUBKEY_fp, d2i_ECParameters, d2i_ECPKParameters, d2i_ECPrivateKey, d2i_ECPrivateKey_bio, d2i_ECPrivateKey_fp, d2i_EDIPARTYNAME, d2i_ESS_CERT_ID, d2i_ESS_ISSUER_SERIAL, d2i_ESS_SIGNING_CERT, d2i_EXTENDED_KEY_USAGE, d2i_GENERAL_NAME, d2i_GENERAL_NAMES, d2i_IPAddressChoice, d2i_IPAddressFamily, d2i_IPAddressOrRange, d2i_IPAddressRange, d2i_ISSUING_DIST_POINT, d2i_NETSCAPE_CERT_SEQUENCE, d2i_NETSCAPE_SPKAC, d2i_NETSCAPE_SPKI, d2i_NOTICEREF, d2i_OCSP_BASICRESP, d2i_OCSP_CERTID, d2i_OCSP_CERTSTATUS, d2i_OCSP_CRLID, d2i_OCSP_ONEREQ, d2i_OCSP_REQINFO, d2i_OCSP_REQUEST, d2i_OCSP_RESPBYTES, d2i_OCSP_RESPDATA, d2i_OCSP_RESPID, d2i_OCSP_RESPONSE, d2i_OCSP_REVOKEDINFO, d2i_OCSP_SERVICELOC, d2i_OCSP_SIGNATURE, d2i_OCSP_SINGLERESP, d2i_OTHERNAME, d2i_PBE2PARAM, d2i_PBEPARAM, d2i_PBKDF2PARAM, d2i_PKCS12, d2i_PKCS12_BAGS, d2i_PKCS12_bio, d2i_PKCS12_fp, d2i_PKCS12_MAC_DATA, d2i_PKCS12_SAFEBAG, d2i_PKCS7, d2i_PKCS7_bio, d2i_PKCS7_DIGEST, d2i_PKCS7_ENC_CONTENT, d2i_PKCS7_ENCRYPT, d2i_PKCS7_ENVELOPE, d2i_PKCS7_fp, d2i_PKCS7_ISSUER_AND_SERIAL, d2i_PKCS7_RECIP_INFO, d2i_PKCS7_SIGN_ENVELOPE, d2i_PKCS7_SIGNED, d2i_PKCS7_SIGNER_INFO, d2i_PKCS8_bio, d2i_PKCS8_fp, d2i_PKCS8_PRIV_KEY_INFO, d2i_PKCS8_PRIV_KEY_INFO_bio, d2i_PKCS8_PRIV_KEY_INFO_fp, d2i_PKEY_USAGE_PERIOD, d2i_POLICYINFO, d2i_POLICYQUALINFO, d2i_PROXY_CERT_INFO_EXTENSION, d2i_PROXY_POLICY, d2i_PublicKey, d2i_RSA_OAEP_PARAMS, d2i_RSA_PSS_PARAMS, d2i_RSA_PUBKEY, d2i_RSA_PUBKEY_bio, d2i_RSA_PUBKEY_fp, d2i_RSAPrivateKey, d2i_RSAPrivateKey_bio, d2i_RSAPrivateKey_fp, d2i_RSAPublicKey, d2i_RSAPublicKey_bio, d2i_RSAPublicKey_fp, d2i_SCT_LIST, d2i_SXNET, d2i_SXNETID, d2i_TS_ACCURACY, d2i_TS_MSG_IMPRINT, d2i_TS_MSG_IMPRINT_bio, d2i_TS_MSG_IMPRINT_fp, d2i_TS_REQ, d2i_TS_REQ_bio, d2i_TS_REQ_fp, d2i_TS_RESP, d2i_TS_RESP_bio, d2i_TS_RESP_fp, d2i_TS_STATUS_INFO, d2i_TS_TST_INFO, d2i_TS_TST_INFO_bio, d2i_TS_TST_INFO_fp, d2i_USERNOTICE, d2i_X509_ALGOR, d2i_X509_ALGORS, d2i_X509_ATTRIBUTE, d2i_X509_CERT_AUX, d2i_X509_CINF, d2i_X509_CRL, d2i_X509_CRL_bio, d2i_X509_CRL_fp, d2i_X509_CRL_INFO, d2i_X509_EXTENSION, d2i_X509_EXTENSIONS, d2i_X509_NAME, d2i_X509_NAME_ENTRY, d2i_X509_PUBKEY, d2i_X509_REQ, d2i_X509_REQ_bio, d2i_X509_REQ_fp, d2i_X509_REQ_INFO, d2i_X509_REVOKED, d2i_X509_SIG, d2i_X509_VAL, i2d_ACCESS_DESCRIPTION, i2d_ASIdentifierChoice, i2d_ASIdentifiers, i2d_ASIdOrRange, i2d_ASN1_bio_stream, i2d_ASN1_BIT_STRING, i2d_ASN1_BMPSTRING, i2d_ASN1_ENUMERATED, i2d_ASN1_GENERALIZEDTIME, i2d_ASN1_GENERALSTRING, i2d_ASN1_IA5STRING, i2d_ASN1_INTEGER, i2d_ASN1_NULL, i2d_ASN1_OBJECT, i2d_ASN1_OCTET_STRING, i2d_ASN1_PRINTABLE, i2d_ASN1_PRINTABLESTRING, i2d_ASN1_SEQUENCE_ANY, i2d_ASN1_SET_ANY, i2d_ASN1_T61STRING, i2d_ASN1_TIME, i2d_ASN1_TYPE, i2d_ASN1_UNIVERSALSTRING, i2d_ASN1_UTCTIME, i2d_ASN1_UTF8STRING, i2d_ASN1_VISIBLESTRING, i2d_ASRange, i2d_AUTHORITY_INFO_ACCESS, i2d_AUTHORITY_KEYID, i2d_BASIC_CONSTRAINTS, i2d_CERTIFICATEPOLICIES, i2d_CMS_bio, i2d_CMS_ContentInfo, i2d_CMS_ReceiptRequest, i2d_CRL_DIST_POINTS, i2d_DHxparams, i2d_DIRECTORYSTRING, i2d_DISPLAYTEXT, i2d_DIST_POINT, i2d_DIST_POINT_NAME, i2d_DSA_PUBKEY_bio, i2d_DSA_PUBKEY_fp, i2d_DSA_SIG, i2d_DSAparams, i2d_DSAPrivateKey, i2d_DSAPrivateKey_bio, i2d_DSAPrivateKey_fp, i2d_DSAPublicKey, i2d_EC_PUBKEY, i2d_EC_PUBKEY_bio, i2d_EC_PUBKEY_fp, i2d_ECParameters, i2d_ECPKParameters, i2d_ECPrivateKey, i2d_ECPrivateKey_bio, i2d_ECPrivateKey_fp, i2d_EDIPARTYNAME, i2d_ESS_CERT_ID, i2d_ESS_ISSUER_SERIAL, i2d_ESS_SIGNING_CERT, i2d_EXTENDED_KEY_USAGE, i2d_GENERAL_NAME, i2d_GENERAL_NAMES, i2d_IPAddressChoice, i2d_IPAddressFamily, i2d_IPAddressOrRange, i2d_IPAddressRange, i2d_ISSUING_DIST_POINT, i2d_NETSCAPE_CERT_SEQUENCE, i2d_NETSCAPE_SPKAC, i2d_NETSCAPE_SPKI, i2d_NOTICEREF, i2d_OCSP_BASICRESP, i2d_OCSP_CERTID, i2d_OCSP_CERTSTATUS, i2d_OCSP_CRLID, i2d_OCSP_ONEREQ, i2d_OCSP_REQINFO, i2d_OCSP_REQUEST, i2d_OCSP_RESPBYTES, i2d_OCSP_RESPDATA, i2d_OCSP_RESPID, i2d_OCSP_RESPONSE, i2d_OCSP_REVOKEDINFO, i2d_OCSP_SERVICELOC, i2d_OCSP_SIGNATURE, i2d_OCSP_SINGLERESP, i2d_OTHERNAME, i2d_PBE2PARAM, i2d_PBEPARAM, i2d_PBKDF2PARAM, i2d_PKCS12, i2d_PKCS12_BAGS, i2d_PKCS12_bio, i2d_PKCS12_fp, i2d_PKCS12_MAC_DATA, i2d_PKCS12_SAFEBAG, i2d_PKCS7, i2d_PKCS7_bio, i2d_PKCS7_DIGEST, i2d_PKCS7_ENC_CONTENT, i2d_PKCS7_ENCRYPT, i2d_PKCS7_ENVELOPE, i2d_PKCS7_fp, i2d_PKCS7_ISSUER_AND_SERIAL, i2d_PKCS7_NDEF, i2d_PKCS7_RECIP_INFO, i2d_PKCS7_SIGN_ENVELOPE, i2d_PKCS7_SIGNED, i2d_PKCS7_SIGNER_INFO, i2d_PKCS8_bio, i2d_PKCS8_fp, i2d_PKCS8_PRIV_KEY_INFO, i2d_PKCS8_PRIV_KEY_INFO_bio, i2d_PKCS8_PRIV_KEY_INFO_fp, i2d_PKCS8PrivateKeyInfo_bio, i2d_PKCS8PrivateKeyInfo_fp, i2d_PKEY_USAGE_PERIOD, i2d_POLICYINFO, i2d_POLICYQUALINFO, i2d_PROXY_CERT_INFO_EXTENSION, i2d_PROXY_POLICY, i2d_PublicKey, i2d_RSA_OAEP_PARAMS, i2d_RSA_PSS_PARAMS, i2d_RSA_PUBKEY, i2d_RSA_PUBKEY_bio, i2d_RSA_PUBKEY_fp, i2d_RSAPrivateKey, i2d_RSAPrivateKey_bio, i2d_RSAPrivateKey_fp, i2d_RSAPublicKey, i2d_RSAPublicKey_bio, i2d_RSAPublicKey_fp, i2d_SCT_LIST, i2d_SXNET, i2d_SXNETID, i2d_TS_ACCURACY, i2d_TS_MSG_IMPRINT, i2d_TS_MSG_IMPRINT_bio, i2d_TS_MSG_IMPRINT_fp, i2d_TS_REQ, i2d_TS_REQ_bio, i2d_TS_REQ_fp, i2d_TS_RESP, i2d_TS_RESP_bio, i2d_TS_RESP_fp, i2d_TS_STATUS_INFO, i2d_TS_TST_INFO, i2d_TS_TST_INFO_bio, i2d_TS_TST_INFO_fp, i2d_USERNOTICE, i2d_X509, i2d_X509_ALGOR, i2d_X509_ALGORS, i2d_X509_ATTRIBUTE, i2d_X509_CERT_AUX, i2d_X509_CINF, i2d_X509_CRL, i2d_X509_CRL_bio, i2d_X509_CRL_fp, i2d_X509_CRL_INFO, i2d_X509_EXTENSION, i2d_X509_EXTENSIONS, i2d_X509_NAME, i2d_X509_NAME_ENTRY, i2d_X509_PUBKEY, i2d_X509_REQ, i2d_X509_REQ_bio, i2d_X509_REQ_fp, i2d_X509_REQ_INFO, i2d_X509_REVOKED, i2d_X509_SIG, i2d_X509_VAL, d2i_ASN1_TIME_new, d2i_DSA_PUBKEY, d2i_ECPKParameters_bio, d2i_ECPKParameters_fp, d2i_ECPrivate_key, d2i_X509_bio, d2i_X509_fp, ECParameters_dup, ECParameters_print, ECParameters_print_fp, i2d_ASN1_TIME_new, i2d_DSA_PUBKEY, i2d_ECPK_PUBKEY_fp, i2d_ECPKParameters_bio, i2d_ECPKParameters_fp, i2d_ECPKPrivateKey_fp, i2d_X509_bio, i2d_X509_fp, i2o_ECPublicKey, o2i_ECPublicKey, X509_NAME_hash(3)
Dancer2::FileUtils(3)
File utility helpers
Dancer2::Plugin::Interchange6::Routes(3)
Routes for Interchange6 Shop Machine shop_setup_routes The following routes are provided by this plugin. Active routes are automatically installed by the "shop_setup_routes" keyword: cart ("/cart") 4 Route for displaying and updating the cart. checkout ("/checkout") 4 Route for the checkout process (not active and not recommended). login ("/login") 4 Login route. logout ("/logout") 4 Logout route. navigation 4 Route for displaying navigation pages, for example categories and menus. The number of products shown on the navigation page can be configured with the "records" option: CW plugins: Interchange6::Routes: navigation: records: 20 R product 4 Route for displaying products. CONFIGURATION The template for each route type can be configured: CW plugins: Interchange6::Routes: account: login: template: login uri: login success_uri: logout: template: logout uri: logout cart: template: cart uri: cart active: 1 checkout: template: checkout uri: checkout active: 0 navigation: template: listing records: 0 product: template: product R This sample configuration shows the current defaults. HOOKS The following hooks are available to manipulate the values passed to the templates: before_product_display 4 The hook sub receives a hash reference, where the Product object is the value of the "product" key. before_cart_display 4 0 before_checkout_display 4 before_navigation_search 4 This hook is called if a navigation uri is requested and before product search queries are generated. The hook sub receives the navigation data as hash reference: 4 navigation 4 Navigation object. page 4 Page number found at end of URI or 1 if no page number found. template 4 Name of template. 4 The navigation hash reference can be modified inside the hook and all changes will be visible to the navigation route (and also the template) after the hook returns. before_navigation_display 4 The hook sub receives the navigation data as hash reference: 4 navigation 4 Navigation object. products 4 Product listing for this navigation item. The product listing is generated using "listing" in Interchange6::Schema::Result::Product. pager 4 Data::Page object for "products". To get the full count of products call "total_entries" on the Data::Page object. template 4 Name of template. In order to use another template, change the value in the hashref. CW hook 'before_navigation_display' => sub { my $navigation_data = shift; if ($navigation_data->{navigation}->uri =~ /^admin/) { $navigation_data->{template} = 'admin_listing'; } }; R 4 before_login_display 4 EXAMPLES Disable parts of layout on the login view: CW hook 'before_login_display' => sub { my $tokens = shift; $tokens->{layout_noleft} = 1; $tokens->{layout_noright} = 1; }; R
Dancer::Debug(3)
Extend Plack::Middleware::Debug with some specific panels for Dancer
Dancer::FileUtils(3)
helper providing file utilities
dane_query_tlsa(3)
API function
dane_query_to_raw_tlsa(3)
API function
dane_raw_tlsa(3)
API function
Data::Dump::Trace(3)
Helpers to trace function and method calls
Data::Float(3)
details of the floating point data type
Data::Integer(3)
details of the native integer data type
Data::Phrasebook::Generic(3)
Base class for Phrasebook Models
Data::Range::Compare::Cookbook(3)
Tutorials and Recipes
Data::Util::Error(3)
Deals with class-specific error handlers in Data::Util
Data::Validator::Role::Method(3)
Deals with the invocant of methods
Data::Validator::Role::Sequenced(3)
Deals with sequenced parameters
Data::Validator::Role::SmartSequenced(3)
Deals with sequenced and named parameters
Data::Validator::Role::StrictSequenced(3)
Deals with sequenced parameters.
Date::DayOfWeek::Nails(3)
Cut your nails on a Friday, cut them for woe ...
DateTime::Format::Natural::Utils(3)
Handy utility methods
DateTime::Locale::cy(3)
Locale data examples for the Welsh (cy) locale
DateTime::Locale::cy_GB(3)
Locale data examples for the Welsh United Kingdom (cy-GB) locale
DateTime::Locale::en_LS(3)
Locale data examples for the English Lesotho (en-LS) locale
DateTime::Locale::wae(3)
Locale data examples for the Walser (wae) locale
DateTime::Locale::wae_CH(3)
Locale data examples for the Walser Switzerland (wae-CH) locale
DateTime::TimeZone::OlsonDB(3)
An object to represent an Olson time zone database
DBIx::Class::Carp(3)
Provides advanced Carp::Clan-like warning functions for DBIx::Class internals
DBIx::Class::Manual::Troubleshooting(3)
Got a problem? Shoot it. "Can't locate storage blabla" You're trying to make a query on a non-connected schema. Make sure you got the current resultset from $schema->resultset('Artist') on a schema object you got back from connect(). Tracing SQL The "DBIC_TRACE" environment variable controls SQL tracing, so to see what is happening try CW export DBIC_TRACE=1 R Alternatively use the "storage->debug" class method:- CW $schema->storage->debug(1); R To send the output somewhere else set debugfh:- CW $schema->storage->debugfh(IO::File->new('/tmp/trace.out', 'w')); R Alternatively you can do this with the environment variable, too:- CW export DBIC_TRACE="1=/tmp/trace.out" R Can't locate method result_source_instance For some reason the table class in question didn't load fully, so the ResultSource object for it hasn't been created. Debug this class in isolation, then try loading the full schema again. Can't get last insert ID under Postgres with serial primary keys Older DBI and DBD::Pg versions do not handle "last_insert_id" correctly, causing code that uses auto-incrementing primary key columns to fail with a message such as: CW Can't get last insert id at /.../DBIx/Class/Row.pm line 95 R In particular the RHEL 4 and FC3 Linux distributions both ship with combinations of DBI and DBD::Pg modules that do not work correctly. DBI version 1.50 and DBD::Pg 1.43 are known to work. Can't locate object method "source_name" via package There's likely a syntax error in the table class referred to elsewhere in this error message. In particular make sure that the package declaration is correct. For example, for a schema " MySchema " you need to specify a fully qualified namespace: " package MySchema::MyTable; ". syntax error at or near "<something>" ... This can happen if you have a relation whose name is a word reserved by your database, e.g. "user": CW package My::Schema::User; ... __PACKAGE__->table('users'); __PACKAGE__->add_columns(qw/ id name /); __PACKAGE__->set_primary_key('id'); ... 1; package My::Schema::ACL; ... __PACKAGE__->table('acl'); __PACKAGE__->add_columns(qw/ user_id /); __PACKAGE__->belongs_to( 'user' => 'My::Schema::User', 'user_id' ); ... 1; $schema->resultset('ACL')->search( {}, { join => [qw/ user /], '+select' => [ 'user.name' ] } ); R The SQL generated would resemble something like: CW SELECT me.user_id, user.name FROM acl me JOIN users user ON me.user_id = user.id R If, as is likely, your database treats "user" as a reserved word, you'd end up with the following errors: 1) syntax error at or near "." - due to "user.name" in the SELECT clause 2) syntax error at or near "user" - due to "user" in the JOIN clause The solution is to enable quoting - see "Setting quoting for the generated SQL" in DBIx::Class::Manual::Cookbook for details. column "foo DESC" does not exist ... This can happen if you are still using the obsolete order hack, and also happen to turn on SQL-quoting. CW $rs->search( {}, { order_by => [ 'name DESC' ] } ); R Since DBIx::Class >= 0.08100 and SQL::Abstract >= 1.50 the above should be written as: CW $rs->search( {}, { order_by => { -desc => 'name' } } ); R For more ways to express order clauses refer to "ORDER BY CLAUSES" in SQL::Abstract Perl Performance Issues on Red Hat Systems There is a problem with slow performance of certain DBIx::Class operations using the system perl on some Fedora and Red Hat Enterprise Linux system (as well as their derivative distributions such as Centos, White Box and Scientific Linux). Distributions affected include Fedora 5 through to Fedora 8 and RHEL5 up to and including RHEL5 Update 2. Fedora 9 (which uses perl 5.10) has never been affected - this is purely a perl 5.8.8 issue. As of September 2008 the following packages are known to be fixed and so free of this performance issue (this means all Fedora and RHEL5 systems with full current updates will not be subject to this problem):- CW Fedora 8 - perl-5.8.8-41.fc8 RHEL5 - perl-5.8.8-15.el5_2.1 R This issue is due to perl doing an exhaustive search of blessed objects under certain circumstances. The problem shows up as performance degradation exponential to the number of DBIx::Class result objects in memory, so can be unnoticeable with certain data sets, but with huge performance impacts on other datasets. A pair of tests for susceptibility to the issue and performance effects of the bless/overload problem can be found in the DBIx::Class test suite, in the "t/99rh_perl_perf_bug.t" file. Further information on this issue can be found in <https://bugzilla.redhat.com/show_bug.cgi?id=379791>, <https://bugzilla.redhat.com/show_bug.cgi?id=460308> and <http://rhn.redhat.com/errata/RHBA-2008-0876.html> Excessive Memory Allocation with TEXT/BLOB/etc. Columns and Large LongReadLen It has been observed, using DBD::ODBC, that creating a DBIx::Class::Row object which includes a column of data type TEXT/BLOB/etc. will allocate LongReadLen bytes. This allocation does not leak, but if LongReadLen is large in size, and many such result objects are created, e.g. as the output of a ResultSet query, the memory footprint of the Perl interpreter can grow very large. The solution is to use the smallest practical value for LongReadLen.
DBIx::Class::Migration(3)
Use the best tools together for sane database migrations
DBIx::Class::Migration::MySQLSandbox(3)
Autocreate a mysql sandbox
DBIx::Class::Migration::PostgresqlSandbox(3)
Autocreate a postgresql sandbox
DBIx::Class::Migration::Script(3)
Tools to manage database Migrations
DBIx::Class::Migration::Script::Help::help(3)
help command details
DBIx::Class::Storage::DBI::ADO::Microsoft_SQL_Server::Cursor(3)
Remove trailing NULLs in binary data and normalize GUIDs for MSSQL over ADO
DBIx::MySQLSequence(3)
Proper and correct (emulated) sequence support for MySQL
DBIx::SQLEngine::Criteria::LiteralSQL(3)
Criteria with SQL snippets
DBIx::TableHash(3)
Tie a hash to a mysql table + SQL utils
dblink_cancel_query(3)
cancels any active query on the named connection
DBM::Deep::Internals(3)
Out of date documentation on DBM::Deep internals
Devel::BeginLift(3)
make selected sub calls evaluate at compile time
Devel::CallSeq, CallSeq(3)
produces call sequence outlines (like dprofpp -T)
Devel::Callsite(3)
Devel::Callsite
Devel::Constants(3)
translates constants back to named symbols
Devel::EvalContext(3)
Save lexicals and hints between calls to eval
Devel::GlobalDestruction(3)
Provides function returning the equivalent of "${^GLOBAL_PHASE} eq 'DESTRUCT'" for older perls.
Devel::MAT::Tool::Callstack, "Devel::MAT::Tool::Callstack"(3)
display the call stack
Devel::NYTProf::Core(3)
load internals of Devel::NYTProf
Devel::OOCallSeq, OOCallSeq(3)
produces call sequence outlines (like dprofpp -T)
Devel::REPL::Plugin::CompletionDriver::Globals(3)
Complete global variables, packages, namespaced functions
Devel::StackTrace::WithLexicals(3)
Devel::StackTrace + PadWalker
Devel::TraceCalls(3)
Track calls to subs, classes and object instances
Devel::TraceFuncs(3)
trace function calls as they happen.
dgels.f(3)
dgelsd.f(3)
dgelss.f(3)
dgelsx.f(3)
dgelsy.f(3)
dgglse.f(3)
Digest::MD5::File(3)
Perl extension for getting MD5 sums for files and urls.
Digest::Nilsimsa(3)
Perl version of Nilsimsa code
digraph_utils(3)
Algorithms for Directed Graphs
Dir::Watch(3)
Watches the current directory for file additions or removals.
Dist::Joseki(3)
Tools for the prolific module author
Dist::Zilla::Plugin::MakeMaker(3)
build a Makefile.PL that uses ExtUtils::MakeMaker
Dist::Zilla::Role::Stash::Login(3)
a stash with username/password credentials
Dist::Zilla::Stash::PAUSE(3)
a stash of your PAUSE credentials
Dist::Zilla::Util::AuthorDeps(3)
Utils for listing your distribution's author dependencies
dlals0.f(3)
dlalsa.f(3)
dlalsd.f(3)
dlopen, dlclose, dlerror, dlfunc, dlsym, fdlopen(3)
programmatic interface to the dynamic linker
dlopen, dlclose, dlerror, dlsym(3)
????????????????????????????????????????
DNSCheck(3)
DNS Check Tools
DR::Tarantool::RealSyncClient(3)
a synchronous driver for Tarantool/Box <http://tarantool.org>
draw_character_ex(3)
Draws non transparent pixels of the sprite with a color. Allegro game programming library.
DTLSv1_listen(3)
listen for incoming DTLS connections
DtMsgLogSetHandler(3, library call)
installs an alternate message logging handler
DtPrintFillSetupData(3, library call)
obtains X printer connection information
DtSearchInit(3, library call)
Initialize the DtSearch online API for subsequent calls
dwarf_dealloc, dwarf_fde_cie_list_dealloc, dwarf_funcs_dealloc, dwarf_globals_dealloc, dwarf_pubtypes_dealloc, dwarf_ranges_dealloc, dwarf_srclines_dealloc, dwarf_types_dealloc, dwarf_vars_dealloc, dwarf_weaks_dealloc(3)
release resources
dwarf_get_globals, dwarf_global_cu_offset, dwarf_global_die_offset, dwarf_global_name_offsets, dwarf_globname(3)
retrieve information about global objects
dwarf_get_macro_details(3)
retrieve macro information
dwarf_get_weaks, dwarf_weak_cu_offset, dwarf_weak_die_offset, dwarf_weak_name_offsets, dwarf_weakname(3)
retrieve information about weak symbols
EBook::Tools(3)
Object class for manipulating and generating E-books
EBook::Tools::BISG(3)
Class for downloading information from the Book Industry Study Group webpages
EBook::Tools::EReader(3)
Palm::PDB handler for manipulating the Fictionwise/PeanutPress eReader format.
EBook::Tools::IMP(3)
Object class for manipulating the SoftBook/GEB/REB/eBookWise ".IMP" and ".RES" e-book formats
EBook::Tools::LZSS(3)
Lempel-Ziv-Storer-Szymanski compression and decompression
EBook::Tools::Mobipocket(3)
Palm::PDB handler for manipulating the Mobipocket format.
EBook::Tools::MSReader(3)
Helper code for working with Microsoft Reader (.lit) e-books.
EBook::Tools::PalmDoc(3)
Palm::PDB handler for manipulating the PalmDoc/PilotDoc/AportisDoc format
EBook::Tools::Unpack(3)
Object class for unpacking e-book files into their component parts and metadata
Email::Abstract::EmailSimple(3)
Email::Abstract wrapper for Email::Simple
Email::Folder::Ezmlm(3)
reads raw RFC822 mails from an ezmlm archive
Email::Folder::Maildir(3)
reads raw RFC822 mails from a maildir
Email::Folder::Mbox(3)
reads raw RFC822 mails from an mbox file
Email::Folder::MH(3)
reads raw RFC822 mails from an mh folder
Email::Folder::Reader(3)
reads raw RFC822 mails from a box
Email::FolderType::Net(3)
Recognize folder types for network based message protocols.
Email::Send::Test(3)
Captures emails sent via Email::Send for testing
Email::Sender::Transport::SMTP::TLS(3)
Email::Sender with Net::SMTP::TLS (Eg. Gmail)
Email::Stuffer(3)
A more casual approach to creating and sending Email:: emails
erl_tidy(3)
Tidies and pretty-prints Erlang source code, removing unused functions, updating obsolete constructs and function calls, etc.
Error::TypeTiny::Assertion(3)
exception when a value fails a type constraint
Eval::WithLexicals(3)
pure perl eval with persistent lexical variables
Eval::WithLexicals::WithHintPersistence(3)
Persist compile hints between evals
EVP_PKEY_CTX_set_tls1_prf_md, EVP_PKEY_CTX_add1_tls1_prf_seed, EVP_PKEY_CTX_set1_tls1_prf_secret(3)
TLS PRF key derivation algorithm
Excel::Writer::XLSX(3)
Create a new file in the Excel 2007+ XLSX format.
Excel::Writer::XLSX::Chart, Chart(3)
A class for writing Excel Charts.
Excel::Writer::XLSX::Chart::Area, Area(3)
A class for writing Excel Area charts.
Excel::Writer::XLSX::Chart::Bar, Bar(3)
A class for writing Excel Bar charts.
Excel::Writer::XLSX::Chart::Column, Column(3)
A class for writing Excel Column charts.
Excel::Writer::XLSX::Chart::Doughnut, Doughnut(3)
A class for writing Excel Doughnut charts.
Excel::Writer::XLSX::Chart::Line, Line(3)
A class for writing Excel Line charts.
Excel::Writer::XLSX::Chart::Pie, Pie(3)
A class for writing Excel Pie charts.
Excel::Writer::XLSX::Chart::Radar, Radar(3)
A class for writing Excel Radar charts.
Excel::Writer::XLSX::Chart::Scatter, Scatter(3)
A class for writing Excel Scatter charts.
Excel::Writer::XLSX::Chart::Stock, Stock(3)
A class for writing Excel Stock charts.
Excel::Writer::XLSX::Chartsheet, Chartsheet(3)
A class for writing the Excel XLSX Chartsheet files.
Excel::Writer::XLSX::Drawing, Drawing(3)
A class for writing the Excel XLSX drawing.xml file.
Excel::Writer::XLSX::Examples, Examples(3)
Excel::Writer::XLSX example programs.
Excel::Writer::XLSX::Format, Format(3)
A class for defining Excel formatting.
Excel::Writer::XLSX::Package::App, App(3)
A class for writing the Excel XLSX app.xml file.
Excel::Writer::XLSX::Package::Comments, Comments(3)
A class for writing the Excel XLSX Comments files.
Excel::Writer::XLSX::Package::ContentTypes(3)
A class for writing the Excel XLSX [Content_Types] file.
Excel::Writer::XLSX::Package::Core, Core(3)
A class for writing the Excel XLSX core.xml file.
Excel::Writer::XLSX::Package::Custom, Custom(3)
A class for writing the Excel XLSX custom.xml file.
Excel::Writer::XLSX::Package::Packager, Packager(3)
A class for creating the Excel XLSX package.
Excel::Writer::XLSX::Package::Relationships, Relationships(3)
A class for writing the Excel XLSX Rels file.
Excel::Writer::XLSX::Package::SharedStrings, SharedStrings(3)
A class for writing the Excel XLSX sharedStrings.xml file.
Excel::Writer::XLSX::Package::Styles, Styles(3)
A class for writing the Excel XLSX styles file.
Excel::Writer::XLSX::Package::Table, Table(3)
A class for writing the Excel XLSX Table file.
Excel::Writer::XLSX::Package::Theme, Theme(3)
A class for writing the Excel XLSX Theme file.
Excel::Writer::XLSX::Package::VML, VML(3)
A class for writing the Excel XLSX VML files.
Excel::Writer::XLSX::Package::XMLwriter, XMLwriter(3)
A base class for the Excel::Writer::XLSX writer classes.
Excel::Writer::XLSX::Shape, Shape(3)
A class for creating Excel Drawing shapes
Excel::Writer::XLSX::Utility, Utility(3)
Helper functions for Excel::Writer::XLSX.
Excel::Writer::XLSX::Workbook, Workbook(3)
A class for writing Excel Workbooks.
Excel::Writer::XLSX::Worksheet, Worksheet(3)
A class for writing Excel Worksheets.
explain_lseek(3)
explain lseek(2) errors
explain_lseek_or_die(3)
reposition file offset and report errors
explain_lstat(3)
explain lstat(3) errors
explain_lstat_or_die(3)
get file status and report errors
explain_usleep_or_die(3)
suspend execution for ms intervals and report errors
Exporter::Easiest(3)
Takes even more drudgery out of Exporting symbols
Exporter::Easy(3)
Takes the drudgery out of Exporting symbols
Exporter::Tidy(3)
Another way of exporting symbols
ExtUtils::AutoInstall(3)
Automatic install of dependencies via CPAN
ExtUtils::CBuilder(3)
Compile and link C code for Perl modules
ExtUtils::CBuilder::Platform::Windows(3)
Builder class for Windows platforms
ExtUtils::CChecker, "ExtUtils::CChecker"(3)
configure-time utilities for using C headers, libraries, or OS features
ExtUtils::Command(3)
utilities to replace common UNIX commands in Makefiles etc.
ExtUtils::Command::MM(3)
Commands for the MM's to use in Makefiles
ExtUtils::Config(3)
A wrapper for perl's configuration
ExtUtils::Constant(3)
generate XS code to import C header constants
ExtUtils::Constant::Base(3)
base class for ExtUtils::Constant objects
ExtUtils::Constant::Utils(3)
helper functions for ExtUtils::Constant
ExtUtils::Constant::XS(3)
generate C code for XS modules' constants.
ExtUtils::CppGuess(3)
guess C++ compiler and flags
ExtUtils::Depends(3)
Easily build XS extensions that depend on XS extensions
ExtUtils::Embed(3)
Utilities for embedding Perl in C/C++ applications
ExtUtils::F77(3)
Simple interface to F77 libs
ExtUtils::Helpers(3)
Various portability utilities for module builders
ExtUtils::Helpers::Unix(3)
Unix specific helper bits
ExtUtils::Helpers::VMS(3)
VMS specific helper bits
ExtUtils::Helpers::Windows(3)
Windows specific helper bits
ExtUtils::Install(3)
install files from here to there
ExtUtils::Installed(3)
Inventory management of installed modules
ExtUtils::InstallPaths(3)
Build.PL install path logic made easy
ExtUtils::LibBuilder(3)
A tool to build C libraries.
ExtUtils::Liblist(3)
determine libraries to use and how to use them
ExtUtils::MakeMaker(3)
Create a module Makefile
ExtUtils::MakeMaker::Config(3)
Wrapper around Config.pm
ExtUtils::MakeMaker::Coverage(3)
add a Makefile target to determine test coverage using Devel::Cover
ExtUtils::MakeMaker::CPANfile(3)
cpanfile support for EUMM
ExtUtils::MakeMaker::FAQ(3)
Frequently Asked Questions About MakeMaker
ExtUtils::MakeMaker::Locale(3)
bundled Encode::Locale
ExtUtils::MakeMaker::Tutorial(3)
Writing a module with MakeMaker
ExtUtils::Manifest(3)
utilities to write and check a MANIFEST file
ExtUtils::Miniperl(3)
write the C code for miniperlmain.c and perlmain.c
ExtUtils::Mkbootstrap(3)
make a bootstrap file for use by DynaLoader
ExtUtils::Mksymlists(3)
write linker options files for dynamic extension
ExtUtils::MM(3)
OS adjusted ExtUtils::MakeMaker subclass
ExtUtils::MM_AIX(3)
AIX specific subclass of ExtUtils::MM_Unix
ExtUtils::MM_Any(3)
Platform-agnostic MM methods
ExtUtils::MM_BeOS(3)
methods to override UN*X behaviour in ExtUtils::MakeMaker
ExtUtils::MM_Cygwin(3)
methods to override UN*X behaviour in ExtUtils::MakeMaker
ExtUtils::MM_Darwin(3)
special behaviors for OS X
ExtUtils::MM_DOS(3)
DOS specific subclass of ExtUtils::MM_Unix
ExtUtils::MM_MacOS(3)
once produced Makefiles for MacOS Classic
ExtUtils::MM_NW5(3)
methods to override UN*X behaviour in ExtUtils::MakeMaker
ExtUtils::MM_OS2(3)
methods to override UN*X behaviour in ExtUtils::MakeMaker
ExtUtils::MM_QNX(3)
QNX specific subclass of ExtUtils::MM_Unix
ExtUtils::MM_Unix(3)
methods used by ExtUtils::MakeMaker
ExtUtils::MM_UWIN(3)
U/WIN specific subclass of ExtUtils::MM_Unix
ExtUtils::MM_VMS(3)
methods to override UN*X behaviour in ExtUtils::MakeMaker
ExtUtils::MM_VOS(3)
VOS specific subclass of ExtUtils::MM_Unix
ExtUtils::MM_Win32(3)
methods to override UN*X behaviour in ExtUtils::MakeMaker
ExtUtils::MM_Win95(3)
method to customize MakeMaker for Win9X
ExtUtils::MY(3)
ExtUtils::MakeMaker subclass for customization
ExtUtils::Packlist(3)
manage .packlist files
ExtUtils::ParseXS(3)
converts Perl XS code into C code
ExtUtils::ParseXS::Constants(3)
Initialization values for some globals
ExtUtils::ParseXS::Eval(3)
Clean package to evaluate code in
ExtUtils::ParseXS::Utilities(3)
Subroutines used with ExtUtils::ParseXS
ExtUtils::PkgConfig(3)
simplistic interface to pkg-config
ExtUtils::testlib(3)
add blib/* directories to @INC
ExtUtils::Typemaps(3)
Read/Write/Modify Perl/XS typemap files
ExtUtils::Typemaps::Cmd(3)
Quick commands for handling typemaps
ExtUtils::Typemaps::InputMap(3)
Entry in the INPUT section of a typemap
ExtUtils::Typemaps::OutputMap(3)
Entry in the OUTPUT section of a typemap
ExtUtils::Typemaps::Type(3)
Entry in the TYPEMAP section of a typemap
ExtUtils::XSBuilder(3)
Automatic Perl XS glue code generation
ExtUtils::xsbuilder.osc2002(3)
ExtUtils::xsbuilder.osc2002
ExtUtils::XSBuilder::C::grammar(3)
ExtUtils::XSBuilder::C::grammar
ExtUtils::XSBuilder::ParseSource(3)
parse C source files DESCRIPTION For more information, see ExtUtils::XSBuilder extent_parser (o) Allows the user to call the Extent or Replace method of the parser to add new syntax rules. This is mainly useful to include expansions for preprocessor macros. preprocess (o) Allows the user to preprocess the source before it is given to the parser. You may modify the source, which is given as first argument in place. include_dirs (o) Returns a reference to the list of directories that should be searched for include files which contain the functions, structures, etc. to be extracted. Default: '.' include_paths (o) Returns a reference to a list of directories that are given as include directories to the C compiler. This is mainly used to strip these directories from filenames to convert absolute paths to relative paths. Default: empty list ("[]") unwanted_includes (o) Returns a reference to a list of include files that should not be processed. Default: empty list ("[]") sort_includes (o, include_list) Passed an array ref of include files, it allows the user to define the sort order, so includes are processed correctly. Default: return the passed array reference. find_includes (o) Returns a list of include files to be processed. Default: search directories given by "include_dirs" for all files and build a list of include files. All files starting with a word matched by "unwanted_includes" are not included in the list. handle_define (o) Passed a hash ref with the definition of a define, may modify it. Return false to discard it, return true to keep it. Default: 1 handle_enum (o) Passed a hash ref with the definition of a enum value, may modify it. Return false to discard it, return true to keep it. Default: 1 handle_struct (o) Passed a hash ref with the definition of a struct, may modify it. Return false to discard it, return true to keep it. Default: 1 handle_function (o) Passed a hash ref with the definition of a function, may modify it. Return false to discard it, return true to keep it. Default: 1 handle_callback (o) Passed a hash ref with the definition of a callback, may modify it. Return false to discard it, return true to keep it. Default: 1 package (o) Return package name for tables Default: 'MY' targetdir (o) Return name of target directory where to write tables Default: './xsbuilder/tables' run Call this class method to parse your source. Before you can do so you must provide a class that overrides the defaults in ExtUtils::XSBuilder::ParseSource. After that you scan the source files with CW MyClass -> run ; R
ExtUtils::XSBuilder::PODTemplate, $module(3)
ExtUtils::XSBuilder::PODTemplate
ExtUtils::XSBuilder::WrapXS(3)
create perl XS wrappers for C functions DESCRIPTION For more information, see ExtUtils::XSBuilder new_parsesource (o) Returns an array ref of new ParseSource objects for all source files that should be used to generate XS files new_typemap (o) Returns a new typemap object new_podtemplate (o) Returns a new podtemplate object xs_includes (o) Returns a list of XS include files. Default: use all include files that "ParseSource::find_includes" returns, but strip path info xs_glue_dirs (o) Returns a list of additional XS glue directories to seach for maps in. xs_base_dir (o) Returns a directory which serves as a base for other directories. Default: '.' xs_map_dir (o) Returns the directory to search for map files in Default: "<xs_base_dir"/xsbuilder/maps> xs_incsrc_dir (o) Returns the directory to search for files to include into the source. For example, "<xs_incsrc_dir"/Apache/DAV/Resource/Resource_pm> will be included into the "Apache::DAV::Resource" module. Default: "<xs_base_dir"/xsbuilder> xs_include_dir (o) Returns a directory to search for include files for pm and XS Default: "<xs_base_dir"/xsinclude> xs_target_dir (o) Returns the directory to write generated XS and header files in Default: "<xs_base_dir"/xs> makefilepl_text (o) Returns text for Makefile.PL h_filename_prefix (o) Defines a prefix for generated header files Default: 'xs_' my_xs_prefix (o) Defines a prefix used for all XS functions Default: 'xs_' my_cnv_prefix (o) Defines a prefix used for all conversion functions/macros. Default: "my_xs_prefix" needs_prefix (o, name) Returns true if the passed name should be prefixed pm_text (o, module, isa, code) Returns the text of a ".pm" file, or undef if no ".pm" file should be written. Default: Create a ".pm" file which bootstraps the XS code mapline_elem (o, elem) Called for each structure element that is written to the map file by checkmaps. Allows the user to change the element name, for example adding a different perl name. Default: returns the element unmodified mapline_func (o) Called for each function that is written to the map file by checkmaps. Allows the user to change the function name, for example adding a different perl name. Default: returns the element unmodified
ExtUtils::XSpp(3)
XS for C++
ExtUtils::XSpp::Cmd(3)
implementation of xspp
ExtUtils::XSpp::Exception(3)
Map C++ exceptions to Perl exceptions
ExtUtils::XSpp::Node(3)
Base class for elements of the parser output
ExtUtils::XSpp::Node::Access(3)
Node representing an access specifier
ExtUtils::XSpp::Node::Argument(3)
Node representing a method/function argument
ExtUtils::XSpp::Node::Class(3)
A class (inherits from Package).
ExtUtils::XSpp::Node::Comment(3)
Node representing a comment in the source file
ExtUtils::XSpp::Node::Constructor(3)
Node representing a constructor method
ExtUtils::XSpp::Node::Destructor(3)
Node representing a destructor method
ExtUtils::XSpp::Node::Enum(3)
Node representing an enum declaration
ExtUtils::XSpp::Node::EnumValue(3)
Node representing an enum element
ExtUtils::XSpp::Node::File(3)
Directive that sets the name of the output file
ExtUtils::XSpp::Node::Function(3)
Node representing a function
ExtUtils::XSpp::Node::Member(3)
Node representing a class member variable
ExtUtils::XSpp::Node::Method(3)
Node representing a method
ExtUtils::XSpp::Node::Module(3)
Node representing an XS++/XS MODULE declaration
ExtUtils::XSpp::Node::Package(3)
Node representing a Perl package
ExtUtils::XSpp::Node::PercAny(3)
contains information about %Foo tags handled by plugins
ExtUtils::XSpp::Node::Raw(3)
Node for data that should be included in XS verbatim
ExtUtils::XSpp::Parser(3)
an XS++ parser ExtUtils::XSpp::Parser::new( file => path ) Create a new XS++ parser. ExtUtils::XSpp::Parser::parse Parse the file data; returns true on success, false otherwise, on failure "get_errors" will return the list of errors. ExtUtils::XSpp::Parser::get_data Returns a list containing the parsed data. Each item of the list is a subclass of "ExtUtils::XSpp::Node" ExtUtils::XSpp::Parser::get_errors Returns the parsing errors as an array. ExtUtils::XSpp::Parser::load_plugin Loads the specified plugin and calls its "register_plugin" method. ExtUtils::XSpp::Parser::add_post_process_plugin Adds the specified plugin to be called after parsing is complete to modify the parse tree before it is emitted. ExtUtils::XSpp::Parser::add_class_tag_plugin Adds the specified plugin to the list of plugins that can handle custom %foo annotations for a class. ExtUtils::XSpp::Parser::add_function_tag_plugin Adds the specified plugin to the list of plugins that can handle custom %foo annotations for a function. ExtUtils::XSpp::Parser::add_method_tag_plugin Adds the specified plugin to the list of plugins that can handle custom %foo annotations for a function. ExtUtils::XSpp::Parser::add_argument_tag_plugin Adds the specified plugin to the list of plugins that can handle custom %foo annotations for an arguments. ExtUtils::XSpp::Parser::add_toplevel_tag_plugin Adds the specified plugin to the list of plugins that can handle custom %foo top level directives.
ExtUtils::XSpp::Plugin(3)
XS++ plugin interface
ExtUtils::XSpp::Typemap(3)
map types
ExtUtils::XSSymSet(3)
keep sets of symbol names palatable to the VMS linker
EZ_DisableImageDithering, EZ_EnableImageDithering(3)
disable/enable image dithering for image labels
EZ_InstallSymbol, EZ_RetrieveSymbol(3)
EZ_InstallSymbol
EZ_InstallSymbolicFloat, EZ_RetrieveSymbolicFloat(3)
EZ_InstallSymbolicFloat
EZ_InstallSymbolicInt, EZ_RetrieveSymbolicInt(3)
EZ_InstallSymbolicInt
EZ_InstallSymbolicPointer, EZ_RetrieveSymbolicPointer(3)
EZ_InstallSymbolicPointer
EZ_InstallSymbolicULong, EZ_RetrieveSymbolicULong(3)
EZ_InstallSymbolicULong
EZ_SetDirTreeDefaultPixmaps, EZ_SetDirTreeDefaultPixmapsFromXpmFiles(3)
set the default pixmap labels for directory tree nodes
EZ_SetLedPixelSize(3)
Set the pixel size for an LED widget
EZ_SetWidgetLabelString, EZ_GetWidgetLabelPosition, EZ_GetWidgetLabelString(3)
retrieve information about the textual lable on a widget
EZ_SSheetInsertRegionString(3)
insert some cells into a spread sheet widget
EZ_SSheetSwapRow, EZ_SSheetSwapCell, EZ_SSheetSwapColumn(3)
swap two rows/columns/cells
FcConfigEnableHome(3)
controls use of the home directory.
FcDirCacheClean(3)
This tries to clean up the cache directory of cache_dir.This returns FcTrue if the operation is successfully complete. otherwise FcFalse.
FCGI::Spawn::BinUtils(3)
FCGI::Spawn::BinUtils
FcPatternEqualSubset(3)
Compare portions of patterns
ffs, ffsl, ffsll, fls, flsl, flsll(3)
find first or last bit set in a bit string
File::chmod(3)
Implements symbolic and ls chmod modes
File::FcntlLock(3)
File locking with fcntl(2) This text also documents the following sub-packages: File::FcntlLock::XS 2 0 File::FcntlLock::Pure 2 File::FcntlLock::Inline 2
File::FcntlLock::Inline, File::FcntlLock(3)
File locking with fcntl(2) This text also documents the following sub-packages: File::FcntlLock::XS 2 0 File::FcntlLock::Pure 2 File::FcntlLock::Inline 2
File::FcntlLock::Pure, File::FcntlLock(3)
File locking with fcntl(2) This text also documents the following sub-packages: File::FcntlLock::XS 2 0 File::FcntlLock::Pure 2 File::FcntlLock::Inline 2
File::FcntlLock::XS, File::FcntlLock(3)
File locking with fcntl(2) This text also documents the following sub-packages: File::FcntlLock::XS 2 0 File::FcntlLock::Pure 2 File::FcntlLock::Inline 2
File::Sync(3)
Perl access to fsync() and sync() function calls
File::Util::Definitions(3)
Global symbols and constants used in most File::Util classes
file_exists(3)
Tells if a file exists. Allegro game programming library.
Finance::Quote::HEX, Finance::Quote::HEX -(3)
Obtain quotes from the Helsinki Stock Exchange.
float_to_exp(3)
Convert floating point values into "exponential" pixels.
float_to_exp(3)
Convert floating point values into "exponential" pixels.
floodfill(3)
Floodfills an enclosed area. Allegro game programming library.
fnbase, fndelbeg, fndelend, fndelsuf, fndir, fnhome, fnjoin, fnlastsuf, fnsetsuf, fname(3)
filename manipulation
Font::TTF::AATutils(3)
Utility functions for AAT tables ($classes, $states) = AAT_read_subtable($fh, $baseOffset, $subtableStart, $limits) $length = AAT_write_state_table($fh, $classes, $states, $numExtraTables, $packEntry) $packEntry is a subroutine for packing an entry into binary form, called as $dat = $packEntry($entry, $entryTable, $numEntries) where the entry is a comma-separated list of nextStateOffset, flags, actions ($classes, $states, $entries) = AAT_read_state_table($fh, $numActionWords) ($format, $lookup) = AAT_read_lookup($fh, $valueSize, $length, $default) AAT_write_lookup($fh, $format, $lookup, $valueSize, $default)
Font::TTF::Utils(3)
Utility functions to save fingers
font_has_alpha(3)
Search all pixels of a font for alpha values. Allegro game programming library.
forks::signals(3)
signal management for forks
free_audio_stream_buffer(3)
Tells the audio stream player new data can be played. Allegro game programming library.
freelomodel(3)
free a lofig_list for temporary models
fribidi_debug_status(3)
FRIBIDI_BEGIN_DECLS should be used at the beginning of your declarations,
fribidi_get_par_embedding_levels(3)
get bidi embedding levels of a paragraph
fribidi_log2vis_get_embedding_levels(3)
get embedding levels
Future::Phrasebook, "Future::Phrasebook"(3)
coding examples for "Future" and "Future::Utils" This documentation-only module provides a phrasebook-like approach to giving examples on how to use Future and Future::Utils to structure Future-driven asynchronous or concurrent logic. As with any inter-dialect phrasebook it is structured into pairs of examples; each given first in a traditional call/return Perl style, and second in a style using Futures. In each case, the generic function or functions in the example are named in "ALL_CAPITALS()" to make them stand out. In the examples showing use of Futures, any function that is expected to return a "Future" instance is named with a leading "F_" prefix. Each example is also constructed so as to yield an overall future in a variable called "$f", which represents the entire operation.
Future::Utils, "Future::Utils"(3)
utility functions for working with "Future" objects
Games::Dice(3)
Perl module to simulate die rolls
Gantry::Conf::FAQ(3)
Frequently Asked Questions regarding Gantry::Conf Why should I use Gantry::Conf at all? 4 There are many reasons why we feel Gantry::Conf is helpful both during development and after deployment. The next two entries should hopefully answer this question for you as they outline a few common scenarios programmers and system administrators often face. How is Gantry::Conf helpful during development? 4 4 0 Easy separation of development configs from production configs 4 Often programmers have a separate development environment from their production environment. By using <shared> blocks and dev instances you can avoid spending any serious time setting up your application in the development environment. Take this configuration example: CW <shared dev> dbuser nobody dbpass secret dbconn "dbi:Pg:dbname=dev" </shared> <shared production> dbuser apache dbpass secret2 dbconn "dbi:Pg:dbname=production" </shared> <instance app1> ConfigureVia FlatFile Config::General /etc/apps/app1.conf use production </instance> <instance app1-dev> ConfigureVia FlatFile Config::General /etc/apps/app1.conf use dev </instance> R By separating out our production and dev database information into shared blocks we can essentially switch between our production and dev environments by simply changing the instance we are using. If you were working on a script this would be a simple matter of running: CW $ script.pl --instance=app1-dev R instead of: CW $ script.pl --instance=app1 R 4 How is Gatnry::Conf helpful in production? 4 Gantry::Conf has several advantages in a production environment. First, it provides a single place for all config information, if you commit to it. Even if you don't commit to it for all apps, it still provides control to the installing admin over how and where conf information is stored. For instance, the admin could put the config information directly into /etc/gantry.conf, or into a separate file in /etc/gantry.d. She could even set up a secure web server where all boxes would go to get their conf. The short answer is, Gantry::Conf is flexible and production environments benefit from flexibility. How do I pass my instance information into my application? 4 There are many possible ways to do this a few of which are: 4 Command line arguments 4 If your application accepts arguments on the command line we suggest adding an "--instance" option to pass in the instance's name. PerlSetVar 4 In a mod_perl environment you could use a PerlSetVar, possibly named "GantryConfInstance", to pull in this value for your application. ModPerl::ParamBuilder 4 Again in a mod_perl environment, another option would be to use ModPerl::ParamBuilder to pass the instance name. Hard coded 4 We include this for the sake of completeness, but advise against it. You could always simply hard code your instance information into your application, but this will greatly reduce the flexibility you have. 4 How do I add a different provider for an existing ConfigVia method? 4 Place your provider module in the Gantry::Conf::Provider::Method::* namespace. Make sure your public API matches the existing providers which use the same method. For instance the flat file providers all implement a config method which is called as a class method and receives a file name. How do I add to the ConfigVia methods? 4 If none of the existing provider methods will do, you need to work in Gantry::Conf. In particular, you need to augment the dispatch hash with the name of your provisioning method and a sub name which will handle it. Then you need to implement the method you put in %dispatch.
Gantry::Conf::Provider::PerlSetVar(3)
Configure via PerlSetVar's in httpd.conf
Gantry::Utils::AuthCDBI(3)
Class::DBI base model for Gantry Auth
Gantry::Utils::Captcha(3)
a way to mange captchas
Gantry::Utils::CDBI(3)
Class::DBI base class for Gantry applications
Gantry::Utils::CRON(3)
a way to call a controller's method from a CRON script
Gantry::Utils::CRUDHelp(3)
helper routines for CRUD plugins
Gantry::Utils::Crypt(3)
an easy way to crypt and decrypt
Gantry::Utils::DB(3)
Database wrapper functions, specfic to PostgreSQL
Gantry::Utils::DBConnHelper(3)
connection info and dbh cache manager base module
Gantry::Utils::DBConnHelper::MP13(3)
connection info and dbh cache manager for mod_perl 1
Gantry::Utils::DBConnHelper::MP20(3)
connection info and dbh cache manager for mod_perl 2.0
Gantry::Utils::DBConnHelper::Script(3)
connection info and dbh cache manager for scripts
Gantry::Utils::DBIxClass(3)
a DBIx::Class subclass models can inherit from
Gantry::Utils::FormErrors(3)
A CRUD form validation error object
Gantry::Utils::FormMunger(3)
Munges form hashes like the ones bigtop makes.
Gantry::Utils::HTML(3)
HTML tag generators.
Gantry::Utils::Model(3)
a general purpose Object Relational Model base class
Gantry::Utils::Model::Auth(3)
base class for auth database modelers
Gantry::Utils::Model::Regular(3)
base class for database modelers
Gantry::Utils::ModelHelper(3)
mixin for model base classes
Gantry::Utils::PerlbalFixup(3)
This module will set the client ip
Gantry::Utils::PODViewer(3)
PODViewer application
Gantry::Utils::SQL(3)
SQL routines.
Gantry::Utils::TablePerms(3)
enforces retrieve permssions on main listings
Gantry::Utils::Threeway(3)
Form processing util for a three-way join
Gantry::Utils::Validate(3)
Validates input values.
Genezzo::Block::RDBlock, Genezzo::Block::RDBlock.pm(3)
Row Directory Block tied hash class. A class that lets you treat the contents of a block (byte buffer) as a hash. Note: This implementation is almost, but not quite, a pushhash. The push hash implementation is Genezzo::Row::RSBlock. It also forms the basis of a tied array in Genezzo::Block::RDBArray.
Genezzo::Havok::DebugUtils(3)
debug functions
Genezzo::Havok::SQLScalar(3)
scalar SQL functions
Genezzo::Havok::Utils(3)
general utility functions
GENLIB_LOSIG(3, October 1, 1997)
declare an internal logical signal, or a vector of internal logical signals
GENLIB_LOSIGMERGE(3, October 1, 1997)
merge two logical signals
Geo::JSON::Utils(3)
Util methods for Geo::JSON classes
geography, REarth, AngleCmp, AngleFmDeg, AngleFmRad, AngleIsBad, AngleIsOK, AngleToDeg, AngleToRad, Azimuth, BadAngle, DeleteRotation, DomainLat, DomainLon, DomainLonPt, GCircleX, GeoDistance, GeoPtGetDeg, GeoPtGetRad, GeoPtIsNowhere, GeoPtIsSomewhere, GeoPtNowhere, GeoPtSetDeg, GeoPtSetRad, GeoQuickDistance, GeoStep, GeoTime_CalSet, GeoTime_CalToJul, GeoTime_Cmp, GeoTime_Diff, GeoTime_Incr, GeoTime_JulSet, GeoTime_JulToCal, GetRotation, GwchLon, GwchLonPt, ICos, ISin, LatCmp, LonBtwn, LonBtwn1, LonCmp, MapPtIsNowhere, MapPtIsSomewhere, MapPtNowhere, NewRotation, Rotate, Rotation, ScaleMapPt, SetREarth, SetRotation(3)
basic geographic calculations and comparisons.
get_audio_stream_buffer(3)
Tells you if you need to fill the audiostream or not. Allegro game programming library.
get_clip_state(3)
Tells if clipping is on for a bitmap. Allegro game programming library.
get_mixer_channels(3)
Returns the number of output channels. Allegro game programming library.
get_sound_input_cap_stereo(3)
Tells if the input driver is capable of stereo recording. Allegro game programming library.
getpeereid(3)
get the effective credentials of a UNIX-domain peer
getusershell, endusershell, setusershell(3)
get valid user shells
Gimp::PixelRgn(3)
Operate on raw pixels in powerful, efficient way.
Git::SVN::Utils(3)
utility functions used across Git::SVN
gl_get_line, del_GetLine, gl_bind_keyseq, gl_catch_blocked, gl_change_terminal, gl_clear_history, gl_completion_action, gl_configure_getline, gl_customize_completion, gl_display_text, gl_echo_mode, gl_erase_terminal, gl_error_message, gl_group_history, gl_ignore_signal, gl_inactivity_timeout, gl_last_signal, gl_limit_history, gl_list_signals, gl_load_history, gl_lookup_history, gl_prompt_style, gl_query_char, gl_range_of_history, gl_read_char, gl_resize_history, gl_return_status, gl_save_history, gl_set_term_size, gl_show_history, gl_size_of_history, gl_state_of_history, gl_terminal_size, gl_toggle_history, gl_trap_signal, gl_watch_fd, new_GetLine, gl_register_action, gl_append_history, gl_automatic_history, gl_replace_prompt(3)
allow the user to compose an input line
gl_io_mode, gl_abandon_line, gl_handle_signal, gl_normal_io, gl_pending_io, gl_raw_io, gl_tty_signals(3)
How to use gl_get_line() from an external event loop.
glCopyPixels(3)
glCopyPixels
glDrawPixels(3)
glDrawPixels
Glib::devel(3)
Binding developer's overview of Glib's internals
Glib::Utils(3)
Miscellaneous utility functions
glPixelStoref(3)
glPixelStoref
glPixelStorei(3)
glPixelStorei
glReadPixels(3)
glReadPixels
glScaled(3)
glScaled
glScalef(3)
glScalef
glScissor(3)
glScissor
glSelectBuffer(3)
glSelectBuffer
glShadeModel(3)
glShadeModel
glStencilFunc(3)
glStencilFunc
glStencilMask(3)
glStencilMask
glStencilOp(3)
glStencilOp
gluQuadricNormals(3)
gluQuadricNormals
glutDialsFunc(3, 3GLUT)
sets the dial & button box dials callback for the current window.
glutFullScreen(3, 3GLUT)
requests that the current window be made full screen.
gnutls_aead_cipher_decrypt(3)
API function
gnutls_aead_cipher_deinit(3)
API function
gnutls_aead_cipher_encrypt(3)
API function
gnutls_aead_cipher_init(3)
API function
gnutls_alert_get(3)
API function
gnutls_alert_get_name(3)
API function
gnutls_alert_get_strname(3)
API function
gnutls_alert_send(3)
API function
gnutls_alert_send_appropriate(3)
API function
gnutls_alpn_get_selected_protocol(3)
API function
gnutls_alpn_set_protocols(3)
API function
gnutls_anon_allocate_client_credentials(3)
API function
gnutls_anon_allocate_server_credentials(3)
API function
gnutls_anon_free_client_credentials(3)
API function
gnutls_anon_free_server_credentials(3)
API function
gnutls_anon_set_params_function(3)
API function
gnutls_anon_set_server_dh_params(3)
API function
gnutls_anon_set_server_known_dh_params(3)
API function
gnutls_anon_set_server_params_function(3)
API function
gnutls_auth_client_get_type(3)
API function
gnutls_auth_get_type(3)
API function
gnutls_auth_server_get_type(3)
API function
gnutls_buffer_append_data(3)
API function
gnutls_bye(3)
API function
gnutls_certificate_activation_time_peers(3)
API function
gnutls_certificate_allocate_credentials(3)
API function
gnutls_certificate_client_get_request_status(3)
API function
gnutls_certificate_expiration_time_peers(3)
API function
gnutls_certificate_free_ca_names(3)
API function
gnutls_certificate_free_cas(3)
API function
gnutls_certificate_free_credentials(3)
API function
gnutls_certificate_free_crls(3)
API function
gnutls_certificate_free_keys(3)
API function
gnutls_certificate_get_crt_raw(3)
API function
gnutls_certificate_get_issuer(3)
API function
gnutls_certificate_get_ours(3)
API function
gnutls_certificate_get_peers(3)
API function
gnutls_certificate_get_peers_subkey_id(3)
API function
gnutls_certificate_get_trust_list(3)
API function
gnutls_certificate_get_verify_flags(3)
API function
gnutls_certificate_get_x509_crt(3)
API function
gnutls_certificate_get_x509_key(3)
API function
gnutls_certificate_send_x509_rdn_sequence(3)
API function
gnutls_certificate_server_set_request(3)
API function
gnutls_certificate_set_dh_params(3)
API function
gnutls_certificate_set_flags(3)
API function
gnutls_certificate_set_key(3)
API function
gnutls_certificate_set_known_dh_params(3)
API function
gnutls_certificate_set_ocsp_status_request_file(3)
API function
gnutls_certificate_set_ocsp_status_request_function(3)
API function
gnutls_certificate_set_ocsp_status_request_function2(3)
API function
gnutls_certificate_set_params_function(3)
API function
gnutls_certificate_set_pin_function(3)
API function
gnutls_certificate_set_retrieve_function(3)
API function
gnutls_certificate_set_retrieve_function2(3)
API function
gnutls_certificate_set_trust_list(3)
API function
gnutls_certificate_set_verify_flags(3)
API function
gnutls_certificate_set_verify_function(3)
API function
gnutls_certificate_set_verify_limits(3)
API function
gnutls_certificate_set_x509_crl(3)
API function
gnutls_certificate_set_x509_crl_file(3)
API function
gnutls_certificate_set_x509_crl_mem(3)
API function
gnutls_certificate_set_x509_key(3)
API function
gnutls_certificate_set_x509_key_file(3)
API function
gnutls_certificate_set_x509_key_file2(3)
API function
gnutls_certificate_set_x509_key_mem(3)
API function
gnutls_certificate_set_x509_key_mem2(3)
API function
gnutls_certificate_set_x509_simple_pkcs12_file(3)
API function
gnutls_certificate_set_x509_simple_pkcs12_mem(3)
API function
gnutls_certificate_set_x509_system_trust(3)
API function
gnutls_certificate_set_x509_trust(3)
API function
gnutls_certificate_set_x509_trust_dir(3)
API function
gnutls_certificate_set_x509_trust_file(3)
API function
gnutls_certificate_set_x509_trust_mem(3)
API function
gnutls_certificate_type_get(3)
API function
gnutls_certificate_type_get_id(3)
API function
gnutls_certificate_type_get_name(3)
API function
gnutls_certificate_type_list(3)
API function
gnutls_certificate_verification_status_print(3)
API function
gnutls_certificate_verify_peers(3)
API function
gnutls_certificate_verify_peers2(3)
API function
gnutls_certificate_verify_peers3(3)
API function
gnutls_check_version(3)
API function
gnutls_cipher_add_auth(3)
API function
gnutls_cipher_decrypt(3)
API function
gnutls_cipher_decrypt2(3)
API function
gnutls_cipher_deinit(3)
API function
gnutls_cipher_encrypt(3)
API function
gnutls_cipher_encrypt2(3)
API function
gnutls_cipher_get(3)
API function
gnutls_cipher_get_block_size(3)
API function
gnutls_cipher_get_id(3)
API function
gnutls_cipher_get_iv_size(3)
API function
gnutls_cipher_get_key_size(3)
API function
gnutls_cipher_get_name(3)
API function
gnutls_cipher_get_tag_size(3)
API function
gnutls_cipher_init(3)
API function
gnutls_cipher_list(3)
API function
gnutls_cipher_set_iv(3)
API function
gnutls_cipher_suite_get_name(3)
API function
gnutls_cipher_suite_info(3)
API function
gnutls_cipher_tag(3)
API function
gnutls_compression_get(3)
API function
gnutls_compression_get_id(3)
API function
gnutls_compression_get_name(3)
API function
gnutls_compression_list(3)
API function
gnutls_credentials_clear(3)
API function
gnutls_credentials_get(3)
API function
gnutls_credentials_set(3)
API function
gnutls_crypto_register_aead_cipher(3)
API function
gnutls_crypto_register_cipher(3)
API function
gnutls_crypto_register_digest(3)
API function
gnutls_crypto_register_mac(3)
API function
gnutls_db_check_entry(3)
API function
gnutls_db_check_entry_time(3)
API function
gnutls_db_get_default_cache_expiration(3)
API function
gnutls_db_get_ptr(3)
API function
gnutls_db_remove_session(3)
API function
gnutls_db_set_cache_expiration(3)
API function
gnutls_db_set_ptr(3)
API function
gnutls_db_set_remove_function(3)
API function
gnutls_db_set_retrieve_function(3)
API function
gnutls_db_set_store_function(3)
API function
gnutls_decode_ber_digest_info(3)
API function
gnutls_deinit(3)
API function
gnutls_dh_get_group(3)
API function
gnutls_dh_get_peers_public_bits(3)
API function
gnutls_dh_get_prime_bits(3)
API function
gnutls_dh_get_pubkey(3)
API function
gnutls_dh_get_secret_bits(3)
API function
gnutls_dh_params_cpy(3)
API function
gnutls_dh_params_deinit(3)
API function
gnutls_dh_params_export2_pkcs3(3)
API function
gnutls_dh_params_export_pkcs3(3)
API function
gnutls_dh_params_export_raw(3)
API function
gnutls_dh_params_generate2(3)
API function
gnutls_dh_params_import_dsa(3)
API function
gnutls_dh_params_import_pkcs3(3)
API function
gnutls_dh_params_import_raw(3)
API function
gnutls_dh_params_import_raw2(3)
API function
gnutls_dh_params_init(3)
API function
gnutls_dh_set_prime_bits(3)
API function
gnutls_digest_get_id(3)
API function
gnutls_digest_get_name(3)
API function
gnutls_digest_get_oid(3)
API function
gnutls_digest_list(3)
API function
gnutls_dtls_cookie_send(3)
API function
gnutls_dtls_cookie_verify(3)
API function
gnutls_dtls_get_data_mtu(3)
API function
gnutls_dtls_get_mtu(3)
API function
gnutls_dtls_get_timeout(3)
API function
gnutls_dtls_prestate_set(3)
API function
gnutls_dtls_set_data_mtu(3)
API function
gnutls_dtls_set_mtu(3)
API function
gnutls_dtls_set_timeouts(3)
API function
gnutls_ecc_curve_get(3)
API function
gnutls_ecc_curve_get_id(3)
API function
gnutls_ecc_curve_get_name(3)
API function
gnutls_ecc_curve_get_oid(3)
API function
gnutls_ecc_curve_get_pk(3)
API function
gnutls_ecc_curve_get_size(3)
API function
gnutls_ecc_curve_list(3)
API function
gnutls_encode_ber_digest_info(3)
API function
gnutls_error_is_fatal(3)
API function
gnutls_error_to_alert(3)
API function
gnutls_est_record_overhead_size(3)
API function
gnutls_ext_get_data(3)
API function
gnutls_ext_get_name(3)
API function
gnutls_ext_register(3)
API function
gnutls_ext_set_data(3)
API function
gnutls_fingerprint(3)
API function
gnutls_fips140_mode_enabled(3)
API function
gnutls_global_deinit(3)
API function
gnutls_global_init(3)
API function
gnutls_global_set_audit_log_function(3)
API function
gnutls_global_set_log_function(3)
API function
gnutls_global_set_log_level(3)
API function
gnutls_global_set_mem_functions(3)
API function
gnutls_global_set_mutex(3)
API function
gnutls_global_set_time_function(3)
API function
gnutls_handshake(3)
API function
gnutls_handshake_description_get_name(3)
API function
gnutls_handshake_get_last_in(3)
API function
gnutls_handshake_get_last_out(3)
API function
gnutls_handshake_set_hook_function(3)
API function
gnutls_handshake_set_max_packet_length(3)
API function
gnutls_handshake_set_post_client_hello_function(3)
API function
gnutls_handshake_set_private_extensions(3)
API function
gnutls_handshake_set_random(3)
API function
gnutls_handshake_set_timeout(3)
API function
gnutls_hash(3)
API function
gnutls_hash_deinit(3)
API function
gnutls_hash_fast(3)
API function
gnutls_hash_get_len(3)
API function
gnutls_hash_init(3)
API function
gnutls_hash_output(3)
API function
gnutls_heartbeat_allowed(3)
API function
gnutls_heartbeat_enable(3)
API function
gnutls_heartbeat_get_timeout(3)
API function
gnutls_heartbeat_ping(3)
API function
gnutls_heartbeat_pong(3)
API function
gnutls_heartbeat_set_timeouts(3)
API function
gnutls_hex2bin(3)
API function
gnutls_hex_decode(3)
API function
gnutls_hex_decode2(3)
API function
gnutls_hex_encode(3)
API function
gnutls_hex_encode2(3)
API function
gnutls_hmac(3)
API function
gnutls_hmac_deinit(3)
API function
gnutls_hmac_fast(3)
API function
gnutls_hmac_get_len(3)
API function
gnutls_hmac_init(3)
API function
gnutls_hmac_output(3)
API function
gnutls_hmac_set_nonce(3)
API function
gnutls_idna_map(3)
API function
gnutls_idna_reverse_map(3)
API function
gnutls_init(3)
API function
gnutls_key_generate(3)
API function
gnutls_kx_get(3)
API function
gnutls_kx_get_id(3)
API function
gnutls_kx_get_name(3)
API function
gnutls_kx_list(3)
API function
gnutls_load_file(3)
API function
gnutls_mac_get(3)
API function
gnutls_mac_get_id(3)
API function
gnutls_mac_get_key_size(3)
API function
gnutls_mac_get_name(3)
API function
gnutls_mac_get_nonce_size(3)
API function
gnutls_mac_list(3)
API function
gnutls_memcmp(3)
API function
gnutls_memset(3)
API function
gnutls_ocsp_req_add_cert(3)
API function
gnutls_ocsp_req_add_cert_id(3)
API function
gnutls_ocsp_req_deinit(3)
API function
gnutls_ocsp_req_export(3)
API function
gnutls_ocsp_req_get_cert_id(3)
API function
gnutls_ocsp_req_get_extension(3)
API function
gnutls_ocsp_req_get_nonce(3)
API function
gnutls_ocsp_req_get_version(3)
API function
gnutls_ocsp_req_import(3)
API function
gnutls_ocsp_req_init(3)
API function
gnutls_ocsp_req_print(3)
API function
gnutls_ocsp_req_randomize_nonce(3)
API function
gnutls_ocsp_req_set_extension(3)
API function
gnutls_ocsp_req_set_nonce(3)
API function
gnutls_ocsp_resp_check_crt(3)
API function
gnutls_ocsp_resp_deinit(3)
API function
gnutls_ocsp_resp_export(3)
API function
gnutls_ocsp_resp_get_certs(3)
API function
gnutls_ocsp_resp_get_extension(3)
API function
gnutls_ocsp_resp_get_nonce(3)
API function
gnutls_ocsp_resp_get_produced(3)
API function
gnutls_ocsp_resp_get_responder(3)
API function
gnutls_ocsp_resp_get_responder2(3)
API function
gnutls_ocsp_resp_get_responder_raw_id(3)
API function
gnutls_ocsp_resp_get_response(3)
API function
gnutls_ocsp_resp_get_signature(3)
API function
gnutls_ocsp_resp_get_signature_algorithm(3)
API function
gnutls_ocsp_resp_get_single(3)
API function
gnutls_ocsp_resp_get_status(3)
API function
gnutls_ocsp_resp_get_version(3)
API function
gnutls_ocsp_resp_import(3)
API function
gnutls_ocsp_resp_init(3)
API function
gnutls_ocsp_resp_print(3)
API function
gnutls_ocsp_resp_verify(3)
API function
gnutls_ocsp_resp_verify_direct(3)
API function
gnutls_ocsp_status_request_enable_client(3)
API function
gnutls_ocsp_status_request_get(3)
API function
gnutls_ocsp_status_request_is_checked(3)
API function
gnutls_oid_to_digest(3)
API function
gnutls_oid_to_ecc_curve(3)
API function
gnutls_oid_to_mac(3)
API function
gnutls_oid_to_pk(3)
API function
gnutls_oid_to_sign(3)
API function
gnutls_openpgp_privkey_sign_hash(3)
API function
gnutls_openpgp_send_cert(3)
API function
gnutls_packet_deinit(3)
API function
gnutls_packet_get(3)
API function
gnutls_pcert_deinit(3)
API function
gnutls_pcert_export_openpgp(3)
API function
gnutls_pcert_export_x509(3)
API function
gnutls_pcert_import_openpgp(3)
API function
gnutls_pcert_import_openpgp_raw(3)
API function
gnutls_pcert_import_x509(3)
API function
gnutls_pcert_import_x509_list(3)
API function
gnutls_pcert_import_x509_raw(3)
API function
gnutls_pcert_list_import_x509_raw(3)
API function
gnutls_pem_base64_decode(3)
API function
gnutls_pem_base64_decode2(3)
API function
gnutls_pem_base64_encode(3)
API function
gnutls_pem_base64_encode2(3)
API function
gnutls_perror(3)
API function
gnutls_pk_algorithm_get_name(3)
API function
gnutls_pk_bits_to_sec_param(3)
API function
gnutls_pk_get_id(3)
API function
gnutls_pk_get_name(3)
API function
gnutls_pk_get_oid(3)
API function
gnutls_pk_list(3)
API function
gnutls_pk_to_sign(3)
API function
gnutls_pkcs11_add_provider(3)
API function
gnutls_pkcs11_copy_attached_extension(3)
API function
gnutls_pkcs11_copy_pubkey(3)
API function
gnutls_pkcs11_copy_secret_key(3)
API function
gnutls_pkcs11_copy_x509_crt(3)
API function
gnutls_pkcs11_copy_x509_crt2(3)
API function
gnutls_pkcs11_copy_x509_privkey(3)
API function
gnutls_pkcs11_copy_x509_privkey2(3)
API function
gnutls_pkcs11_crt_is_known(3)
API function
gnutls_pkcs11_deinit(3)
API function
gnutls_pkcs11_delete_url(3)
API function
gnutls_pkcs11_get_pin_function(3)
API function
gnutls_pkcs11_get_raw_issuer(3)
API function
gnutls_pkcs11_get_raw_issuer_by_dn(3)
API function
gnutls_pkcs11_get_raw_issuer_by_subject_key_id(3)
API function
gnutls_pkcs11_init(3)
API function
gnutls_pkcs11_obj_deinit(3)
API function
gnutls_pkcs11_obj_export(3)
API function
gnutls_pkcs11_obj_export2(3)
API function
gnutls_pkcs11_obj_export3(3)
API function
gnutls_pkcs11_obj_export_url(3)
API function
gnutls_pkcs11_obj_flags_get_str(3)
API function
gnutls_pkcs11_obj_get_exts(3)
API function
gnutls_pkcs11_obj_get_flags(3)
API function
gnutls_pkcs11_obj_get_info(3)
API function
gnutls_pkcs11_obj_get_type(3)
API function
gnutls_pkcs11_obj_import_url(3)
API function
gnutls_pkcs11_obj_init(3)
API function
gnutls_pkcs11_obj_list_import_url3(3)
API function
gnutls_pkcs11_obj_list_import_url4(3)
API function
gnutls_pkcs11_obj_set_info(3)
API function
gnutls_pkcs11_obj_set_pin_function(3)
API function
gnutls_pkcs11_privkey_cpy(3)
API function
gnutls_pkcs11_privkey_deinit(3)
API function
gnutls_pkcs11_privkey_export_pubkey(3)
API function
gnutls_pkcs11_privkey_export_url(3)
API function
gnutls_pkcs11_privkey_generate(3)
API function
gnutls_pkcs11_privkey_generate2(3)
API function
gnutls_pkcs11_privkey_generate3(3)
API function
gnutls_pkcs11_privkey_get_info(3)
API function
gnutls_pkcs11_privkey_get_pk_algorithm(3)
API function
gnutls_pkcs11_privkey_import_url(3)
API function
gnutls_pkcs11_privkey_init(3)
API function
gnutls_pkcs11_privkey_set_pin_function(3)
API function
gnutls_pkcs11_privkey_status(3)
API function
gnutls_pkcs11_reinit(3)
API function
gnutls_pkcs11_set_pin_function(3)
API function
gnutls_pkcs11_set_token_function(3)
API function
gnutls_pkcs11_token_get_flags(3)
API function
gnutls_pkcs11_token_get_info(3)
API function
gnutls_pkcs11_token_get_mechanism(3)
API function
gnutls_pkcs11_token_get_random(3)
API function
gnutls_pkcs11_token_get_url(3)
API function
gnutls_pkcs11_token_init(3)
API function
gnutls_pkcs11_token_set_pin(3)
API function
gnutls_pkcs11_type_get_name(3)
API function
gnutls_pkcs12_bag_decrypt(3)
API function
gnutls_pkcs12_bag_deinit(3)
API function
gnutls_pkcs12_bag_enc_info(3)
API function
gnutls_pkcs12_bag_encrypt(3)
API function
gnutls_pkcs12_bag_get_count(3)
API function
gnutls_pkcs12_bag_get_data(3)
API function
gnutls_pkcs12_bag_get_friendly_name(3)
API function
gnutls_pkcs12_bag_get_key_id(3)
API function
gnutls_pkcs12_bag_get_type(3)
API function
gnutls_pkcs12_bag_init(3)
API function
gnutls_pkcs12_bag_set_crl(3)
API function
gnutls_pkcs12_bag_set_crt(3)
API function
gnutls_pkcs12_bag_set_data(3)
API function
gnutls_pkcs12_bag_set_friendly_name(3)
API function
gnutls_pkcs12_bag_set_key_id(3)
API function
gnutls_pkcs12_bag_set_privkey(3)
API function
gnutls_pkcs12_deinit(3)
API function
gnutls_pkcs12_export(3)
API function
gnutls_pkcs12_export2(3)
API function
gnutls_pkcs12_generate_mac(3)
API function
gnutls_pkcs12_generate_mac2(3)
API function
gnutls_pkcs12_get_bag(3)
API function
gnutls_pkcs12_import(3)
API function
gnutls_pkcs12_init(3)
API function
gnutls_pkcs12_mac_info(3)
API function
gnutls_pkcs12_set_bag(3)
API function
gnutls_pkcs12_simple_parse(3)
API function
gnutls_pkcs12_verify_mac(3)
API function
gnutls_pkcs7_add_attr(3)
API function
gnutls_pkcs7_attrs_deinit(3)
API function
gnutls_pkcs7_deinit(3)
API function
gnutls_pkcs7_delete_crl(3)
API function
gnutls_pkcs7_delete_crt(3)
API function
gnutls_pkcs7_export(3)
API function
gnutls_pkcs7_export2(3)
API function
gnutls_pkcs7_get_attr(3)
API function
gnutls_pkcs7_get_crl_count(3)
API function
gnutls_pkcs7_get_crl_raw(3)
API function
gnutls_pkcs7_get_crl_raw2(3)
API function
gnutls_pkcs7_get_crt_count(3)
API function
gnutls_pkcs7_get_crt_raw(3)
API function
gnutls_pkcs7_get_crt_raw2(3)
API function
gnutls_pkcs7_get_embedded_data(3)
API function
gnutls_pkcs7_get_embedded_data_oid(3)
API function
gnutls_pkcs7_get_signature_count(3)
API function
gnutls_pkcs7_get_signature_info(3)
API function
gnutls_pkcs7_import(3)
API function
gnutls_pkcs7_init(3)
API function
gnutls_pkcs7_print(3)
API function
gnutls_pkcs7_set_crl(3)
API function
gnutls_pkcs7_set_crl_raw(3)
API function
gnutls_pkcs7_set_crt(3)
API function
gnutls_pkcs7_set_crt_raw(3)
API function
gnutls_pkcs7_sign(3)
API function
gnutls_pkcs7_signature_info_deinit(3)
API function
gnutls_pkcs7_verify(3)
API function
gnutls_pkcs7_verify_direct(3)
API function
gnutls_pkcs8_info(3)
API function
gnutls_pkcs_schema_get_name(3)
API function
gnutls_pkcs_schema_get_oid(3)
API function
gnutls_prf(3)
API function
gnutls_prf_raw(3)
API function
gnutls_prf_rfc5705(3)
API function
gnutls_priority_certificate_type_list(3)
API function
gnutls_priority_cipher_list(3)
API function
gnutls_priority_compression_list(3)
API function
gnutls_priority_deinit(3)
API function
gnutls_priority_ecc_curve_list(3)
API function
gnutls_priority_get_cipher_suite_index(3)
API function
gnutls_priority_init(3)
API function
gnutls_priority_kx_list(3)
API function
gnutls_priority_mac_list(3)
API function
gnutls_priority_protocol_list(3)
API function
gnutls_priority_set(3)
API function
gnutls_priority_set_direct(3)
API function
gnutls_priority_sign_list(3)
API function
gnutls_priority_string_list(3)
API function
gnutls_privkey_decrypt_data(3)
API function
gnutls_privkey_deinit(3)
API function
gnutls_privkey_export_dsa_raw(3)
API function
gnutls_privkey_export_ecc_raw(3)
API function
gnutls_privkey_export_openpgp(3)
API function
gnutls_privkey_export_pkcs11(3)
API function
gnutls_privkey_export_rsa_raw(3)
API function
gnutls_privkey_export_x509(3)
API function
gnutls_privkey_generate(3)
API function
gnutls_privkey_generate2(3)
API function
gnutls_privkey_get_pk_algorithm(3)
API function
gnutls_privkey_get_seed(3)
API function
gnutls_privkey_get_type(3)
API function
gnutls_privkey_import_dsa_raw(3)
API function
gnutls_privkey_import_ecc_raw(3)
API function
gnutls_privkey_import_ext(3)
API function
gnutls_privkey_import_ext2(3)
API function
gnutls_privkey_import_ext3(3)
API function
gnutls_privkey_import_openpgp(3)
API function
gnutls_privkey_import_openpgp_raw(3)
API function
gnutls_privkey_import_pkcs11(3)
API function
gnutls_privkey_import_pkcs11_url(3)
API function
gnutls_privkey_import_rsa_raw(3)
API function
gnutls_privkey_import_tpm_raw(3)
API function
gnutls_privkey_import_tpm_url(3)
API function
gnutls_privkey_import_url(3)
API function
gnutls_privkey_import_x509(3)
API function
gnutls_privkey_import_x509_raw(3)
API function
gnutls_privkey_init(3)
API function
gnutls_privkey_set_flags(3)
API function
gnutls_privkey_set_pin_function(3)
API function
gnutls_privkey_sign_data(3)
API function
gnutls_privkey_sign_hash(3)
API function
gnutls_privkey_status(3)
API function
gnutls_privkey_verify_params(3)
API function
gnutls_privkey_verify_seed(3)
API function
gnutls_protocol_get_id(3)
API function
gnutls_protocol_get_name(3)
API function
gnutls_protocol_get_version(3)
API function
gnutls_protocol_list(3)
API function
gnutls_psk_allocate_client_credentials(3)
API function
gnutls_psk_allocate_server_credentials(3)
API function
gnutls_psk_client_get_hint(3)
API function
gnutls_psk_free_client_credentials(3)
API function
gnutls_psk_free_server_credentials(3)
API function
gnutls_psk_server_get_username(3)
API function
gnutls_psk_set_client_credentials(3)
API function
gnutls_psk_set_client_credentials_function(3)
API function
gnutls_psk_set_params_function(3)
API function
gnutls_psk_set_server_credentials_file(3)
API function
gnutls_psk_set_server_credentials_function(3)
API function
gnutls_psk_set_server_credentials_hint(3)
API function
gnutls_psk_set_server_dh_params(3)
API function
gnutls_psk_set_server_known_dh_params(3)
API function
gnutls_psk_set_server_params_function(3)
API function
gnutls_pubkey_deinit(3)
API function
gnutls_pubkey_encrypt_data(3)
API function
gnutls_pubkey_export(3)
API function
gnutls_pubkey_export2(3)
API function
gnutls_pubkey_export_dsa_raw(3)
API function
gnutls_pubkey_export_ecc_raw(3)
API function
gnutls_pubkey_export_ecc_x962(3)
API function
gnutls_pubkey_export_rsa_raw(3)
API function
gnutls_pubkey_get_key_id(3)
API function
gnutls_pubkey_get_key_usage(3)
API function
gnutls_pubkey_get_openpgp_key_id(3)
API function
gnutls_pubkey_get_pk_algorithm(3)
API function
gnutls_pubkey_get_preferred_hash_algorithm(3)
API function
gnutls_pubkey_import(3)
API function
gnutls_pubkey_import_dsa_raw(3)
API function
gnutls_pubkey_import_ecc_raw(3)
API function
gnutls_pubkey_import_ecc_x962(3)
API function
gnutls_pubkey_import_openpgp(3)
API function
gnutls_pubkey_import_openpgp_raw(3)
API function
gnutls_pubkey_import_pkcs11(3)
API function
gnutls_pubkey_import_privkey(3)
API function
gnutls_pubkey_import_rsa_raw(3)
API function
gnutls_pubkey_import_tpm_raw(3)
API function
gnutls_pubkey_import_tpm_url(3)
API function
gnutls_pubkey_import_url(3)
API function
gnutls_pubkey_import_x509(3)
API function
gnutls_pubkey_import_x509_crq(3)
API function
gnutls_pubkey_import_x509_raw(3)
API function
gnutls_pubkey_init(3)
API function
gnutls_pubkey_print(3)
API function
gnutls_pubkey_set_key_usage(3)
API function
gnutls_pubkey_set_pin_function(3)
API function
gnutls_pubkey_verify_data2(3)
API function
gnutls_pubkey_verify_hash2(3)
API function
gnutls_pubkey_verify_params(3)
API function
gnutls_random_art(3)
API function
gnutls_range_split(3)
API function
gnutls_record_can_use_length_hiding(3)
API function
gnutls_record_check_corked(3)
API function
gnutls_record_check_pending(3)
API function
gnutls_record_cork(3)
API function
gnutls_record_disable_padding(3)
API function
gnutls_record_discard_queued(3)
API function
gnutls_record_get_direction(3)
API function
gnutls_record_get_discarded(3)
API function
gnutls_record_get_max_size(3)
API function
gnutls_record_get_state(3)
API function
gnutls_record_overhead_size(3)
API function
gnutls_record_recv(3)
API function
gnutls_record_recv_packet(3)
API function
gnutls_record_recv_seq(3)
API function
gnutls_record_send(3)
API function
gnutls_record_send_range(3)
API function
gnutls_record_set_max_size(3)
API function
gnutls_record_set_state(3)
API function
gnutls_record_set_timeout(3)
API function
gnutls_record_uncork(3)
API function
gnutls_register_custom_url(3)
API function
gnutls_rehandshake(3)
API function
gnutls_rnd(3)
API function
gnutls_rnd_refresh(3)
API function
gnutls_safe_renegotiation_status(3)
API function
gnutls_sec_param_get_name(3)
API function
gnutls_sec_param_to_pk_bits(3)
API function
gnutls_sec_param_to_symmetric_bits(3)
API function
gnutls_server_name_get(3)
API function
gnutls_server_name_set(3)
API function
gnutls_session_channel_binding(3)
API function
gnutls_session_enable_compatibility_mode(3)
API function
gnutls_session_etm_status(3)
API function
gnutls_session_ext_master_secret_status(3)
API function
gnutls_session_ext_register(3)
API function
gnutls_session_force_valid(3)
API function
gnutls_session_get_data(3)
API function
gnutls_session_get_data2(3)
API function
gnutls_session_get_desc(3)
API function
gnutls_session_get_flags(3)
API function
gnutls_session_get_id(3)
API function
gnutls_session_get_id2(3)
API function
gnutls_session_get_master_secret(3)
API function
gnutls_session_get_ptr(3)
API function
gnutls_session_get_random(3)
API function
gnutls_session_get_verify_cert_status(3)
API function
gnutls_session_is_resumed(3)
API function
gnutls_session_resumption_requested(3)
API function
gnutls_session_set_data(3)
API function
gnutls_session_set_id(3)
API function
gnutls_session_set_premaster(3)
API function
gnutls_session_set_ptr(3)
API function
gnutls_session_set_verify_cert(3)
API function
gnutls_session_set_verify_cert2(3)
API function
gnutls_session_set_verify_function(3)
API function
gnutls_session_supplemental_register(3)
API function
gnutls_session_ticket_enable_client(3)
API function
gnutls_session_ticket_enable_server(3)
API function
gnutls_session_ticket_key_generate(3)
API function
gnutls_set_default_priority(3)
API function
gnutls_sign_algorithm_get(3)
API function
gnutls_sign_algorithm_get_client(3)
API function
gnutls_sign_algorithm_get_requested(3)
API function
gnutls_sign_get_hash_algorithm(3)
API function
gnutls_sign_get_id(3)
API function
gnutls_sign_get_name(3)
API function
gnutls_sign_get_oid(3)
API function
gnutls_sign_get_pk_algorithm(3)
API function
gnutls_sign_is_secure(3)
API function
gnutls_sign_list(3)
API function
gnutls_srp_allocate_client_credentials(3)
API function
gnutls_srp_allocate_server_credentials(3)
API function
gnutls_srp_base64_decode(3)
API function
gnutls_srp_base64_decode2(3)
API function
gnutls_srp_base64_encode(3)
API function
gnutls_srp_base64_encode2(3)
API function
gnutls_srp_free_client_credentials(3)
API function
gnutls_srp_free_server_credentials(3)
API function
gnutls_srp_server_get_username(3)
API function
gnutls_srp_set_client_credentials(3)
API function
gnutls_srp_set_client_credentials_function(3)
API function
gnutls_srp_set_prime_bits(3)
API function
gnutls_srp_set_server_credentials_file(3)
API function
gnutls_srp_set_server_credentials_function(3)
API function
gnutls_srp_set_server_fake_salt_seed(3)
API function
gnutls_srp_verifier(3)
API function
gnutls_srtp_get_keys(3)
API function
gnutls_srtp_get_mki(3)
API function
gnutls_srtp_get_profile_id(3)
API function
gnutls_srtp_get_profile_name(3)
API function
gnutls_srtp_get_selected_profile(3)
API function
gnutls_srtp_set_mki(3)
API function
gnutls_srtp_set_profile(3)
API function
gnutls_srtp_set_profile_direct(3)
API function
gnutls_store_commitment(3)
API function
gnutls_store_pubkey(3)
API function
gnutls_strerror(3)
API function
gnutls_strerror_name(3)
API function
gnutls_subject_alt_names_deinit(3)
API function
gnutls_subject_alt_names_get(3)
API function
gnutls_subject_alt_names_init(3)
API function
gnutls_subject_alt_names_set(3)
API function
gnutls_supplemental_get_name(3)
API function
gnutls_supplemental_recv(3)
API function
gnutls_supplemental_register(3)
API function
gnutls_supplemental_send(3)
API function
gnutls_system_key_add_x509(3)
API function
gnutls_system_key_delete(3)
API function
gnutls_system_key_iter_deinit(3)
API function
gnutls_system_key_iter_get_info(3)
API function
gnutls_system_recv_timeout(3)
API function
gnutls_tdb_deinit(3)
API function
gnutls_tdb_init(3)
API function
gnutls_tdb_set_store_commitment_func(3)
API function
gnutls_tdb_set_store_func(3)
API function
gnutls_tdb_set_verify_func(3)
API function
gnutls_tpm_get_registered(3)
API function
gnutls_tpm_key_list_deinit(3)
API function
gnutls_tpm_key_list_get_url(3)
API function
gnutls_tpm_privkey_delete(3)
API function
gnutls_tpm_privkey_generate(3)
API function
gnutls_transport_get_int(3)
API function
gnutls_transport_get_int2(3)
API function
gnutls_transport_get_ptr(3)
API function
gnutls_transport_get_ptr2(3)
API function
gnutls_transport_set_errno(3)
API function
gnutls_transport_set_errno_function(3)
API function
gnutls_transport_set_fastopen(3)
API function
gnutls_transport_set_int(3)
API function
gnutls_transport_set_int2(3)
API function
gnutls_transport_set_ptr(3)
API function
gnutls_transport_set_ptr2(3)
API function
gnutls_transport_set_pull_function(3)
API function
gnutls_transport_set_pull_timeout_function(3)
API function
gnutls_transport_set_push_function(3)
API function
gnutls_transport_set_vec_push_function(3)
API function
gnutls_url_is_supported(3)
API function
gnutls_utf8_password_normalize(3)
API function
gnutls_verify_stored_pubkey(3)
API function
gnutls_x509_aia_deinit(3)
API function
gnutls_x509_aia_get(3)
API function
gnutls_x509_aia_init(3)
API function
gnutls_x509_aia_set(3)
API function
gnutls_x509_aki_deinit(3)
API function
gnutls_x509_aki_get_cert_issuer(3)
API function
gnutls_x509_aki_get_id(3)
API function
gnutls_x509_aki_init(3)
API function
gnutls_x509_aki_set_cert_issuer(3)
API function
gnutls_x509_aki_set_id(3)
API function
gnutls_x509_cidr_to_rfc5280(3)
API function
gnutls_x509_crl_check_issuer(3)
API function
gnutls_x509_crl_deinit(3)
API function
gnutls_x509_crl_dist_points_deinit(3)
API function
gnutls_x509_crl_dist_points_get(3)
API function
gnutls_x509_crl_dist_points_init(3)
API function
gnutls_x509_crl_dist_points_set(3)
API function
gnutls_x509_crl_export(3)
API function
gnutls_x509_crl_export2(3)
API function
gnutls_x509_crl_get_authority_key_gn_serial(3)
API function
gnutls_x509_crl_get_authority_key_id(3)
API function
gnutls_x509_crl_get_crt_count(3)
API function
gnutls_x509_crl_get_crt_serial(3)
API function
gnutls_x509_crl_get_dn_oid(3)
API function
gnutls_x509_crl_get_extension_data(3)
API function
gnutls_x509_crl_get_extension_data2(3)
API function
gnutls_x509_crl_get_extension_info(3)
API function
gnutls_x509_crl_get_extension_oid(3)
API function
gnutls_x509_crl_get_issuer_dn(3)
API function
gnutls_x509_crl_get_issuer_dn2(3)
API function
gnutls_x509_crl_get_issuer_dn3(3)
API function
gnutls_x509_crl_get_issuer_dn_by_oid(3)
API function
gnutls_x509_crl_get_next_update(3)
API function
gnutls_x509_crl_get_number(3)
API function
gnutls_x509_crl_get_raw_issuer_dn(3)
API function
gnutls_x509_crl_get_signature(3)
API function
gnutls_x509_crl_get_signature_algorithm(3)
API function
gnutls_x509_crl_get_signature_oid(3)
API function
gnutls_x509_crl_get_this_update(3)
API function
gnutls_x509_crl_get_version(3)
API function
gnutls_x509_crl_import(3)
API function
gnutls_x509_crl_init(3)
API function
gnutls_x509_crl_iter_crt_serial(3)
API function
gnutls_x509_crl_iter_deinit(3)
API function
gnutls_x509_crl_list_import(3)
API function
gnutls_x509_crl_list_import2(3)
API function
gnutls_x509_crl_print(3)
API function
gnutls_x509_crl_privkey_sign(3)
API function
gnutls_x509_crl_set_authority_key_id(3)
API function
gnutls_x509_crl_set_crt(3)
API function
gnutls_x509_crl_set_crt_serial(3)
API function
gnutls_x509_crl_set_next_update(3)
API function
gnutls_x509_crl_set_number(3)
API function
gnutls_x509_crl_set_this_update(3)
API function
gnutls_x509_crl_set_version(3)
API function
gnutls_x509_crl_sign(3)
API function
gnutls_x509_crl_sign2(3)
API function
gnutls_x509_crl_verify(3)
API function
gnutls_x509_crq_deinit(3)
API function
gnutls_x509_crq_export(3)
API function
gnutls_x509_crq_export2(3)
API function
gnutls_x509_crq_get_attribute_by_oid(3)
API function
gnutls_x509_crq_get_attribute_data(3)
API function
gnutls_x509_crq_get_attribute_info(3)
API function
gnutls_x509_crq_get_basic_constraints(3)
API function
gnutls_x509_crq_get_challenge_password(3)
API function
gnutls_x509_crq_get_dn(3)
API function
gnutls_x509_crq_get_dn2(3)
API function
gnutls_x509_crq_get_dn3(3)
API function
gnutls_x509_crq_get_dn_by_oid(3)
API function
gnutls_x509_crq_get_dn_oid(3)
API function
gnutls_x509_crq_get_extension_by_oid(3)
API function
gnutls_x509_crq_get_extension_by_oid2(3)
API function
gnutls_x509_crq_get_extension_data(3)
API function
gnutls_x509_crq_get_extension_data2(3)
API function
gnutls_x509_crq_get_extension_info(3)
API function
gnutls_x509_crq_get_key_id(3)
API function
gnutls_x509_crq_get_key_purpose_oid(3)
API function
gnutls_x509_crq_get_key_rsa_raw(3)
API function
gnutls_x509_crq_get_key_usage(3)
API function
gnutls_x509_crq_get_pk_algorithm(3)
API function
gnutls_x509_crq_get_pk_oid(3)
API function
gnutls_x509_crq_get_private_key_usage_period(3)
API function
gnutls_x509_crq_get_signature_algorithm(3)
API function
gnutls_x509_crq_get_signature_oid(3)
API function
gnutls_x509_crq_get_subject_alt_name(3)
API function
gnutls_x509_crq_get_subject_alt_othername_oid(3)
API function
gnutls_x509_crq_get_tlsfeatures(3)
API function
gnutls_x509_crq_get_version(3)
API function
gnutls_x509_crq_import(3)
API function
gnutls_x509_crq_init(3)
API function
gnutls_x509_crq_print(3)
API function
gnutls_x509_crq_privkey_sign(3)
API function
gnutls_x509_crq_set_attribute_by_oid(3)
API function
gnutls_x509_crq_set_basic_constraints(3)
API function
gnutls_x509_crq_set_challenge_password(3)
API function
gnutls_x509_crq_set_dn(3)
API function
gnutls_x509_crq_set_dn_by_oid(3)
API function
gnutls_x509_crq_set_extension_by_oid(3)
API function
gnutls_x509_crq_set_key(3)
API function
gnutls_x509_crq_set_key_purpose_oid(3)
API function
gnutls_x509_crq_set_key_rsa_raw(3)
API function
gnutls_x509_crq_set_key_usage(3)
API function
gnutls_x509_crq_set_private_key_usage_period(3)
API function
gnutls_x509_crq_set_pubkey(3)
API function
gnutls_x509_crq_set_subject_alt_name(3)
API function
gnutls_x509_crq_set_subject_alt_othername(3)
API function
gnutls_x509_crq_set_tlsfeatures(3)
API function
gnutls_x509_crq_set_version(3)
API function
gnutls_x509_crq_sign(3)
API function
gnutls_x509_crq_sign2(3)
API function
gnutls_x509_crq_verify(3)
API function
gnutls_x509_crt_check_email(3)
API function
gnutls_x509_crt_check_hostname(3)
API function
gnutls_x509_crt_check_hostname2(3)
API function
gnutls_x509_crt_check_issuer(3)
API function
gnutls_x509_crt_check_key_purpose(3)
API function
gnutls_x509_crt_check_revocation(3)
API function
gnutls_x509_crt_cpy_crl_dist_points(3)
API function
gnutls_x509_crt_deinit(3)
API function
gnutls_x509_crt_equals(3)
This function compares two gnutls_x509_crt_t certificates
gnutls_x509_crt_equals2(3)
This function compares a gnutls_x509_crt_t cert with DER data
gnutls_x509_crt_export(3)
API function
gnutls_x509_crt_export2(3)
API function
gnutls_x509_crt_get_activation_time(3)
API function
gnutls_x509_crt_get_authority_info_access(3)
API function
gnutls_x509_crt_get_authority_key_gn_serial(3)
API function
gnutls_x509_crt_get_authority_key_id(3)
API function
gnutls_x509_crt_get_basic_constraints(3)
API function
gnutls_x509_crt_get_ca_status(3)
API function
gnutls_x509_crt_get_crl_dist_points(3)
API function
gnutls_x509_crt_get_dn(3)
API function
gnutls_x509_crt_get_dn2(3)
API function
gnutls_x509_crt_get_dn3(3)
API function
gnutls_x509_crt_get_dn_by_oid(3)
API function
gnutls_x509_crt_get_dn_oid(3)
API function
gnutls_x509_crt_get_expiration_time(3)
API function
gnutls_x509_crt_get_extension_by_oid(3)
API function
gnutls_x509_crt_get_extension_by_oid2(3)
API function
gnutls_x509_crt_get_extension_data(3)
API function
gnutls_x509_crt_get_extension_data2(3)
API function
gnutls_x509_crt_get_extension_info(3)
API function
gnutls_x509_crt_get_extension_oid(3)
API function
gnutls_x509_crt_get_fingerprint(3)
API function
gnutls_x509_crt_get_issuer(3)
API function
gnutls_x509_crt_get_issuer_alt_name(3)
API function
gnutls_x509_crt_get_issuer_alt_name2(3)
API function
gnutls_x509_crt_get_issuer_alt_othername_oid(3)
API function
gnutls_x509_crt_get_issuer_dn(3)
API function
gnutls_x509_crt_get_issuer_dn2(3)
API function
gnutls_x509_crt_get_issuer_dn3(3)
API function
gnutls_x509_crt_get_issuer_dn_by_oid(3)
API function
gnutls_x509_crt_get_issuer_dn_oid(3)
API function
gnutls_x509_crt_get_issuer_unique_id(3)
API function
gnutls_x509_crt_get_key_id(3)
API function
gnutls_x509_crt_get_key_purpose_oid(3)
API function
gnutls_x509_crt_get_key_usage(3)
API function
gnutls_x509_crt_get_name_constraints(3)
API function
gnutls_x509_crt_get_pk_algorithm(3)
API function
gnutls_x509_crt_get_pk_dsa_raw(3)
API function
gnutls_x509_crt_get_pk_ecc_raw(3)
API function
gnutls_x509_crt_get_pk_oid(3)
API function
gnutls_x509_crt_get_pk_rsa_raw(3)
API function
gnutls_x509_crt_get_policy(3)
API function
gnutls_x509_crt_get_preferred_hash_algorithm(3)
API function
gnutls_x509_crt_get_private_key_usage_period(3)
API function
gnutls_x509_crt_get_proxy(3)
API function
gnutls_x509_crt_get_raw_dn(3)
API function
gnutls_x509_crt_get_raw_issuer_dn(3)
API function
gnutls_x509_crt_get_serial(3)
API function
gnutls_x509_crt_get_signature(3)
API function
gnutls_x509_crt_get_signature_algorithm(3)
API function
gnutls_x509_crt_get_signature_oid(3)
API function
gnutls_x509_crt_get_subject(3)
API function
gnutls_x509_crt_get_subject_alt_name(3)
API function
gnutls_x509_crt_get_subject_alt_name2(3)
API function
gnutls_x509_crt_get_subject_alt_othername_oid(3)
API function
gnutls_x509_crt_get_subject_key_id(3)
API function
gnutls_x509_crt_get_subject_unique_id(3)
API function
gnutls_x509_crt_get_tlsfeatures(3)
API function
gnutls_x509_crt_get_version(3)
API function
gnutls_x509_crt_import(3)
API function
gnutls_x509_crt_import_pkcs11(3)
API function
gnutls_x509_crt_import_url(3)
API function
gnutls_x509_crt_init(3)
API function
gnutls_x509_crt_list_import(3)
API function
gnutls_x509_crt_list_import2(3)
API function
gnutls_x509_crt_list_import_pkcs11(3)
API function
gnutls_x509_crt_list_verify(3)
API function
gnutls_x509_crt_print(3)
API function
gnutls_x509_crt_privkey_sign(3)
API function
gnutls_x509_crt_set_activation_time(3)
API function
gnutls_x509_crt_set_authority_info_access(3)
API function
gnutls_x509_crt_set_authority_key_id(3)
API function
gnutls_x509_crt_set_basic_constraints(3)
API function
gnutls_x509_crt_set_ca_status(3)
API function
gnutls_x509_crt_set_crl_dist_points(3)
API function
gnutls_x509_crt_set_crl_dist_points2(3)
API function
gnutls_x509_crt_set_crq(3)
API function
gnutls_x509_crt_set_crq_extension_by_oid(3)
API function
gnutls_x509_crt_set_crq_extensions(3)
API function
gnutls_x509_crt_set_dn(3)
API function
gnutls_x509_crt_set_dn_by_oid(3)
API function
gnutls_x509_crt_set_expiration_time(3)
API function
gnutls_x509_crt_set_extension_by_oid(3)
API function
gnutls_x509_crt_set_issuer_alt_name(3)
API function
gnutls_x509_crt_set_issuer_alt_othername(3)
API function
gnutls_x509_crt_set_issuer_dn(3)
API function
gnutls_x509_crt_set_issuer_dn_by_oid(3)
API function
gnutls_x509_crt_set_issuer_unique_id(3)
API function
gnutls_x509_crt_set_key(3)
API function
gnutls_x509_crt_set_key_purpose_oid(3)
API function
gnutls_x509_crt_set_key_usage(3)
API function
gnutls_x509_crt_set_name_constraints(3)
API function
gnutls_x509_crt_set_pin_function(3)
API function
gnutls_x509_crt_set_policy(3)
API function
gnutls_x509_crt_set_private_key_usage_period(3)
API function
gnutls_x509_crt_set_proxy(3)
API function
gnutls_x509_crt_set_proxy_dn(3)
API function
gnutls_x509_crt_set_pubkey(3)
API function
gnutls_x509_crt_set_serial(3)
API function
gnutls_x509_crt_set_subject_alt_name(3)
API function
gnutls_x509_crt_set_subject_alt_othername(3)
API function
gnutls_x509_crt_set_subject_alternative_name(3)
API function
gnutls_x509_crt_set_subject_key_id(3)
API function
gnutls_x509_crt_set_subject_unique_id(3)
API function
gnutls_x509_crt_set_tlsfeatures(3)
API function
gnutls_x509_crt_set_version(3)
API function
gnutls_x509_crt_sign(3)
API function
gnutls_x509_crt_sign2(3)
API function
gnutls_x509_crt_verify(3)
API function
gnutls_x509_crt_verify_data2(3)
API function
gnutls_x509_dn_deinit(3)
API function
gnutls_x509_dn_export(3)
API function
gnutls_x509_dn_export2(3)
API function
gnutls_x509_dn_get_rdn_ava(3)
API function
gnutls_x509_dn_get_str(3)
API function
gnutls_x509_dn_get_str2(3)
API function
gnutls_x509_dn_import(3)
API function
gnutls_x509_dn_init(3)
API function
gnutls_x509_dn_oid_known(3)
API function
gnutls_x509_dn_oid_name(3)
API function
gnutls_x509_dn_set_str(3)
API function
gnutls_x509_ext_deinit(3)
API function
gnutls_x509_ext_export_aia(3)
API function
gnutls_x509_ext_export_authority_key_id(3)
API function
gnutls_x509_ext_export_basic_constraints(3)
API function
gnutls_x509_ext_export_crl_dist_points(3)
API function
gnutls_x509_ext_export_key_purposes(3)
API function
gnutls_x509_ext_export_key_usage(3)
API function
gnutls_x509_ext_export_name_constraints(3)
API function
gnutls_x509_ext_export_policies(3)
API function
gnutls_x509_ext_export_private_key_usage_period(3)
API function
gnutls_x509_ext_export_proxy(3)
API function
gnutls_x509_ext_export_subject_alt_names(3)
API function
gnutls_x509_ext_export_subject_key_id(3)
API function
gnutls_x509_ext_export_tlsfeatures(3)
API function
gnutls_x509_ext_import_aia(3)
API function
gnutls_x509_ext_import_authority_key_id(3)
API function
gnutls_x509_ext_import_basic_constraints(3)
API function
gnutls_x509_ext_import_crl_dist_points(3)
API function
gnutls_x509_ext_import_key_purposes(3)
API function
gnutls_x509_ext_import_key_usage(3)
API function
gnutls_x509_ext_import_name_constraints(3)
API function
gnutls_x509_ext_import_policies(3)
API function
gnutls_x509_ext_import_private_key_usage_period(3)
API function
gnutls_x509_ext_import_proxy(3)
API function
gnutls_x509_ext_import_subject_alt_names(3)
API function
gnutls_x509_ext_import_subject_key_id(3)
API function
gnutls_x509_ext_import_tlsfeatures(3)
API function
gnutls_x509_ext_print(3)
API function
gnutls_x509_key_purpose_deinit(3)
API function
gnutls_x509_key_purpose_get(3)
API function
gnutls_x509_key_purpose_init(3)
API function
gnutls_x509_key_purpose_set(3)
API function
gnutls_x509_name_constraints_add_excluded(3)
API function
gnutls_x509_name_constraints_add_permitted(3)
API function
gnutls_x509_name_constraints_check(3)
API function
gnutls_x509_name_constraints_check_crt(3)
API function
gnutls_x509_name_constraints_deinit(3)
API function
gnutls_x509_name_constraints_get_excluded(3)
API function
gnutls_x509_name_constraints_get_permitted(3)
API function
gnutls_x509_name_constraints_init(3)
API function
gnutls_x509_othername_to_virtual(3)
API function
gnutls_x509_policies_deinit(3)
API function
gnutls_x509_policies_get(3)
API function
gnutls_x509_policies_init(3)
API function
gnutls_x509_policies_set(3)
API function
gnutls_x509_policy_release(3)
API function
gnutls_x509_privkey_cpy(3)
API function
gnutls_x509_privkey_deinit(3)
API function
gnutls_x509_privkey_export(3)
API function
gnutls_x509_privkey_export2(3)
API function
gnutls_x509_privkey_export2_pkcs8(3)
API function
gnutls_x509_privkey_export_dsa_raw(3)
API function
gnutls_x509_privkey_export_ecc_raw(3)
API function
gnutls_x509_privkey_export_pkcs8(3)
API function
gnutls_x509_privkey_export_rsa_raw(3)
API function
gnutls_x509_privkey_export_rsa_raw2(3)
API function
gnutls_x509_privkey_fix(3)
API function
gnutls_x509_privkey_generate(3)
API function
gnutls_x509_privkey_generate2(3)
API function
gnutls_x509_privkey_get_key_id(3)
API function
gnutls_x509_privkey_get_pk_algorithm(3)
API function
gnutls_x509_privkey_get_pk_algorithm2(3)
API function
gnutls_x509_privkey_get_seed(3)
API function
gnutls_x509_privkey_import(3)
API function
gnutls_x509_privkey_import2(3)
API function
gnutls_x509_privkey_import_dsa_raw(3)
API function
gnutls_x509_privkey_import_ecc_raw(3)
API function
gnutls_x509_privkey_import_openssl(3)
API function
gnutls_x509_privkey_import_pkcs8(3)
API function
gnutls_x509_privkey_import_rsa_raw(3)
API function
gnutls_x509_privkey_import_rsa_raw2(3)
API function
gnutls_x509_privkey_init(3)
API function
gnutls_x509_privkey_sec_param(3)
API function
gnutls_x509_privkey_set_flags(3)
API function
gnutls_x509_privkey_set_pin_function(3)
API function
gnutls_x509_privkey_sign_data(3)
API function
gnutls_x509_privkey_sign_hash(3)
API function
gnutls_x509_privkey_verify_params(3)
API function
gnutls_x509_privkey_verify_seed(3)
API function
gnutls_x509_rdn_get(3)
API function
gnutls_x509_rdn_get2(3)
API function
gnutls_x509_rdn_get_by_oid(3)
API function
gnutls_x509_rdn_get_oid(3)
API function
gnutls_x509_tlsfeatures_add(3)
API function
gnutls_x509_tlsfeatures_check_crt(3)
API function
gnutls_x509_tlsfeatures_deinit(3)
API function
gnutls_x509_tlsfeatures_get(3)
API function
gnutls_x509_tlsfeatures_init(3)
API function
gnutls_x509_trust_list_add_cas(3)
API function
gnutls_x509_trust_list_add_crls(3)
API function
gnutls_x509_trust_list_add_named_crt(3)
API function
gnutls_x509_trust_list_add_system_trust(3)
gnutls_x509_trust_list_add_system_trust
gnutls_x509_trust_list_add_trust_dir(3)
API function
gnutls_x509_trust_list_add_trust_file(3)
API function
gnutls_x509_trust_list_add_trust_mem(3)
API function
gnutls_x509_trust_list_deinit(3)
API function
gnutls_x509_trust_list_get_issuer(3)
API function
gnutls_x509_trust_list_get_issuer_by_dn(3)
API function
gnutls_x509_trust_list_get_issuer_by_subject_key_id(3)
API function
gnutls_x509_trust_list_init(3)
API function
gnutls_x509_trust_list_iter_deinit(3)
API function
gnutls_x509_trust_list_iter_get_ca(3)
API function
gnutls_x509_trust_list_remove_cas(3)
API function
gnutls_x509_trust_list_remove_trust_file(3)
API function
gnutls_x509_trust_list_remove_trust_mem(3)
API function
gnutls_x509_trust_list_verify_crt(3)
API function
gnutls_x509_trust_list_verify_crt2(3)
API function
gnutls_x509_trust_list_verify_named_crt(3)
API function
Goo::Environment(3)
Provide details about the environment The Goo is running in
Goo::TableInfo(3)
Provide meta details about MySQL tables
Google::Chart::Type::XY(3)
Google::Chart XY Line Type In charts of this type, each drawn line is defined by a pair of data sets, one of X coordinates and one for Y coordinates. See the API documentation at CW http://code.google.com/apis/chart/types.html#line_charts R for details.
Google::Checkout::General::ParameterizedUrls(3)
(DEPRECATED)
gpio_open, gpio_close, gpio_open_device, gpio_pin_config, gpio_pin_get, gpio_pin_high, gpio_pin_input, gpio_pin_invin, gpio_pin_invout, gpio_pin_list, gpio_pin_low, gpio_pin_opendrain, gpio_pin_output, gpio_pin_pulldown, gpio_pin_pullup, gpio_pin_pulsate, gpio_pin_pushpull, gpio_pin_set, gpio_pin_set_flags, gpio_pin_set_name, gpio_pin_tristate, gpio(3)
library to handle GPIO pins
Graph::Easy::Layout::Repair(3)
Repair spliced layout with group cells
GraphViz2::Filer(3)
Some utils to simplify testing and generating the demo page
GraphViz2::Utils(3)
Some utils to generate the demo page
Gravatar::URL(3)
Make URLs for Gravatars from an email address
gss_acquire_cred(3)
Obtain a GSS-API credential handle for pre-existing credentials
gss_add_cred(3)
Construct credentials incrementally
Gtk2::ActionGroup(3)
wrapper for GtkActionGroup NOTE: Translation In C, gtk+'s action groups can use the translation domain to ensure that action labels and tooltips are translated along with the rest of the app. However, the translation function was not available for calling by the Perl bindings until gtk+ 2.6; that is, setting the translation domain had no effect. Translation of action groups is supported in Perl as of Gtk2 1.080 using gtk+ 2.6.0 or later.
Gtk2::Ex::Dialogs(3)
Useful tools for Gnome2/Gtk2 Perl GUI design.
Gtk2::Ex::Utils(3)
Extra Gtk2 Utilities for working with Gnome2/Gtk2 in Perl.
Gtk2::ImageView::Tool(3)
Interface for objects capable of being used as tools by Gtk2::ImageView
Gtk2::ToolShell(3)
wrapper for GtkToolShell
Gtk2::TreeModelSort(3)
wrapper for GtkTreeModelSort
Gtk::objects, Gtk(3, 3pm)
enums, flags, object types, arguments and signals
gui_mouse_focus(3)
Tells if the input focus follows the mouse pointer. Allegro game programming library.
gui_strlen(3)
Returns the length of a string in pixels. Allegro game programming library.
Gungho::Component::Throttle::Provider(3)
Throttle Calls To The Provider
GunghoX::FollowLinks::Parser::Text(3)
Parse URLs Out Of Plain Text
GunghoX::FollowLinks::Rule::Fresh::Cache(3)
Store URLs In A Cache Of Your Choice
GunghoX::FollowLinks::Rule::Fresh::Memory(3)
Store URLs In Memory
Hash::MoreUtils(3)
Provide the stuff missing in Hash::Util
heimbase(3)
Heimbase Registers a DB type for use with heim_db_create(). Registers a DB type for use with heim_db_create(). heim_db_register Parameters: 4 dbtype Name of DB type data Private data argument to the dbtype's openf method plugin Structure with DB type methods (function pointers) Backends that provide begin/commit/rollback methods must provide ACID semantics. The registered DB type will have ACID semantics for backends that do not provide begin/commit/rollback methods but do provide lock/unlock and rdjournal/wrjournal methods (using a replay log journalling scheme). If the registered DB type does not natively provide read vs. write transaction isolation but does provide a lock method then the DB will provide read/write transaction isolation. Returns: 4 ENOMEM on failure, else 0. Open a database of the given dbtype. Database type names can be composed of one or more pseudo-DB types and one concrete DB type joined with a '+' between each. For example: 'transaction+bdb' might be a Berkeley DB with a layer above that provides transactions. Options may be provided via a dict (an associative array). Existing options include: o 2 o 2 o 2 o 2 o 2 o 2 Parameters: 4 dbtype Name of DB type dbname Name of DB (likely a file path) options Options dict db Output open DB handle error Output error object Returns: 4 a DB handle Clone (duplicate) an open DB handle. This is useful for multi-threaded applications. Applications must synchronize access to any given DB handle. Returns EBUSY if there is an open transaction for the input db. Parameters: 4 db Open DB handle error Output error object Returns: 4 a DB handle Open a transaction on the given db. Parameters: 4 db Open DB handle error Output error object Returns: 4 0 on success, system error otherwise Commit an open transaction on the given db. Parameters: 4 db Open DB handle error Output error object Returns: 4 0 on success, system error otherwise Rollback an open transaction on the given db. Parameters: 4 db Open DB handle error Output error object Returns: 4 0 on success, system error otherwise Get type ID of heim_db_t objects. Lookup a key's value in the DB. Returns 0 on success, -1 if the key does not exist in the DB, or a system error number on failure. Parameters: 4 db Open DB handle key Key error Output error object Returns: 4 the value (retained), if there is one for the given key Set a key's value in the DB. Parameters: 4 db Open DB handle key Key value Value (if NULL the key will be deleted, but empty is OK) error Output error object Returns: 4 0 on success, system error otherwise Delete a key and its value from the DB Parameters: 4 db Open DB handle key Key error Output error object Returns: 4 0 on success, system error otherwise Iterate a callback function over keys and values from a DB. Parameters: 4 db Open DB handle iter_data Callback function's private data iter_f Callback function, called once per-key/value pair error Output error object Get a node in a heim_object tree by path Parameters: 4 ptr tree error error (output) ap NULL-terminated va_list of heim_object_ts that form a path Returns: 4 object (not retained) if found Get a node in a tree by path, with retained reference Parameters: 4 ptr tree error error (output) ap NULL-terminated va_list of heim_object_ts that form a path Returns: 4 retained object if found Get a node in a tree by path Parameters: 4 ptr tree error error (output) ... NULL-terminated va_list of heim_object_ts that form a path Returns: 4 object (not retained) if found Get a node in a tree by path, with retained reference Parameters: 4 ptr tree error error (output) ... NULL-terminated va_list of heim_object_ts that form a path Returns: 4 retained object if found Create a path in a heim_object_t tree Parameters: 4 ptr the tree size the size of the heim_dict_t nodes to be created leaf leaf node to be added, if any error error (output) ap NULL-terminated of path component objects Create a path of heim_dict_t interior nodes in a given heim_object_t tree, as necessary, and set/replace a leaf, if given (if leaf is NULL then the leaf is not deleted). Returns: 4 0 on success, else a system error Create a path in a heim_object_t tree Parameters: 4 ptr the tree size the size of the heim_dict_t nodes to be created leaf leaf node to be added, if any error error (output) ... NULL-terminated list of path component objects Create a path of heim_dict_t interior nodes in a given heim_object_t tree, as necessary, and set/replace a leaf, if given (if leaf is NULL then the leaf is not deleted). Returns: 4 0 on success, else a system error Delete leaf node named by a path in a heim_object_t tree Parameters: 4 ptr the tree error error (output) ap NULL-terminated list of path component objects Dump a heimbase object to stderr (useful from the debugger!) Parameters: 4 obj object to dump using JSON or JSON-like format
htable, HTABLE_HEAD, HTABLE_COLLS, HTABLE_COUNT, HTABLE_EMPTY, HTABLE_ENTRY, HTABLE_FIRST, HTABLE_FOREACH, HTABLE_GENERATE, HTABLE_INIT, HTABLE_INITIALIZER, HTABLE_INSERT, HTABLE_LOAD, HTABLE_LOOKUP, HTABLE_NEXT, HTABLE_PROTOTYPE, HTABLE_REMOVE, HTABLE_SIZE, implementation(3)
of hash tables.
HTML::Breadcrumbs(3)
module to produce HTML 'breadcrumb trails'.
HTML::DOM::Element::TableCell(3)
A Perl class for representing table cells in an HTML DOM tree
HTML::FormFu::Filter::HTMLScrubber(3)
filter removing HTML markup
HTML::FormFu::Model(3)
base class for models
HTML::FormHandler::Field::Boolean(3)
a true or false field
HTML::FormHandler::Field::BoolSelect(3)
Boolean select field
HTML::FormHandler::I18N::ca_es(3)
Catalan message translations - traducion catalana dels missatges
HTML::Macro(3)
process HTML templates with loops, conditionals, macros and more!
HTML::Mason::Tools(3)
Function library used internally in Mason
HTML::Mason::Utils(3)
Publicly available functions useful outside of Mason
HTML::Prototype::Controls(3)
script.aculo.us controls library, embedded in perl
HTML::Shakan::Filter::HTMLScrubber(3)
HTML::Scrubber filter
HTML::Template::Compiled::Utils(3)
Utility functions for HTML::Template::Compiled
HTTP::MHTTP(3)
this library provides reasonably low level access to the HTTP protocol, for perl. This does not replace LWP (what possibly could :-) but is a cut for speed. It also supports all of HTTP 1.0, so you have GET, POST, PUT, HEAD, and DELETE. Some support of HTTP 1.1 is available - sepcifically Transfer-Encoding = chunked and the Keep-Alive extensions. Additionally - rudimentary SSL support can be compiled in. This effectively enables negotiation of TLS, but does not validate the certificates.
HTTP::WebTest::Utils(3)
Miscellaneous subroutines used by HTTP::WebTest
hwlocality_levels, hwloc_get_depth_type, hwloc_get_nbobjs_by_depth, hwloc_get_nbobjs_by_type, hwloc_get_next_obj_by_depth, hwloc_get_next_obj_by_type, hwloc_get_obj_by_depth, hwloc_get_obj_by_type, hwloc_get_root_obj, hwloc_get_type_depth, hwloc_get_type_depth_e, hwloc_get_type_or_above_depth, hwloc_get_type_or_below_depth, hwloc_topology_get_depth, HWLOC_TYPE_DEPTH_BRIDGE, HWLOC_TYPE_DEPTH_MULTIPLE, HWLOC_TYPE_DEPTH_OS_DEVICE, HWLOC_TYPE_DEPTH_PCI_DEVICE, HWLOC_TYPE_DEPTH_UNKNOWN(3)
Object levels, depths and types Enumerations +1c enum hwloc_get_type_depth_e { HWLOC_TYPE_DEPTH_UNKNOWN, HWLOC_TYPE_DEPTH_MULTIPLE, HWLOC_TYPE_DEPTH_BRIDGE, HWLOC_TYPE_DEPTH_PCI_DEVICE, HWLOC_TYPE_DEPTH_OS_DEVICE } -1c Functions +1c unsigned hwloc_topology_get_depth (hwloc_topology_t restrict topology) int hwloc_get_type_depth (hwloc_topology_t topology, hwloc_obj_type_t type) static int hwloc_get_type_or_below_depth (hwloc_topology_t topology, hwloc_obj_type_t type) static int hwloc_get_type_or_above_depth (hwloc_topology_t topology, hwloc_obj_type_t type) hwloc_obj_type_t hwloc_get_depth_type (hwloc_topology_t topology, unsigned depth) unsigned hwloc_get_nbobjs_by_depth (hwloc_topology_t topology, unsigned depth) static int hwloc_get_nbobjs_by_type (hwloc_topology_t topology, hwloc_obj_type_t type) static hwloc_obj_t hwloc_get_root_obj (hwloc_topology_t topology) hwloc_obj_t hwloc_get_obj_by_depth (hwloc_topology_t topology, unsigned depth, unsigned idx) static hwloc_obj_t hwloc_get_obj_by_type (hwloc_topology_t topology, hwloc_obj_type_t type, unsigned idx) static hwloc_obj_t hwloc_get_next_obj_by_depth (hwloc_topology_t topology, unsigned depth, hwloc_obj_t prev) static hwloc_obj_t hwloc_get_next_obj_by_type (hwloc_topology_t topology, hwloc_obj_type_t type, hwloc_obj_t prev) -1c
if(3)
"use" a Perl module if a condition holds (also can "no" a module)
Image::Compare::AVG_THRESHOLD(3)
Compare two images by the overall average color difference of their pixels.
Image::Compare::THRESHOLD(3)
Compare two images by by a maximum per-pixel color difference of their pixels.
Image::Math::Constrain(3)
Scaling math used in image size constraining (such as thumbnails)
Image::MetaData::JPEG::MakerNotes(3)
This document contains random information and details on MakerNotes; it is an appendix to the main manual page of the Image::MetaData::JPEG module, which the reader should refer to for further details and the general scope. The note on MakerNote parsing in the main manual page is of particular interest.
Image::MetaData::JPEG::Structures(3)
This document describes the structure of a JPEG file; it is an appendix to the main manual page of the Image::MetaData::JPEG module, which the reader should refer to for further details and the general scope.
Image::MetaData::JPEG::TagLists(3)
This document contains a collection of tag tables for JPEG segments; it is an appendix to the main manual page of the Image::MetaData::JPEG module, which the reader should refer to for further details and the general scope.
Image::Size::FillFullSelect(3)
Choose wether a image fill setting for a image should be fill or full.
Imager::ExtUtils(3)
functions handy in writing Imager extensions
Imager::Fountain, CW(3)
Imager::Fountain - a class for building fountain fills suitable for use by the fountain filter. R
Imager::Graph::Horizontal, CW(3)
Imager::Graph::Horizontal - A super class for line/bar charts R add_data_series(\@data, $series_name) 4 Add a data series to the graph, of the default type. add_bar_data_series(\@data, $series_name) 4 Add a bar data series to the graph. add_line_data_series(\@data, $series_name) 4 Add a line data series to the graph. set_column_padding($int) 4 Sets the number of pixels that should go between columns of data. set_negative_background($color) 4 Sets the background color or fill used below the y axis. draw() 4 Draw the graph 4 show_vertical_gridlines() 4 Shows vertical gridlines at the y-tics. Feature: vertical_gridlines set_vertical_gridline_style(color => ..., style => ...) 4 Set the color and style of the lines drawn for gridlines. Style equivalent: vgrid show_line_markers() 4 0 show_line_markers($value) 4 Feature: linemarkers. If $value is missing or true, draw markers on a line data series. Note: line markers are drawn by default. use_automatic_axis() 4 Automatically scale the Y axis, based on Chart::Math::Axis. If Chart::Math::Axis isn't installed, this sets an error and returns undef. Returns 1 if it is installed. set_x_tics($count) 4 Set the number of X tics to use. Their value and position will be determined by the data range. 4
Imager::ImageTypes(3)
image models for Imager
Importer(3)
Alternative but compatible interface to modules that export symbols.
inet(3)
Access to TCP/IP Protocols
initscr, delscreen, endwin, isendwin, newterm, set_term, curs_initscr(3, 3X)
curses screen initialization and manipulation routines
initscr, delscreen, endwin, isendwin, newterm, set_term, curs_initscr(3, 3X, 3x)
curses screen initialization and manipulation routines
INN::Utils::Shlock(3, 3pm)
Wrapper around the shlock program
install_int(3)
Installs a user timer handler. Allegro game programming library.
install_keyboard(3)
Installs the Allegro keyboard interrupt handler.
install_keyboard_hooks(3)
Installs custom keyboard hooks. Allegro game programming library.
INSTALL_lsame.f, lsame.f(3)
install_mouse(3)
Installs the Allegro mouse handler.
install_param_int(3)
Installs a timer routine with a customizable parameter. Allegro game programming library.
install_timer(3)
Installs the Allegro timer interrupt handler.
Interchange6::Schema::Manual::DatabaseSupport(3)
Details of database engine support for Interchange6
Internals(3)
Reserved special namespace for internals related functions
IO::All::FTP(3)
Extends IO::All to FTP URLs
IO::All::HTTP, IO::All::LWP(3)
Extends IO::All to HTTP URLs
IO::All::HTTPS(3)
Extends IO::All for HTTPS URLs
IO::Async::Protocol, "IO::Async::Protocol"(3)
base class for transport-based protocols
IO::Async::Protocol::LineStream, "IO::Async::Protocol::LineStream"(3)
stream-based protocols using lines of text
IO::Async::Protocol::Stream, "IO::Async::Protocol::Stream"(3)
base class for stream-based protocols
IO::Async::SSL, "IO::Async::SSL"(3)
use SSL/TLS with IO::Async
IO::Async::SSLStream, "IO::Async::SSLStream"(3)
read and write buffers around an SSL connection
IO::Async::Timer::Periodic, "IO::Async::Timer::Periodic"(3)
event callback at regular intervals
IO::Lambda::Signal(3)
wait for pids and signals
IO::Socket::SSL::Utils(3)
loading, storing, creating certificates and keys
IPA::Geometry(3)
mapping pixels from one location to another
IPA::Global(3)
methods that produce images where every pixel is a function of all pixels in the source image
IPA::Local(3)
methods that produce images where every pixel is a function of pixels in the neighborhood
IPA::Misc(3)
miscellaneous uncategorized routines split_channels IMAGE, [ MODE = 'rgb' ] 4 Splits IMAGE onto channels, with the selected MODE, which currently can be 'rgb' or 'hsv' string constants. Returns channels as anonymous array of image objects. 4 rgb 4 Supported types: RGB . Returns: 3 Byte images . hsv 4 Supported types: RGB . Returns: 3 float images - with hue, saturation, and value . Ranges: hue: 0-360, saturation: 0-1, value: 0-1 . 4 combine_channels [IMAGES], [ MODE = 'rgb' ] 4 Combines list of channel IMAGES into single image, with the selected MODE, which currently can be 'rgb' , 'hsv', 'alphaNUM' string constants. Returns the combined image. 4 rgb 4 Supported types: Byte . Returns: RGB image . hsv 4 Supported types: Float . Returns: RGB image . Channel ranges: hue: 0-360, saturation: 0-1, value: 0-1 alphaNUM 4 Supported types: RGB, Byte . Returns: Same type as input . NUM range: 0 - 255 . 4 histogram IMAGE 4 Returns array of 256 integers, each representing number of pixels with the corresponding value for IMAGE. Supported types: 8-bit
IPC::MM(3)
Perl interface to Ralf Engelschall's mm library
IPC::MMA(3)
Shared Memory using Ralf Engelschall's mm library
IPC::PerlSSH, "IPC::PerlSSH"(3)
execute remote perl code over an SSH link
IPC::PerlSSH::Base, "IPC::PerlSSH::Base"(3)
base functionallity behind IPC::PerlSSH
IPC::PerlSSH::Library, "IPC::PerlSSH::Library"(3)
support package for declaring libraries of remote functions
IPC::PerlSSH::Library::FS, "IPC::PerlSSH::Library::FS"(3)
a library of filesystem functions for "IPC::PerlSSH"
IPC::PerlSSH::Library::IO, "IPC::PerlSSH::Library::IO"(3)
a library of file IO functions for "IPC::PerlSSH"
IPC::PerlSSH::Library::Run, "IPC::PerlSSH::Library::Run"(3)
a library of command running functions for "IPC::PerlSSH"
IPC::PubSub(3)
Interprocess Publish/Subscribe channels
IPC::Run::IO(3)
I/O channels for IPC::Run.
IPC::Run::Timer(3)
Timer channels for IPC::Run.
IPC::Signal(3)
Utility functions dealing with signals
IPC::SysV(3)
System V IPC constants and system calls
IRC::Utils(3)
Common utilities for IRC-related tasks
is_inside_bitmap(3)
Tells if a point is inside a bitmap. Allegro game programming library.
is_linear_bitmap(3)
Tells if a bitmap is linear. Allegro game programming library.
is_memory_bitmap(3)
Tells if a bitmap is a memory bitmap. Allegro game programming library.
is_planar_bitmap(3)
Tells if a bitmap is a planar screen bitmap. Allegro game programming library.
is_same_bitmap(3)
Tells if two bitmaps describe the same drawing surface. Allegro game programming library.
is_screen_bitmap(3)
Tells if a bitmap is the screen bitmap or sub bitmap. Allegro game programming library.
is_sub_bitmap(3)
Tells if a bitmap is a sub bitmap. Allegro game programming library.
is_system_bitmap(3)
Tells if a bitmap is a system bitmap or sub bitmap. Allegro game programming library.
is_video_bitmap(3)
Tells if a bitmap is a screen bitmap, video memory or sub bitmap. Allegro game programming library.
is_windowed_mode(3)
Tells if you are running in windowed mode. Allegro game programming library.
isablequalexpr(3)
tests if two expressions are strictly identicals.
isablsimilarexpr(3)
tests if two expressions have the same morphology.
isck(3)
tells if a name is the pattern defined by the user
isvdd(3)
tells if a name contains the pattern defined by the user
isvss(3)
tells if a name contains the pattern defined by the user
iv_tls_user_register, iv_tls_user_ptr, iv_tls(3)
thread-local storage handling for ivykis modules
jail, jail_getid, jail_getname, jail_getv, jail_setv, jailparam_all, jailparam_export, jailparam_free, jailparam_get, jailparam_import, jailparam_import_raw, jailparam_init, jailparam_set, jailparam(3)
create and manage system jails
JAM_DelSubPacket(3)
Delete a subfield packet
JavaScript::RPC(3)
(DEPRECATED) Remote procedure calls from JavaScript
JavaScript::RPC::Server::CGI(3)
Remote procedure calls from JavaScript
Jifty::LetMe(3)
A way to expose single-link URLs to your applications new Create a new "LetMe" authentication object; it takes no parameters. It calls "_init" to do any initialization. A LetMe is a way to provide a one-time-use URL for a particular purpose. All LetMe objects give you a way to validate a user's identity and to allow them a very small set of possible actions or page-access permissions. For example, you can put a LetMe URL in an email to a new user, so that when they click on the URL you know that their email address is valid. _init @_ Called with whatever "new" was called with. By default, does nothing. user Contains an app-specific "user" object. validated_current_user If the user has presented a valid token, returns an (app-specific subclass of the) Jifty::CurrentUser object for the user who has the email address in $self->email. If no user has that email address, returns undef. _user_from_email ADDRESS Returns an (app-specific subclass of the) Jifty::CurrentUser object for the user who has the email address ADDRESS. generate_checksum Returns an authentication checksum for the current combination of: CW user path arguments until R generate_koremutake_checksum Generate a slightly more pronounceable version of the checksum using String::Koremutake. Due to hex -> integer limitations, this is imprecise and may vary depending on the platform it is used on; as such, it is deprecated. from_token PATH Parse a string of the form mylongusername@example.com/update_task/23/until/20050101/bekidrikufryvagygefuba into CW email => mylongusername@example.com, path => 'update_task/23' until => 20050101, checksum_provided => bekidrikufryvagygefuba R as_token Returns the "letme" token for this set of credentials. This should round trip cleanly with from_token as_encoded_token A variant of as_token that encodes the user's email address suitably for passing in a URL as_url Returns the fully qualified URL for this LetMe. It's composed of Jifty->web->url, "base_path" and "as_encoded_token" base_path By default, all "LetMe" actions live at URLs under '/let' inside your application. Override this subroutine to change that. By default, it returns '/let/' validate Returns true if the credentials the user presented validate OK. Returns false otherwise. _correct_checksum_provided Returns true if the checksum the user provided is correct. Doesn't actually do much input checking. You want to call "validate"
Jifty::Manual::Models(3)
Managing your datastore
Jifty::Manual::Style(3)
Jifty coding style guide Default style When in doubt, default to whatever Damian Conway's Perl Best Practices says. Private documentation When documenting a private method, or providing documentation which is not useful to the user of the module (and is presumably useful to the developer), wrap it in =begin/end private. This way it does not show up in perldoc where a user would see it and yet is still available and well formatted (that is, not just a lump comment) when looking at the code. CW =begin private =head2 import_extra Called by L<Test::More>'s C<import> code when L<Jifty::Test> is first C<use>'d, it calls L</setup>, and asks Test::More to export its symbols to the namespace that C<use>'d this one. =end private sub import_extra { ... } R Test temp files Files created by tests should be declared as such using Jifty::Test->test_file() so they are cleaned up on a successful test run. Use Shell::Command Shell::Command has a number of functions which work like common shell file commands such as "touch", "cp" and "mv". They are battle tested and cross-platform. Use them instead of coding your own. For example, instead of this: CW open my $file, ">foo"; close $file; R Do this: CW use Shell::Command; touch $file; R Case insensitive matching To check if a string equals another string case insensitively, do this CW lc $foo eq lc $bar; lc $foo eq 'bar'; R not this: CW $foo =~ /^\Q$bar\E/i; $foo =~ /^bar$/i; R
Jifty::Manual::Upgrading(3)
How-to change your application database over time DESCRIPTION Jifty provides a way for you to upgrade the database schema and data of your application between versions. If all you are doing is adding new models or columns to existing models Jifty will do the upgrade almost automatically. If more extensive changes are required you need to write some code to tell Jifty what to do.
Jifty::Model::SessionCollection(3)
Specialized handling of the session collection METHODS record_class This deals with collections of Jifty::Model::Sessions. current_user Everyone is treated as the superuser when dealing with session objects. This avoids infinite recursion, as otherwise it would try to look up the current user in the session object to find out who we are... expired_update find sessions where updated time is expired. expired_create find sessions where created time is expired.
Jifty::Notification(3)
Send emails from Jifty
Jifty::Plugin::REST::Dispatcher(3)
Dispatcher for REST plugin show_help Shows basic help about resources and formats available via this RESTful interface. show_help_specific Displays a help page about a specific topic. Will look for a method named "show_help_specific_$1". show_help_specific_search Explains /=/search/ a bit more in-depth. show_version Displays versions of the various bits of your application. list PREFIX items Takes a URL prefix and a set of items to render. passes them on. output_format [prefix] Returns the user's desired output format. Returns a hashref of: CW format: JSON, JS, YAML, XML, Perl, or HTML extension: json, js, yml, xml, pl, or html content_type: text/x-yaml; charset=UTF-8, etc. freezer: \&Jifty::YAML::Dump, etc. R outs PREFIX DATASTRUCTURE Takes a url path prefix and a data structure. Depending on what content types the other side of the HTTP connection can accept, renders the content as YAML, JSON, JavaScript, Perl, XML or HTML. render_as_xml DATASTRUCTURE Attempts to render DATASTRUCTURE as simple, tag-based XML. render_as_html PREFIX URL DATASTRUCTURE Attempts to render DATASTRUCTURE as simple semantic HTML suitable for humans to look at. html_dump DATASTRUCTURE Recursively render DATASTRUCTURE as some simple HTML "dl"s and "ol"s. html_dump_record Jifty::Record Returns a nice simple HTML definition list of the keys and values of a Jifty::Record object. action ACTION Canonicalizes ACTION into the class-name form preferred by Jifty by cleaning up casing, delimiters, etc. Throws an appropriate HTTP error code if the action is unavailable. model MODEL Canonicalizes MODEL into the class-name form preferred by Jifty by cleaning up casing, delimiters, etc. Throws an appropriate HTTP error code if the model is unavailable. list_models Sends the user a list of models in this application, with the names transformed from Perlish::Syntax to Everything.Else.Syntax valid_column Returns true if the column is a valid column to observe on the model list_model_columns Sends the user a nice list of all columns in a given model class. Exactly which model is shoved into $1 by the dispatcher. This should probably be improved. list_model_items MODELCLASS COLUMNNAME Returns a list of items in MODELCLASS sorted by COLUMNNAME, with only COLUMNNAME displayed. (This should have some limiting thrown in) show_item_field $model, $column, $key, $field Loads up a model of type $model which has a column $column with a value $key. Returns the value of $field for that object. Returns 404 if it doesn't exist. show_item $model, $column, $key Loads up a model of type $model which has a column $column with a value $key. Returns all columns for the object Returns 404 if it doesn't exist. search_items $model, [c1, v1, c2, v2, ...] [, $field] Loads up all models of type $model that match the given columns and values. If the column and value list has an odd count, then the last item is taken to be the output column. Otherwise, all items will be returned. Will throw a 404 if there were no matches, or $field was invalid. Pseudo-columns: __per_page => N 4 Return the collection as N records per page. __page => N 4 Return page N of the collection __order_by => "column" 4 Order by the given column, ascending. __order_by_desc => "column" 4 Order by the given column, descending. create_item Implemented by redispatching to a CreateModel action. replace_item Implemented by redispatching to a CreateModel or UpdateModel action. replace_item_field $model, $column, $key, $field Loads up a model of type $model which has a column $column with a value $key. Sets the value of the field based on the request payload. Returns 404 if it doesn't exist. delete_item Implemented by redispatching to a DeleteModel action. list_actions Returns a list of all actions visible to the current user. (Canonicalizes Perl::Style to Everything.Else.Style). list_action_params Takes a single parameter, $action, supplied by the dispatcher. Shows the user all possible parameters to the action. show_action_form $ACTION_CLASS Takes a single parameter, the class of an action. Shows the user an HTML form of the action's parameters to run that action. run_action Expects $1 to be the name of an action we want to run. Runs the action, with the HTTP arguments as its arguments. That is, it's not looking for Jifty-encoded (J:F) arguments. If you have an action called "MyApp::Action::Ping" that takes a parameter, "ip", this action will look for an HTTP argument called "ip", (not J:F-myaction-ip). Returns the action's result. TODO, doc the format of the result. On an invalid action name, throws a 404. On a disallowed action name, throws a 403. On an internal error, throws a 500.
Jifty::Plugin::User(3)
Plugin for building user models
Jifty::Schema(3)
generates and upgrades your application's schema new Returns a new Jifty::Schema. Takes no arguments. Will automatically figure out and initialize the models defined in the application's source. _init_model_list Reads in our application class from the config file and finds all our application's models. models Returns a list of Models available to your application. This includes your Models, Collections and those that come from core Jifty and plugins. serialize_current_schema Returns a serialization of the models in the app upgrade_schema Looks at the current schema as defined by the source code and the database and updates the database by adding, dropping, and renaming columns. run_upgrade_rules rule_name This method runs all upgrade rules for the rule named "rule_name". connect_to_db_for_management Returns a database handle suitable for direct manipulation.
Jifty::Util(3)
Things that don't fit anywhere else
Jifty::Web::Form(3)
Tools for rendering and dealing with HTML forms
JMX::Jmx4Perl::Agent::Jolokia::DownloadAgent(3)
Specialized LWP::UserAgent adding some bells and whistles for downloading agents and other stuff.
JSON::DWIW::Boolean(3)
Return a true or false value when evaluated in boolean context -- to be used with JSON::DWIW->encode() to explicitly specify a boolean value.`
JSON::RPC::Common::Marshal::HTTP(3)
Convert HTTP::Request and HTTP::Response to/from JSON::RPC::Common calls and returns.
Kafka::Internals(3)
Constants and functions used internally.
keyboard_needs_poll(3)
Tells if the keyboard needs polling. Allegro game programming library.
keypressed(3)
Tells if there are keypresses waiting in the input buffer. Allegro game programming library.
krb524_convert_creds_kdc, krb524_convert_creds_kdc_ccache(3)
converts Kerberos 5 credentials to Kerberos 4 credentials
krb524_convert_creds_kdc_ccache, krb5_v4compat, Heimdal(3)
Kerberos 4 compatiblity functions - Functions +1c KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb524_convert_creds_kdc (krb5_context context, krb5_creds *in_cred, struct credentials *v4creds) KRB5_DEPRECATED_FUNCTION('Use X instead') KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb524_convert_creds_kdc_ccache (krb5_context context, krb5_ccache ccache, krb5_creds *in_cred, struct credentials *v4creds) KRB5_DEPRECATED_FUNCTION('Use X instead') -1c
krb5_425_conv_principal, krb5_425_conv_principal_ext, krb5_524_conv_principal(3)
converts to and from version 4 principals
krb5_425_conv_principal, krb5_425_conv_principal_ext, krb5_524_conv_principal(3)
converts to and from version 4 principals
krb5_auth_context, krb5_auth_con_addflags, krb5_auth_con_free, krb5_auth_con_genaddrs, krb5_auth_con_generatelocalsubkey, krb5_auth_con_getaddrs, krb5_auth_con_getflags, krb5_auth_con_getkey, krb5_auth_con_getlocalsubkey, krb5_auth_con_getremotesubkey, krb5_auth_con_init, krb5_auth_con_initivector, krb5_auth_con_removeflags, krb5_auth_con_setaddrs, krb5_auth_con_setaddrs_from_fd, krb5_auth_con_setflags, krb5_auth_con_setivector, krb5_free_authenticator, krb5_auth_con_getauthenticator, krb5_auth_con_getrcache, krb5_auth_con_getuserkey, krb5_auth_con_setkey, krb5_auth_con_setlocalsubkey, krb5_auth_con_setrcache, krb5_auth_con_setremotesubkey, krb5_auth_con_setuserkey, krb5_auth_getcksumtype, krb5_auth_getkeytype, krb5_auth_getlocalseqnumber, krb5_auth_setcksumtype, krb5_auth_setkeytype, krb5_auth_setlocalseqnumber, krb5_auth_setremoteseqnumber, krb5_auth_getremoteseqnumber(3)
manage authentication on connection level
krb5_auth_context, krb5_auth_con_free, krb5_auth_con_genaddrs, krb5_auth_con_getaddrs, krb5_auth_con_getflags, krb5_auth_con_getkey, krb5_auth_con_getlocalsubkey, krb5_auth_con_getremotesubkey, krb5_auth_con_init, krb5_auth_con_initivector, krb5_auth_con_setaddrs, krb5_auth_con_setaddrs_from_fd, krb5_auth_con_setflags, krb5_auth_con_setivector, krb5_auth_con_getrcache, krb5_auth_con_getuserkey, krb5_auth_con_setkey, krb5_auth_con_setlocalsubkey, krb5_auth_con_setrcache, krb5_auth_con_setremotesubkey, krb5_auth_con_setuserkey, krb5_auth_getcksumtype, krb5_auth_getkeytype, krb5_auth_getlocalseqnumber, krb5_auth_setcksumtype, krb5_auth_setkeytype, krb5_auth_setlocalseqnumber, krb5_auth_setremoteseqnumber, krb5_auth_getauthenticator, krb5_auth_con_addflags, krb5_auth_con_generatelocalsubkey, krb5_auth_con_removeflags, krb5_free_authenticator, krb5_auth_con_getauthenticator, krb5_auth_getremoteseqnumber(3)
manage authentication on connection level
krb5_get_credentials, krb5_get_credentials_with_flags, krb5_get_kdc_cred, krb5_get_renewed_creds(3)
get credentials from the KDC using krbtgt
krb5_get_credentials, krb5_get_credentials_with_flags, krb5_get_kdc_cred, krb5_get_renewed_creds(3)
get credentials from the KDC using krbtgt
krb5_get_creds, krb5_get_creds_opt_add_options, krb5_get_creds_opt_alloc, krb5_get_creds_opt_free, krb5_get_creds_opt_set_enctype, krb5_get_creds_opt_set_impersonate, krb5_get_creds_opt_set_options, krb5_get_creds_opt_set_ticket(3)
get credentials from the KDC
krb5_get_creds, krb5_get_creds_opt_add_options, krb5_get_creds_opt_alloc, krb5_get_creds_opt_free, krb5_get_creds_opt_set_enctype, krb5_get_creds_opt_set_impersonate, krb5_get_creds_opt_set_options, krb5_get_creds_opt_set_ticket(3)
get credentials from the KDC
krb5_get_forwarded_creds, krb5_fwd_tgt_creds(3)
get forwarded credentials from the KDC
krb5_v4compat, krb524_convert_creds_kdc, krb524_convert_creds_kdc_ccache(3)
Heimdal Kerberos 4 compatiblity functions Functions +1c KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb524_convert_creds_kdc (krb5_context context, krb5_creds *in_cred, struct credentials *v4creds) KRB5_DEPRECATED_FUNCTION('Use X instead') KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb524_convert_creds_kdc_ccache (krb5_context context, krb5_ccache ccache, krb5_creds *in_cred, struct credentials *v4creds) KRB5_DEPRECATED_FUNCTION('Use X instead') -1c
kutil_epoch2str, kutil_date2epoch, kutil_datetime2epoch, kutil_epoch2tmvals, kutil_epoch2utcstr, KUTIL_EPOCH2TM(3)
format and parse time for HTTP operations
LaTeXML::Common::Color, "LaTeXML::Common::Color"(3)
abstract class representating colors using various color models; extends LaTeXML::Common::Object. Exported functions "$color = Color($model,@components);" 4 Creates a Color object using the given color model, and with the given components. The core color models are "rgb", "hsv", "cmy", "cmyk" and "gray". The components of colors using core color models are between 0 and 1 (inclusive) "Black", "White" 4 Constant color objects representing black and white, respectively. Methods "$model = $color->model;" 4 Return the name of the color model. "@components = $color->components;" 4 Return the components of the color. "$other = $color->convert($tomodel);" 4 Converts the color to another color model. "$string = $color->toString;" 4 Returns a printed representation of the color. "$hex = $color->toHex;" 4 Returns a string representing the color as RGB in hexadecimal (6 digits). "$other = $color->toCore();" 4 Converts the color to one of the core colors. "$complement = $color->complement();" 4 Returns the complement color (works for colors in "rgb", "cmy" and "gray" color models). "$new = $color->mix($other,$fraction);" 4 Returns a new color which results from mixing a $fraction of $color with "(1-$fraction)" of color $other. "$new = $color->add($other);" 4 Returns a new color made by adding the components of the two colors. "$new = $color->scale($m);" 4 Returns a new color made by mulitiplying the components by $n. "$new = $color->multiply(@m);" 4 Returns a new color made by mulitiplying the components by the corresponding component from @n.
LaTeXML::Common::Color::Derived, "LaTeXML::Common::Color::Derived"(3)
represents colors in derived color models
LaTeXML::Common::Model::DTD, "LaTeXML::Common::Model::DTD"(3)
represents DTD document models; extends LaTeXML::Common::Model.
LaTeXML::Common::Model::RelaxNG, "LaTeXML::Common::Model::RelaxNG"(3)
represents RelaxNG document models; extends LaTeXML::Common::Model.
LaTeXML::Common::Number, "LaTeXML::Common::Number"(3)
representation of numbers; extends LaTeXML::Common::Object. Exported functions "$number = Number($num);" 4 Creates a Number object representing $num. Methods "@tokens = $object->unlist;" 4 Return a list of the tokens making up this $object. "$string = $object->toString;" 4 Return a string representing $object. "$string = $object->ptValue;" 4 Return a value representing $object without the measurement unit (pt) with limited decimal places. "$string = $object->pxValue;" 4 Return an integer value representing $object in pixels. Uses the state variable "DPI" (dots per inch). "$n = $object->valueOf;" 4 Return the value in scaled points (ignoring shrink and stretch, if any). "$n = $object->smaller($other);" 4 Return $object or $other, whichever is smaller "$n = $object->larger($other);" 4 Return $object or $other, whichever is larger "$n = $object->absolute;" 4 Return an object representing the absolute value of the $object. "$n = $object->sign;" 4 Return an integer: -1 for negatives, 0 for 0 and 1 for positives "$n = $object->negate;" 4 Return an object representing the negative of the $object. "$n = $object->add($other);" 4 Return an object representing the sum of $object and $other "$n = $object->subtract($other);" 4 Return an object representing the difference between $object and $other "$n = $object->multiply($n);" 4 Return an object representing the product of $object and $n (a regular number).
LaTeXML::Core::Box, "LaTeXML::Core::Box"(3)
Representations of digested objects; extends LaTeXML::Common::Object. Exported Functions "$box = Box($string,$font,$locator,$tokens);" 4 Creates a Box representing the $string in the given $font. The $locator records the document source position. The $tokens is a Tokens list containing the TeX that created (or could have) the Box. If $font or $locator are undef, they are obtained from the currently active LaTeXML::Core::State. Note that $string can be undef which contributes nothing to the generated document, but does record the TeX code (in $tokens). METHODS "$font = $digested->getFont;" 4 Returns the font used by $digested. "$boole = $digested->isMath;" 4 Returns whether $digested was created in math mode. "@boxes = $digested->unlist;" 4 Returns a list of the boxes contained in $digested. It is also defined for the Boxes and Whatsit (which just return themselves) so they can stand-in for a List. "$string = $digested->toString;" 4 Returns a string representing this $digested. "$string = $digested->revert;" 4 Reverts the box to the list of "Token"s that created (or could have created) it. "$string = $digested->getLocator;" 4 Get a string describing the location in the original source that gave rise to $digested. "$digested->beAbsorbed($document);" 4 $digested should get itself absorbed into the $document in whatever way is apppropriate. "$string = $box->getString;" 4 Returns the string part of the $box.
LaTeXML::Core::Definition::Conditional, "LaTeXML::Core::Definition::Conditional"(3)
Conditionals Control sequence definitions.
LaTeXML::Core::KeyVals, "LaTeXML::Core::KeyVals"(3)
support for keyvals
LaTeXML::Core::Token, "LaTeXML::Core::Token"(3)
representation of a Token: a pair of character and category code (catcode); It extends LaTeXML::Common::Object. Exported functions "$catcode = CC_ESCAPE;" 4 Constants for the category codes: CW CC_BEGIN, CC_END, CC_MATH, CC_ALIGN, CC_EOL, CC_PARAM, CC_SUPER, CC_SUB, CC_IGNORE, CC_SPACE, CC_LETTER, CC_OTHER, CC_ACTIVE, CC_COMMENT, CC_INVALID, CC_CS, CC_NOTEXPANDED. R [The last 2 are (apparent) extensions, with catcodes 16 and 17, respectively]. "$token = Token($string,$cc);" 4 Creates a LaTeXML::Core::Token with the given content and catcode. The following shorthand versions are also exported for convenience: CW T_BEGIN, T_END, T_MATH, T_ALIGN, T_PARAM, T_SUB, T_SUPER, T_SPACE, T_LETTER($letter), T_OTHER($char), T_ACTIVE($char), T_COMMENT($comment), T_CS($cs) R "@tokens = Explode($string);" 4 Returns a list of the tokens corresponding to the characters in $string. All tokens have catcode CC_OTHER, except for spaces which have catcode CC_SPACE. "@tokens = ExplodeText($string);" 4 Returns a list of the tokens corresponding to the characters in $string. All (roman) letters have catcode CC_LETTER, all others have catcode CC_OTHER, except for spaces which have catcode CC_SPACE. "UnTeX($object);" 4 Converts $object to a string containing TeX that created it (or could have). Note that this is not necessarily the original TeX code; expansions or other substitutions may have taken place. Methods "@tokens = $object->unlist;" 4 Return a list of the tokens making up this $object. "$string = $object->toString;" 4 Return a string representing $object. "$string = $token->getCSName;" 4 Return the string or character part of the $token; for the special category codes, returns the standard string (eg. "T_BEGIN-"getCSName> returns "{"). "$string = $token->getString;" 4 Return the string or character part of the $token. "$code = $token->getCharcode;" 4 Return the character code of the character part of the $token, or 256 if it is a control sequence. "$code = $token->getCatcode;" 4 Return the catcode of the $token.
Layout::Manager::Absolute(3)
No frills layout manager
ldap_control_create, ldap_control_dup, ldap_control_find, ldap_control_free, ldap_controls_dup, ldap_controls_free, ldap_controls(3)
LDAP control manipulation routines
ldap_parse_reference(3)
Extract referrals and controls from a reference message
ldap_start_tls, ldap_install_tls, ldap_start_tls_s, ldap_tls_inplace, ldap_tls(3)
LDAP TLS initialization routines
ldns_dane_cert2rdf, ldns_dane_create_tlsa_rr, ldns_dane_create_tlsa_owner, ldns_dane_select_certificate(3)
TLSA RR creation functions
ldns_dane_create_tlsa_owner, ldns_dane_create_tlsa_rr, ldns_dane_cert2rdf, ldns_dane_select_certificate(3)
TLSA RR creation functions
ldns_dane_create_tlsa_rr, ldns_dane_cert2rdf, ldns_dane_create_tlsa_owner, ldns_dane_select_certificate(3)
TLSA RR creation functions
ldns_dane_select_certificate, ldns_dane_create_tlsa_rr, ldns_dane_cert2rdf, ldns_dane_create_tlsa_owner(3)
TLSA RR creation functions
ldns_dane_verify, ldns_dane_verify_rr(3)
TLSA RR verification functions
ldns_dane_verify_rr, ldns_dane_verify(3)
TLSA RR verification functions
ldns_dnssec_zone_add_empty_nonterminals, ldns_dnssec_zone_find_rrset, ldns_dnssec_zone_add_rr, ldns_dnssec_zone_free, ldns_dnssec_zone_names_print, ldns_dnssec_zone_new, ldns_dnssec_zone_print(3)
functions for ldns_dnssec_zone
ldns_dnssec_zone_add_rr, ldns_dnssec_zone_find_rrset, ldns_dnssec_zone_add_empty_nonterminals, ldns_dnssec_zone_free, ldns_dnssec_zone_names_print, ldns_dnssec_zone_new, ldns_dnssec_zone_print(3)
functions for ldns_dnssec_zone
ldns_dnssec_zone_find_rrset, ldns_dnssec_zone_add_empty_nonterminals, ldns_dnssec_zone_add_rr, ldns_dnssec_zone_free, ldns_dnssec_zone_names_print, ldns_dnssec_zone_new, ldns_dnssec_zone_print(3)
functions for ldns_dnssec_zone
ldns_dnssec_zone_free, ldns_dnssec_zone_find_rrset, ldns_dnssec_zone_add_empty_nonterminals, ldns_dnssec_zone_add_rr, ldns_dnssec_zone_names_print, ldns_dnssec_zone_new, ldns_dnssec_zone_print(3)
functions for ldns_dnssec_zone
ldns_dnssec_zone_names_print, ldns_dnssec_zone_find_rrset, ldns_dnssec_zone_add_empty_nonterminals, ldns_dnssec_zone_add_rr, ldns_dnssec_zone_free, ldns_dnssec_zone_new, ldns_dnssec_zone_print(3)
functions for ldns_dnssec_zone
ldns_dnssec_zone_new, ldns_dnssec_zone_find_rrset, ldns_dnssec_zone_add_empty_nonterminals, ldns_dnssec_zone_add_rr, ldns_dnssec_zone_free, ldns_dnssec_zone_names_print, ldns_dnssec_zone_print(3)
functions for ldns_dnssec_zone
ldns_dnssec_zone_print, ldns_dnssec_zone_find_rrset, ldns_dnssec_zone_add_empty_nonterminals, ldns_dnssec_zone_add_rr, ldns_dnssec_zone_free, ldns_dnssec_zone_names_print, ldns_dnssec_zone_new(3)
functions for ldns_dnssec_zone
ldns_rr_rrsig_algorithm, ldns_rr_rrsig_typecovered, ldns_rr_rrsig_expiration, ldns_rr_rrsig_inception, ldns_rr_rrsig_keytag, ldns_rr_rrsig_labels, ldns_rr_rrsig_origttl, ldns_rr_rrsig_set_algorithm, ldns_rr_rrsig_set_expiration, ldns_rr_rrsig_set_inception, ldns_rr_rrsig_set_keytag, ldns_rr_rrsig_set_labels, ldns_rr_rrsig_set_origttl, ldns_rr_rrsig_set_sig, ldns_rr_rrsig_set_signame, ldns_rr_rrsig_set_typecovered, ldns_rr_rrsig_sig, ldns_rr_rrsig_signame(3)
get and set RRSIG RR rdata fields
ldns_rr_rrsig_expiration, ldns_rr_rrsig_typecovered, ldns_rr_rrsig_algorithm, ldns_rr_rrsig_inception, ldns_rr_rrsig_keytag, ldns_rr_rrsig_labels, ldns_rr_rrsig_origttl, ldns_rr_rrsig_set_algorithm, ldns_rr_rrsig_set_expiration, ldns_rr_rrsig_set_inception, ldns_rr_rrsig_set_keytag, ldns_rr_rrsig_set_labels, ldns_rr_rrsig_set_origttl, ldns_rr_rrsig_set_sig, ldns_rr_rrsig_set_signame, ldns_rr_rrsig_set_typecovered, ldns_rr_rrsig_sig, ldns_rr_rrsig_signame(3)
get and set RRSIG RR rdata fields
ldns_rr_rrsig_inception, ldns_rr_rrsig_typecovered, ldns_rr_rrsig_algorithm, ldns_rr_rrsig_expiration, ldns_rr_rrsig_keytag, ldns_rr_rrsig_labels, ldns_rr_rrsig_origttl, ldns_rr_rrsig_set_algorithm, ldns_rr_rrsig_set_expiration, ldns_rr_rrsig_set_inception, ldns_rr_rrsig_set_keytag, ldns_rr_rrsig_set_labels, ldns_rr_rrsig_set_origttl, ldns_rr_rrsig_set_sig, ldns_rr_rrsig_set_signame, ldns_rr_rrsig_set_typecovered, ldns_rr_rrsig_sig, ldns_rr_rrsig_signame(3)
get and set RRSIG RR rdata fields
ldns_rr_rrsig_keytag, ldns_rr_rrsig_typecovered, ldns_rr_rrsig_algorithm, ldns_rr_rrsig_expiration, ldns_rr_rrsig_inception, ldns_rr_rrsig_labels, ldns_rr_rrsig_origttl, ldns_rr_rrsig_set_algorithm, ldns_rr_rrsig_set_expiration, ldns_rr_rrsig_set_inception, ldns_rr_rrsig_set_keytag, ldns_rr_rrsig_set_labels, ldns_rr_rrsig_set_origttl, ldns_rr_rrsig_set_sig, ldns_rr_rrsig_set_signame, ldns_rr_rrsig_set_typecovered, ldns_rr_rrsig_sig, ldns_rr_rrsig_signame(3)
get and set RRSIG RR rdata fields
ldns_rr_rrsig_labels, ldns_rr_rrsig_typecovered, ldns_rr_rrsig_algorithm, ldns_rr_rrsig_expiration, ldns_rr_rrsig_inception, ldns_rr_rrsig_keytag, ldns_rr_rrsig_origttl, ldns_rr_rrsig_set_algorithm, ldns_rr_rrsig_set_expiration, ldns_rr_rrsig_set_inception, ldns_rr_rrsig_set_keytag, ldns_rr_rrsig_set_labels, ldns_rr_rrsig_set_origttl, ldns_rr_rrsig_set_sig, ldns_rr_rrsig_set_signame, ldns_rr_rrsig_set_typecovered, ldns_rr_rrsig_sig, ldns_rr_rrsig_signame(3)
get and set RRSIG RR rdata fields
ldns_rr_rrsig_origttl, ldns_rr_rrsig_typecovered, ldns_rr_rrsig_algorithm, ldns_rr_rrsig_expiration, ldns_rr_rrsig_inception, ldns_rr_rrsig_keytag, ldns_rr_rrsig_labels, ldns_rr_rrsig_set_algorithm, ldns_rr_rrsig_set_expiration, ldns_rr_rrsig_set_inception, ldns_rr_rrsig_set_keytag, ldns_rr_rrsig_set_labels, ldns_rr_rrsig_set_origttl, ldns_rr_rrsig_set_sig, ldns_rr_rrsig_set_signame, ldns_rr_rrsig_set_typecovered, ldns_rr_rrsig_sig, ldns_rr_rrsig_signame(3)
get and set RRSIG RR rdata fields
ldns_rr_rrsig_set_algorithm, ldns_rr_rrsig_typecovered, ldns_rr_rrsig_algorithm, ldns_rr_rrsig_expiration, ldns_rr_rrsig_inception, ldns_rr_rrsig_keytag, ldns_rr_rrsig_labels, ldns_rr_rrsig_origttl, ldns_rr_rrsig_set_expiration, ldns_rr_rrsig_set_inception, ldns_rr_rrsig_set_keytag, ldns_rr_rrsig_set_labels, ldns_rr_rrsig_set_origttl, ldns_rr_rrsig_set_sig, ldns_rr_rrsig_set_signame, ldns_rr_rrsig_set_typecovered, ldns_rr_rrsig_sig, ldns_rr_rrsig_signame(3)
get and set RRSIG RR rdata fields
ldns_rr_rrsig_set_expiration, ldns_rr_rrsig_typecovered, ldns_rr_rrsig_algorithm, ldns_rr_rrsig_expiration, ldns_rr_rrsig_inception, ldns_rr_rrsig_keytag, ldns_rr_rrsig_labels, ldns_rr_rrsig_origttl, ldns_rr_rrsig_set_algorithm, ldns_rr_rrsig_set_inception, ldns_rr_rrsig_set_keytag, ldns_rr_rrsig_set_labels, ldns_rr_rrsig_set_origttl, ldns_rr_rrsig_set_sig, ldns_rr_rrsig_set_signame, ldns_rr_rrsig_set_typecovered, ldns_rr_rrsig_sig, ldns_rr_rrsig_signame(3)
get and set RRSIG RR rdata fields
ldns_rr_rrsig_set_inception, ldns_rr_rrsig_typecovered, ldns_rr_rrsig_algorithm, ldns_rr_rrsig_expiration, ldns_rr_rrsig_inception, ldns_rr_rrsig_keytag, ldns_rr_rrsig_labels, ldns_rr_rrsig_origttl, ldns_rr_rrsig_set_algorithm, ldns_rr_rrsig_set_expiration, ldns_rr_rrsig_set_keytag, ldns_rr_rrsig_set_labels, ldns_rr_rrsig_set_origttl, ldns_rr_rrsig_set_sig, ldns_rr_rrsig_set_signame, ldns_rr_rrsig_set_typecovered, ldns_rr_rrsig_sig, ldns_rr_rrsig_signame(3)
get and set RRSIG RR rdata fields
ldns_rr_rrsig_set_keytag, ldns_rr_rrsig_typecovered, ldns_rr_rrsig_algorithm, ldns_rr_rrsig_expiration, ldns_rr_rrsig_inception, ldns_rr_rrsig_keytag, ldns_rr_rrsig_labels, ldns_rr_rrsig_origttl, ldns_rr_rrsig_set_algorithm, ldns_rr_rrsig_set_expiration, ldns_rr_rrsig_set_inception, ldns_rr_rrsig_set_labels, ldns_rr_rrsig_set_origttl, ldns_rr_rrsig_set_sig, ldns_rr_rrsig_set_signame, ldns_rr_rrsig_set_typecovered, ldns_rr_rrsig_sig, ldns_rr_rrsig_signame(3)
get and set RRSIG RR rdata fields
ldns_rr_rrsig_set_labels, ldns_rr_rrsig_typecovered, ldns_rr_rrsig_algorithm, ldns_rr_rrsig_expiration, ldns_rr_rrsig_inception, ldns_rr_rrsig_keytag, ldns_rr_rrsig_labels, ldns_rr_rrsig_origttl, ldns_rr_rrsig_set_algorithm, ldns_rr_rrsig_set_expiration, ldns_rr_rrsig_set_inception, ldns_rr_rrsig_set_keytag, ldns_rr_rrsig_set_origttl, ldns_rr_rrsig_set_sig, ldns_rr_rrsig_set_signame, ldns_rr_rrsig_set_typecovered, ldns_rr_rrsig_sig, ldns_rr_rrsig_signame(3)
get and set RRSIG RR rdata fields
ldns_rr_rrsig_set_origttl, ldns_rr_rrsig_typecovered, ldns_rr_rrsig_algorithm, ldns_rr_rrsig_expiration, ldns_rr_rrsig_inception, ldns_rr_rrsig_keytag, ldns_rr_rrsig_labels, ldns_rr_rrsig_origttl, ldns_rr_rrsig_set_algorithm, ldns_rr_rrsig_set_expiration, ldns_rr_rrsig_set_inception, ldns_rr_rrsig_set_keytag, ldns_rr_rrsig_set_labels, ldns_rr_rrsig_set_sig, ldns_rr_rrsig_set_signame, ldns_rr_rrsig_set_typecovered, ldns_rr_rrsig_sig, ldns_rr_rrsig_signame(3)
get and set RRSIG RR rdata fields
ldns_rr_rrsig_set_sig, ldns_rr_rrsig_typecovered, ldns_rr_rrsig_algorithm, ldns_rr_rrsig_expiration, ldns_rr_rrsig_inception, ldns_rr_rrsig_keytag, ldns_rr_rrsig_labels, ldns_rr_rrsig_origttl, ldns_rr_rrsig_set_algorithm, ldns_rr_rrsig_set_expiration, ldns_rr_rrsig_set_inception, ldns_rr_rrsig_set_keytag, ldns_rr_rrsig_set_labels, ldns_rr_rrsig_set_origttl, ldns_rr_rrsig_set_signame, ldns_rr_rrsig_set_typecovered, ldns_rr_rrsig_sig, ldns_rr_rrsig_signame(3)
get and set RRSIG RR rdata fields
ldns_rr_rrsig_set_signame, ldns_rr_rrsig_typecovered, ldns_rr_rrsig_algorithm, ldns_rr_rrsig_expiration, ldns_rr_rrsig_inception, ldns_rr_rrsig_keytag, ldns_rr_rrsig_labels, ldns_rr_rrsig_origttl, ldns_rr_rrsig_set_algorithm, ldns_rr_rrsig_set_expiration, ldns_rr_rrsig_set_inception, ldns_rr_rrsig_set_keytag, ldns_rr_rrsig_set_labels, ldns_rr_rrsig_set_origttl, ldns_rr_rrsig_set_sig, ldns_rr_rrsig_set_typecovered, ldns_rr_rrsig_sig, ldns_rr_rrsig_signame(3)
get and set RRSIG RR rdata fields
ldns_rr_rrsig_set_typecovered, ldns_rr_rrsig_typecovered, ldns_rr_rrsig_algorithm, ldns_rr_rrsig_expiration, ldns_rr_rrsig_inception, ldns_rr_rrsig_keytag, ldns_rr_rrsig_labels, ldns_rr_rrsig_origttl, ldns_rr_rrsig_set_algorithm, ldns_rr_rrsig_set_expiration, ldns_rr_rrsig_set_inception, ldns_rr_rrsig_set_keytag, ldns_rr_rrsig_set_labels, ldns_rr_rrsig_set_origttl, ldns_rr_rrsig_set_sig, ldns_rr_rrsig_set_signame, ldns_rr_rrsig_sig, ldns_rr_rrsig_signame(3)
get and set RRSIG RR rdata fields
ldns_rr_rrsig_sig, ldns_rr_rrsig_typecovered, ldns_rr_rrsig_algorithm, ldns_rr_rrsig_expiration, ldns_rr_rrsig_inception, ldns_rr_rrsig_keytag, ldns_rr_rrsig_labels, ldns_rr_rrsig_origttl, ldns_rr_rrsig_set_algorithm, ldns_rr_rrsig_set_expiration, ldns_rr_rrsig_set_inception, ldns_rr_rrsig_set_keytag, ldns_rr_rrsig_set_labels, ldns_rr_rrsig_set_origttl, ldns_rr_rrsig_set_sig, ldns_rr_rrsig_set_signame, ldns_rr_rrsig_set_typecovered, ldns_rr_rrsig_signame(3)
get and set RRSIG RR rdata fields
ldns_rr_rrsig_signame, ldns_rr_rrsig_typecovered, ldns_rr_rrsig_algorithm, ldns_rr_rrsig_expiration, ldns_rr_rrsig_inception, ldns_rr_rrsig_keytag, ldns_rr_rrsig_labels, ldns_rr_rrsig_origttl, ldns_rr_rrsig_set_algorithm, ldns_rr_rrsig_set_expiration, ldns_rr_rrsig_set_inception, ldns_rr_rrsig_set_keytag, ldns_rr_rrsig_set_labels, ldns_rr_rrsig_set_origttl, ldns_rr_rrsig_set_sig, ldns_rr_rrsig_set_signame, ldns_rr_rrsig_set_typecovered, ldns_rr_rrsig_sig(3)
get and set RRSIG RR rdata fields
ldns_rr_rrsig_typecovered, ldns_rr_rrsig_algorithm, ldns_rr_rrsig_expiration, ldns_rr_rrsig_inception, ldns_rr_rrsig_keytag, ldns_rr_rrsig_labels, ldns_rr_rrsig_origttl, ldns_rr_rrsig_set_algorithm, ldns_rr_rrsig_set_expiration, ldns_rr_rrsig_set_inception, ldns_rr_rrsig_set_keytag, ldns_rr_rrsig_set_labels, ldns_rr_rrsig_set_origttl, ldns_rr_rrsig_set_sig, ldns_rr_rrsig_set_signame, ldns_rr_rrsig_set_typecovered, ldns_rr_rrsig_sig, ldns_rr_rrsig_signame(3)
get and set RRSIG RR rdata fields
ldns_update_pkt_tsig_add(3)
add resolver's tsig credentials to an ldns_pkt
LessTifInternals, _Xm*(3)
LessTif Internal Functions
Lexical::Persistence(3)
Persistent lexical variable values for arbitrary calls.
libarchive_internals(3)
description of libarchive internal interfaces
libarchive_internals(3)
description of libarchive internal interfaces
libcurl-symbols(3)
libcurl symbol version information
libnutclient(3)
Network UPS Tools high-level client access library
libnutclient_commands, nutclient_execute_device_command, nutclient_get_device_command_description, nutclient_get_device_commands, nutclient_has_device_command(3)
Instant command related functions in Network UPS Tools high-level client access library
libnutclient_devices, nutclient_get_device_description, nutclient_get_devices, nutclient_has_device(3)
Device related functions in Network UPS Tools high-level client access library
libnutclient_general, nutclient_destroy, strarr_alloc, strarr_free(3)
General and utility functions in Network UPS Tools high-level client access library
libnutclient_misc, nutclient_authenticate, nutclient_device_forced_shutdown, nutclient_device_login, nutclient_device_master, nutclient_get_device_num_logins, nutclient_logout(3)
Miscelaneous functions in Network UPS Tools high-level client access library
libnutclient_tcp, nutclient_tcp_create_client, nutclient_tcp_disconnect, nutclient_tcp_get_timeout, nutclient_tcp_is_connected, nutclient_tcp_reconnect, nutclient_tcp_set_timeout(3)
TCP protocol related function for Network UPS Tools high-level client access library
libnutclient_variables, nutclient_get_device_rw_variables, nutclient_get_device_variable_description, nutclient_get_device_variable_values, nutclient_get_device_variables, nutclient_has_device_variable, nutclient_set_device_variable_value, nutclient_set_device_variable_values(3)
Variable related functions in Network UPS Tools high-level client access library
Libravatar::URL(3)
Make URLs for Libravatars from an email address
libssh2_channel_direct_tcpip(3)
convenience macro for libssh2_channel_direct_tcpip_ex(3) calls
libssh2_channel_exec(3)
convenience macro for libssh2_channel_process_startup(3) calls
libssh2_channel_flush(3)
convenience macro for libssh2_channel_flush_ex(3) calls
libssh2_channel_flush_stderr(3)
convenience macro for libssh2_channel_flush_ex(3) calls
libssh2_channel_forward_listen(3)
convenience macro for libssh2_channel_forward_listen_ex(3) calls
libssh2_channel_ignore_extended_data(3)
convenience macro for libssh2_channel_handle_extended_data(3) calls
libssh2_channel_open_session(3)
convenience macro for libssh2_channel_open_ex(3) calls
libssh2_channel_read(3)
convenience macro for libssh2_channel_read_ex(3) calls
libssh2_channel_read_stderr(3)
convenience macro for libssh2_channel_read_ex(3) calls
libssh2_channel_request_pty(3)
convenience macro for libssh2_channel_request_pty_ex(3) calls
libssh2_channel_request_pty_size(3)
convenience macro for libssh2_channel_request_pty_size_ex(3) calls
libssh2_channel_setenv(3)
convenience macro for libssh2_channel_setenv_ex(3) calls
libssh2_channel_shell(3)
convenience macro for libssh2_channel_process_startup(3) calls
libssh2_channel_subsystem(3)
convenience macro for libssh2_channel_process_startup(3) calls
libssh2_channel_window_read(3)
convenience macro for libssh2_channel_window_read_ex(3) calls
libssh2_channel_window_write(3)
convenience macro for libssh2_channel_window_write_ex(3) calls
libssh2_channel_x11_req(3)
convenience macro for libssh2_channel_x11_req_ex(3) calls
libssh2_publickey_add(3)
convenience macro for libssh2_publickey_add_ex(3) calls
libssh2_publickey_remove(3)
convenience macro for libssh2_publickey_remove_ex(3) calls
libssh2_scp_send(3)
convenience macro for libssh2_scp_send_ex(3) calls
libssh2_session_disconnect(3)
convenience macro for libssh2_session_disconnect_ex(3) calls
libssh2_session_init(3)
convenience macro for libssh2_session_init_ex(3) calls
libssh2_sftp_close(3)
convenience macro for libssh2_sftp_close_handle(3) calls
libssh2_sftp_closedir(3)
convenience macro for libssh2_sftp_close_handle(3) calls
libssh2_sftp_fsetstat(3)
convenience macro for libssh2_sftp_fstat_ex(3) calls
libssh2_sftp_fstat(3)
convenience macro for libssh2_sftp_fstat_ex(3) calls
libssh2_sftp_lstat(3)
convenience macro for libssh2_sftp_stat_ex(3) calls
libssh2_sftp_mkdir(3)
convenience macro for libssh2_sftp_mkdir_ex(3) calls
libssh2_sftp_open(3)
convenience macro for libssh2_sftp_open_ex(3) calls
libssh2_sftp_opendir(3)
convenience macro for libssh2_sftp_open_ex(3) calls
libssh2_sftp_readdir(3)
convenience macro for libssh2_sftp_readdir_ex(3) calls
libssh2_sftp_rename(3)
convenience macro for libssh2_sftp_rename_ex(3) calls
libssh2_sftp_rewind(3)
convenience macro for libssh2_sftp_seek64(3) calls
libssh2_sftp_setstat(3)
convenience macro for libssh2_sftp_stat_ex(3) calls
libssh2_sftp_stat(3)
convenience macro for libssh2_sftp_fstat_ex(3) calls
libssh2_sftp_unlink(3)
convenience macro for libssh2_sftp_unlink_ex(3) calls
libssh2_userauth_hostbased_fromfile(3)
convenience macro for libssh2_userauth_hostbased_fromfile_ex(3) calls
libssh2_userauth_keyboard_interactive(3)
convenience macro for libssh2_userauth_keyboard_interactive_ex(3) calls
libssh2_userauth_password(3)
convenience macro for libssh2_userauth_password_ex(3) calls
libssh2_userauth_publickey_fromfile(3)
convenience macro for libssh2_userauth_publickey_fromfile_ex(3) calls
Lingua::Han::Utils(3)
The utility tools of Chinese character(HanZi)
Lingua::Identify::CY(3)
Meta-information on Welsh
List::AllUtils(3)
Combines List::Util, List::SomeUtils and List::UtilsBy in one bite-sized package
List::MoreUtils(3)
Provide the stuff missing in List::Util
List::MoreUtils::Contributing(3)
Gives rough introduction into contributing to List::MoreUtils
List::MoreUtils::PP(3)
Provide List::MoreUtils pure Perl implementation
List::MoreUtils::XS(3)
Provide compiled List::MoreUtils functions
List::Objects::Types(3)
Type::Tiny-based types for List::Objects::WithUtils
List::Objects::WithUtils(3)
List objects, kitchen sink included
List::Objects::WithUtils::Array(3)
Array-type objects WithUtils
List::Objects::WithUtils::Array::Immutable(3)
Immutable array objects
List::Objects::WithUtils::Array::Immutable::Typed(3)
Immutable typed arrays
List::Objects::WithUtils::Array::Junction(3)
Lightweight junction classes
List::Objects::WithUtils::Array::Typed(3)
Type-checking array objects
List::Objects::WithUtils::Autobox(3)
Native data types WithUtils
List::Objects::WithUtils::Hash(3)
Hash-type objects WithUtils
List::Objects::WithUtils::Hash::Immutable(3)
Immutable hash objects
List::Objects::WithUtils::Hash::Immutable::Typed(3)
Immutable typed hashes
List::Objects::WithUtils::Hash::Inflated(3)
List::Objects::WithUtils::Hash::Inflated
List::Objects::WithUtils::Hash::Inflated::RW(3)
List::Objects::WithUtils::Hash::Inflated::RW
List::Objects::WithUtils::Hash::Typed(3)
Type-checking hash objects
List::Objects::WithUtils::Role::Array(3)
Array manipulation methods
List::Objects::WithUtils::Role::Array::Immutable(3)
Immutable array behavior
List::Objects::WithUtils::Role::Array::Typed(3)
Type-checking array behavior
List::Objects::WithUtils::Role::Array::WithJunctions(3)
Add junctions
List::Objects::WithUtils::Role::Hash(3)
Hash manipulation methods
List::Objects::WithUtils::Role::Hash::Immutable(3)
Immutable hash behavior
List::Objects::WithUtils::Role::Hash::Typed(3)
Type-checking hash behavior
List::SomeUtils(3)
Provide the stuff missing in List::Util
List::SomeUtils::PP(3)
Pure Perl implementation for List::SomeUtils
List::SomeUtils::XS(3)
XS implementation for List::SomeUtils
List::UtilsBy, "List::UtilsBy"(3)
higher-order list utility functions
List::UtilsBy::XS(3)
XS implementation of List::UtilsBy
ListLabels(3, 3o)
List operations.
Locale::Codes::Changes(3)
details changes to Locale::Codes
Locale::Msgfmt::Utils(3)
Functions used internally by Locale::Msgfmt
Locale::Po4a::Common(3, 3pm)
common parts of the po4a scripts and utils
localserversocket, FBB::LocalServerSocket(3, 3bobcat)
Unix Domain Server socket accepting connection requests
localsocketbase, FBB::LocalSocketBase(3, 3bobcat)
Base class for Unix Domain socket-constructing classes
lofigchain(3)
creates a netlist in terms of connectors on signals
Log2t::input::sol, sol(3)
an input module log2timeline that parses Local Shared Objects (LSO) or Flash cookies as they are often referred to
Log::Agent::Channel(3)
ancestor class for all Log::Agent channels
Log::Agent::Priorities(3)
conversion between syslog priorities and levels
Log::Dispatch::Email::EmailSend(3)
Subclass of Log::Dispatch::Email that uses Email::Send
Log::Dispatch::Email::MailSend(3)
Subclass of Log::Dispatch::Email that uses the Mail::Send module
Log::Dispatch::Email::MailSender(3)
Subclass of Log::Dispatch::Email that uses the Mail::Sender module
Log::Dispatch::Email::MailSendmail(3)
Subclass of Log::Dispatch::Email that uses the Mail::Sendmail module
Log::Handler::Levels(3)
All levels for Log::Handler.
Log::Log4perl::Appender::ScreenColoredLevels, Log::Log4perl::Appender::ScreenColoredLevel(3)
Colorize messages according to level
Log::Log4perl::Filter::LevelRange(3)
Filter for a range of log levels
Log::Log4perl::Level(3)
Predefined log levels
Lowu(3)
Shortcut for importing all of List::Objects::WithUtils
lsamen.f(3)
lsametst.f(3)
lsearch(3)
???? ???? routine
lsearch, lfind(3)
linear search and append
lsearch, lfind(3)
????????????????
lseek_net(3)
lseek_net
LWP::Parallel::Protocol(3)
Base class for parallel LWP protocols
LWP::Protocol(3)
Base class for LWP protocols
m17nCharacter, Character(3, 3m17n)
Character objects and API for them. Variables: Keys of character properties These symbols are used as keys of character properties. +1c MSymbol Mscript Key for script. MSymbol Mname Key for character name. MSymbol Mcategory Key for general category. MSymbol Mcombining_class Key for canonical combining class. MSymbol Mbidi_category Key for bidi category. MSymbol Msimple_case_folding Key for corresponding single lowercase character. MSymbol Mcomplicated_case_folding Key for corresponding multiple lowercase characters. MSymbol Mcased Key for values used in case operation. MSymbol Msoft_dotted Key for values used in case operation. MSymbol Mcase_mapping Key for values used in case operation. MSymbol Mblock Key for script block name. -1c Defines +1c #define MCHAR_MAX Maximum character code. -1c Functions +1c MSymbol mchar_define_property (const char *name, MSymbol type) Define a character property. void * mchar_get_prop (int c, MSymbol key) Get the value of a character property. int mchar_put_prop (int c, MSymbol key, void *val) Set the value of a character property. MCharTable * mchar_get_prop_table (MSymbol key, MSymbol *type) Get the char-table for a character property. -1c
m17nCharset, Charset(3, 3m17n)
Charset objects and API for them. Variables: Symbols representing a charset. Each of the following symbols represents a predefined charset. +1c MSymbol Mcharset_ascii Symbol representing the charset ASCII. MSymbol Mcharset_iso_8859_1 Symbol representing the charset ISO/IEC 8859/1. MSymbol Mcharset_unicode Symbol representing the charset Unicode. MSymbol Mcharset_m17n Symbol representing the largest charset. MSymbol Mcharset_binary Symbol representing the charset for ill-decoded characters. -1c Variables: Parameter keys for mchar_define_charset(). These are the predefined symbols to use as parameter keys for the function mchar_define_charset() (which see). +1c MSymbol Mmethod MSymbol Mdimension MSymbol Mmin_range MSymbol Mmax_range MSymbol Mmin_code MSymbol Mmax_code MSymbol Mascii_compatible MSymbol Mfinal_byte MSymbol Mrevision MSymbol Mmin_char MSymbol Mmapfile MSymbol Mparents MSymbol Msubset_offset MSymbol Mdefine_coding MSymbol Maliases -1c Variables: Symbols representing charset methods. These are the predefined symbols that can be a value of the Mmethod parameter of a charset used in an argument to the mchar_define_charset() function. A method specifies how code-points and character codes are converted. See the documentation of the mchar_define_charset() function for the details. +1c MSymbol Moffset Symbol for the offset type method of charset. MSymbol Mmap Symbol for the map type method of charset. MSymbol Munify Symbol for the unify type method of charset. MSymbol Msubset Symbol for the subset type method of charset. MSymbol Msuperset Symbol for the superset type method of charset. -1c Defines +1c #define MCHAR_INVALID_CODE Invalid code-point. -1c Functions +1c MSymbol mchar_define_charset (const char *name, MPlist *plist) Define a charset. MSymbol mchar_resolve_charset (MSymbol symbol) Resolve charset name. int mchar_list_charset (MSymbol **symbols) List symbols representing charsets. int mchar_decode (MSymbol charset_name, unsigned code) Decode a code-point. unsigned mchar_encode (MSymbol charset_name, int c) Encode a character code. int mchar_map_charset (MSymbol charset_name, void(*func)(int from, int to, void *arg), void *func_arg) Call a function for all the characters in a specified charset. -1c Variables +1c MSymbol Mcharset The symbol Mcharset. -1c
m17nConv, Code(3, 3m17n)
Conversion - Coding system objects and API for them. Data Structures +1c struct MConverter Structure to be used in code conversion. struct MCodingInfoISO2022 Structure for a coding system of type MCODING_TYPE_ISO_2022. struct MCodingInfoUTF Structure for extra information about a coding system of type MCODING_TYPE_UTF. -1c Variables: Symbols representing coding systems +1c MSymbol Mcoding_us_ascii Symbol for the coding system US-ASCII. MSymbol Mcoding_iso_8859_1 Symbol for the coding system ISO-8859-1. MSymbol Mcoding_utf_8 Symbol for the coding system UTF-8. MSymbol Mcoding_utf_8_full Symbol for the coding system UTF-8-FULL. MSymbol Mcoding_utf_16 Symbol for the coding system UTF-16. MSymbol Mcoding_utf_16be Symbol for the coding system UTF-16BE. MSymbol Mcoding_utf_16le Symbol for the coding system UTF-16LE. MSymbol Mcoding_utf_32 Symbol for the coding system UTF-32. MSymbol Mcoding_utf_32be Symbol for the coding system UTF-32BE. MSymbol Mcoding_utf_32le Symbol for the coding system UTF-32LE. MSymbol Mcoding_sjis Symbol for the coding system SJIS. -1c Variables: Parameter keys for mconv_define_coding(). +1c MSymbol Mtype MSymbol Mcharsets MSymbol Mflags MSymbol Mdesignation MSymbol Minvocation MSymbol Mcode_unit MSymbol Mbom MSymbol Mlittle_endian -1c Variables: Symbols representing coding system types. +1c MSymbol Mutf MSymbol Miso_2022 -1c Variables: Symbols appearing in the value of Mflags parameter. Symbols that can be a value of the Mflags parameter of a coding system used in an argument to the mconv_define_coding() function (which see). +1c MSymbol Mreset_at_eol MSymbol Mreset_at_cntl MSymbol Meight_bit MSymbol Mlong_form MSymbol Mdesignation_g0 MSymbol Mdesignation_g1 MSymbol Mdesignation_ctext MSymbol Mdesignation_ctext_ext MSymbol Mlocking_shift MSymbol Msingle_shift MSymbol Msingle_shift_7 MSymbol Meuc_tw_shift MSymbol Miso_6429 MSymbol Mrevision_number MSymbol Mfull_support -1c Variables: Others Remaining variables. +1c MSymbol Mmaybe Symbol whose name is 'maybe'. MSymbol Mcoding The symbol Mcoding. -1c Enumerations +1c enum MConversionResult { MCONVERSION_RESULT_SUCCESS, MCONVERSION_RESULT_INVALID_BYTE, MCONVERSION_RESULT_INVALID_CHAR, MCONVERSION_RESULT_INSUFFICIENT_SRC, MCONVERSION_RESULT_INSUFFICIENT_DST, MCONVERSION_RESULT_IO_ERROR } Codes that represent the result of code conversion. enum MCodingType { MCODING_TYPE_CHARSET, MCODING_TYPE_UTF, MCODING_TYPE_ISO_2022, MCODING_TYPE_MISC } Types of coding system. enum MCodingFlagISO2022 { MCODING_ISO_RESET_AT_EOL = 0x1, MCODING_ISO_RESET_AT_CNTL = 0x2, MCODING_ISO_EIGHT_BIT = 0x4, MCODING_ISO_LONG_FORM = 0x8, MCODING_ISO_DESIGNATION_G0 = 0x10, MCODING_ISO_DESIGNATION_G1 = 0x20, MCODING_ISO_DESIGNATION_CTEXT = 0x40, MCODING_ISO_DESIGNATION_CTEXT_EXT = 0x80, MCODING_ISO_LOCKING_SHIFT = 0x100, MCODING_ISO_SINGLE_SHIFT = 0x200, MCODING_ISO_SINGLE_SHIFT_7 = 0x400, MCODING_ISO_EUC_TW_SHIFT = 0x800, MCODING_ISO_ISO6429 = 0x1000, MCODING_ISO_REVISION_NUMBER = 0x2000, MCODING_ISO_FULL_SUPPORT = 0x3000, MCODING_ISO_FLAG_MAX } Bit-masks to specify the detail of coding system whose type is MCODING_TYPE_ISO_2022. -1c Functions +1c MSymbol mconv_define_coding (const char *name, MPlist *plist, int(*resetter)(MConverter *), int(*decoder)(const unsigned char *, int, MText *, MConverter *), int(*encoder)(MText *, int, int, unsigned char *, int, MConverter *), void *extra_info) Define a coding system. MSymbol mconv_resolve_coding (MSymbol symbol) Resolve coding system name. int mconv_list_codings (MSymbol **symbols) List symbols representing coding systems. MConverter * mconv_buffer_converter (MSymbol name, const unsigned char *buf, int n) Create a code converter bound to a buffer. MConverter * mconv_stream_converter (MSymbol name, FILE *fp) Create a code converter bound to a stream. int mconv_reset_converter (MConverter *converter) Reset a code converter. void mconv_free_converter (MConverter *converter) Free a code converter. MConverter * mconv_rebind_buffer (MConverter *converter, const unsigned char *buf, int n) Bind a buffer to a code converter. MConverter * mconv_rebind_stream (MConverter *converter, FILE *fp) Bind a stream to a code converter. MText * mconv_decode (MConverter *converter, MText *mt) Decode a byte sequence into an M-text. MText * mconv_decode_buffer (MSymbol name, const unsigned char *buf, int n) Decode a buffer area based on a coding system. MText * mconv_decode_stream (MSymbol name, FILE *fp) Decode a stream input based on a coding system. int mconv_encode (MConverter *converter, MText *mt) Encode an M-text into a byte sequence. int mconv_encode_range (MConverter *converter, MText *mt, int from, int to) Encode a part of an M-text. int mconv_encode_buffer (MSymbol name, MText *mt, unsigned char *buf, int n) Encode an M-text into a buffer area. int mconv_encode_stream (MSymbol name, MText *mt, FILE *fp) Encode an M-text to write to a stream. int mconv_getc (MConverter *converter) Read a character via a code converter. int mconv_ungetc (MConverter *converter, int c) Push a character back to a code converter. int mconv_putc (MConverter *converter, int c) Write a character via a code converter. MText * mconv_gets (MConverter *converter, MText *mt) Read a line using a code converter. -1c
m17nDebug, Debugging(3, 3m17n)
Support for m17n library users to debug their programs. Functions +1c MCharTable * mdebug_dump_chartab (MCharTable *table, int indent) Dump a chartable. MFace * mdebug_dump_face (MFace *face, int indent) Dump a face. MFont * mdebug_dump_font (MFont *font) Dump a font. MFontset * mdebug_dump_fontset (MFontset *fontset, int indent) Dump a fontset. MInputMethod * mdebug_dump_im (MInputMethod *im, int indent) Dump an input method. int mdebug_hook () Hook function called on an error. MText * mdebug_dump_mtext (MText *mt, int indent, int fullp) Dump an M-text. MPlist * mdebug_dump_plist (MPlist *plist, int indent) Dump a property list. MSymbol mdebug_dump_symbol (MSymbol symbol, int indent) Dump a symbol. MSymbol mdebug_dump_all_symbols (int indent) Dump all symbol names. -1c
m17nFace, Face(3, 3m17n)
A face is an object to control appearance of M-text. Data Structures +1c struct MFaceHLineProp Type of horizontal line spec of face. struct MFaceBoxProp Type of box spec of face. -1c Variables: Keys of face property +1c MSymbol Mforeground Key of a face property specifying foreground color. MSymbol Mbackground Key of a face property specifying background color. MSymbol Mvideomode Key of a face property specifying video mode. MSymbol Mratio Key of a face property specifying font size ratio. MSymbol Mhline Key of a face property specifying horizontal line. MSymbol Mbox Key of a face property specifying box. MSymbol Mfontset Key of a face property specifying fontset. MSymbol Mhook_func Key of a face property specifying hook. MSymbol Mhook_arg Key of a face property specifying argument of hook. -1c Variables: Possible values of #Mvideomode property of face See the documentation of the variable Mvideomode. +1c MSymbol Mnormal MSymbol Mreverse -1c Variables: Predefined faces +1c MFace * mface_normal_video Normal video face. MFace * mface_reverse_video Reverse video face. MFace * mface_underline Underline face. MFace * mface_medium Medium face. MFace * mface_bold Bold face. MFace * mface_italic Italic face. MFace * mface_bold_italic Bold italic face. MFace * mface_xx_small Smallest face. MFace * mface_x_small Smaller face. MFace * mface_small Small face. MFace * mface_normalsize Normalsize face. MFace * mface_large Large face. MFace * mface_x_large Larger face. MFace * mface_xx_large Largest face. MFace * mface_black Black face. MFace * mface_white White face. MFace * mface_red Red face. MFace * mface_green Green face. MFace * mface_blue Blue face. MFace * mface_cyan Cyan face. MFace * mface_yellow yellow face. MFace * mface_magenta Magenta face. -1c Variables: The other symbols for face handling. +1c MSymbol Mface Key of a text property specifying a face. -1c Typedefs +1c typedef struct MFace MFace Type of faces. typedef void(* MFaceHookFunc )(MFace *face, void *arg, void *info) Type of hook function of face. -1c Functions +1c MFace * mface () Create a new face. MFace * mface_copy (MFace *face) Make a copy of a face. int mface_equal (MFace *face1, MFace *face2) Compare faces. MFace * mface_merge (MFace *dst, MFace *src) Merge faces. MFace * mface_from_font (MFont *font) Make a face from a font. void * mface_get_prop (MFace *face, MSymbol key) Get the value of a face property. MFaceHookFunc mface_get_hook (MFace *face) Get the hook function of a face. int mface_put_prop (MFace *face, MSymbol key, void *val) Set a value of a face property. int mface_put_hook (MFace *face, MFaceHookFunc func) Set a hook function to a face. void mface_update (MFrame *frame, MFace *face) Update a face. -1c
m17nFrame, Frame(3, 3m17n)
A frame is an object corresponding to the graphic device. Variables: Keys of frame parameter These are the symbols to use in a parameter to create a frame. See the function mframe() for details. Mdevice, Mdisplay, Mscreen, Mdrawable, Mdepth, and Mcolormap are also keys of a frame property. +1c MSymbol Mdevice MSymbol Mdisplay MSymbol Mscreen MSymbol Mdrawable MSymbol Mdepth MSymbol Mcolormap MSymbol Mwidget MSymbol Mgd -1c Variables: Keys of frame property These are the symbols to use as an argument to the function mframe_get_prop(). +1c MSymbol Mfont MSymbol Mfont_width MSymbol Mfont_ascent MSymbol Mfont_descent -1c Typedefs +1c typedef struct MFrame MFrame Type of frames. -1c Functions +1c MFrame * mframe (MPlist *plist) Create a new frame. void * mframe_get_prop (MFrame *frame, MSymbol key) Return property value of frame. -1c Variables +1c MFrame * mframe_default The default frame. -1c
m17nInputMethod, Input(3, 3m17n) - Method (basic)
API for Input method. Data Structures +1c struct MInputDriver Structure of input method driver. struct MInputMethod Structure of input method. struct MInputContext Structure of input context. -1c Variables: Predefined symbols for callback commands. These are the predefined symbols that are used as the COMMAND argument of callback functions of an input method driver (see MInputDriver::callback_list). Most of them do not require extra argument nor return any value; exceptions are these: Minput_get_surrounding_text: When a callback function assigned for this command is called, the first element of MInputContext::plist has key Minteger and the value specifies which portion of the surrounding text should be retrieved. If the value is positive, it specifies the number of characters following the current cursor position. If the value is negative, the absolute value specifies the number of characters preceding the current cursor position. If the value is zero, it means that the caller just wants to know if the surrounding text is currently supported or not. If the surrounding text is currently supported, the callback function must set the key of this element to Mtext and the value to the retrieved M-text. The length of the M-text may be shorter than the requested number of characters, if the available text is not that long. The length can be zero in the worst case. Or, the length may be longer if an application thinks it is more efficient to return that length. If the surrounding text is not currently supported, the callback function should return without changing the first element of MInputContext::plist. Minput_delete_surrounding_text: When a callback function assigned for this command is called, the first element of MInputContext::plist has key Minteger and the value specifies which portion of the surrounding text should be deleted in the same way as the case of Minput_get_surrounding_text. The callback function must delete the specified text. It should not alter MInputContext::plist. +1c MSymbol Minput_preedit_start MSymbol Minput_preedit_done MSymbol Minput_preedit_draw MSymbol Minput_status_start MSymbol Minput_status_done MSymbol Minput_status_draw MSymbol Minput_candidates_start MSymbol Minput_candidates_done MSymbol Minput_candidates_draw MSymbol Minput_set_spot MSymbol Minput_toggle MSymbol Minput_reset MSymbol Minput_get_surrounding_text MSymbol Minput_delete_surrounding_text -1c Variables: Predefined symbols for special input events. These are the predefined symbols that are used as the KEY argument of minput_filter(). +1c MSymbol Minput_focus_out MSymbol Minput_focus_in MSymbol Minput_focus_move -1c Variables: Predefined symbols used in input method information. +1c MSymbol Minherited MSymbol Mcustomized MSymbol Mconfigured -1c Functions +1c MInputMethod * minput_open_im (MSymbol language, MSymbol name, void *arg) Open an input method. void minput_close_im (MInputMethod *im) Close an input method. MInputContext * minput_create_ic (MInputMethod *im, void *arg) Create an input context. void minput_destroy_ic (MInputContext *ic) Destroy an input context. int minput_filter (MInputContext *ic, MSymbol key, void *arg) Filter an input key. int minput_lookup (MInputContext *ic, MSymbol key, void *arg, MText *mt) Look up a text produced in the input context. void minput_set_spot (MInputContext *ic, int x, int y, int ascent, int descent, int fontsize, MText *mt, int pos) Set the spot of the input context. void minput_toggle (MInputContext *ic) Toggle input method. void minput_reset_ic (MInputContext *ic) Reset an input context. MPlist * minput_get_title_icon (MSymbol language, MSymbol name) Get title and icon filename of an input method. MText * minput_get_description (MSymbol language, MSymbol name) Get description text of an input method. MPlist * minput_get_command (MSymbol language, MSymbol name, MSymbol command) Get information about input method command(s). int minput_config_command (MSymbol language, MSymbol name, MSymbol command, MPlist *keyseqlist) Configure the key sequence of an input method command. MPlist * minput_get_variable (MSymbol language, MSymbol name, MSymbol variable) Get information about input method variable(s). int minput_config_variable (MSymbol language, MSymbol name, MSymbol variable, MPlist *value) Configure the value of an input method variable. char * minput_config_file () Get the name of per-user customization file. int minput_save_config (void) Save configurations in per-user customization file. -1c Obsolete functions +1c MPlist * minput_get_variables (MSymbol language, MSymbol name) Get a list of variables of an input method (obsolete). int minput_set_variable (MSymbol language, MSymbol name, MSymbol variable, void *value) Set the initial value of an input method variable. MPlist * minput_get_commands (MSymbol language, MSymbol name) Get information about input method commands. int minput_assign_command_keys (MSymbol language, MSymbol name, MSymbol command, MPlist *keyseq) Assign a key sequence to an input method command (obsolete). int minput_callback (MInputContext *ic, MSymbol command) Call a callback function. -1c Typedefs +1c typedef struct MInputMethod MInputMethod See struct MInputMethod. typedef struct MInputContext MInputContext See struct MInputContext. typedef void(* MInputCallbackFunc )(MInputContext *ic, MSymbol command) Type of input method callback functions. -1c Enumerations +1c enum MInputCandidatesChanged { MINPUT_CANDIDATES_LIST_CHANGED = 1, MINPUT_CANDIDATES_INDEX_CHANGED = 2, MINPUT_CANDIDATES_SHOW_CHANGED = 4, MINPUT_CANDIDATES_CHANGED_MAX } Bit-masks to specify how candidates of input method is changed. -1c Variables +1c MSymbol Minput_method Symbol whose name is 'input-method'. MInputDriver minput_default_driver The default driver for internal input methods. MInputDriver * minput_driver The driver for internal input methods. MSymbol Minput_driver -1c
m17nSymbol, Symbol(3, 3m17n)
Symbol objects and API for them. Typedefs +1c typedef struct MSymbolStruct * MSymbol Type of symbols. -1c Functions +1c MSymbol msymbol (const char *name) Get a symbol. MSymbol msymbol_as_managing_key (const char *name) Create a managing key. int msymbol_is_managing_key (MSymbol symbol) Check if a symbol is a managing key. MSymbol msymbol_exist (const char *name) Search for a symbol that has a specified name. char * msymbol_name (MSymbol symbol) Get symbol name. int msymbol_put (MSymbol symbol, MSymbol key, void *val) Set the value of a symbol property. void * msymbol_get (MSymbol symbol, MSymbol key) Get the value of a symbol property. int msymbol_put_func (MSymbol symbol, MSymbol key, M17NFunc func) Set the value (function pointer) of a symbol property. M17NFunc msymbol_get_func (MSymbol symbol, MSymbol key) Get the value (function pointer) of a symbol property. -1c Variables +1c MSymbol Mnil Symbol whose name is 'nil'. MSymbol Mt Symbol whose name is 't'. MSymbol Mstring Symbol whose name is 'string'. MSymbol Msymbol Symbol whose name is 'symbol'. -1c
mach-symbol, symopen, ffindsym, file2pc, fileline, findexsym, findhdr, findlsym, findsym, flookupsym, fnbound, indexlsym, indexsym, line2pc, lookuplsym, lookupsym, pc2file, pc2line, symclose, symoff(3)
symbol table access functions
Mail::Box::MH::Labels(3)
maintain MH message related labels
Mail::Graph(3)
draw graphical stats for mails/spams
Mail::Message::Convert::EmailSimple(3)
translate Mail::Message to Email::Simple vv
Mail::SendEasy(3)
Send plain/html e-mails through SMTP servers (platform independent). Supports SMTP authentication and attachments.
Mail::Sender(3)
module for sending mails with attachments through an SMTP server Version 0.8.23
Mail::SpamAssassin::Plugin::DNSEval, DNSEVAL(3)
look up URLs against DNS blocklists check_rbl_from_domain 4 This checks all the from addrs domain names as an alternate to check_rbl_from_host. As of v3.4.1, it has been improved to include a subtest for a specific octet.
Mail::SpamAssassin::Plugin::PhishTag, PhishTag(3)
SpamAssassin plugin for redirecting links in incoming emails.
Mail::SpamAssassin::Plugin::URIDNSBL, URIDNSBL(3)
look up URLs against DNS blocklists
Marpa::Advanced::Models(3)
Other Input Models
Marpa::PP::Advanced::Models(3)
Other Input Models
Marpa::PP::Semantics::Infinite(3)
How Marpa Deals with Infinite Cycles
Marpa::PP::Semantics::Null(3)
How Marpa Evaluates Null Rules and Symbols
Marpa::XS::Advanced::Models(3)
Other Input Models
Marpa::XS::Semantics::Infinite(3)
How Marpa Deals with Infinite Cycles
Marpa::XS::Semantics::Null(3)
How Marpa Evaluates Null Rules and Symbols
masked_blit(3)
Copies a rectangle skipping pixels with the mask color. Allegro game programming library.
masked_stretch_blit(3)
Scales a rectangular area skipping pixels with the mask color. Allegro game programming library.
Math::Algebra::Symbols(3)
Math::Algebra::Symbols
Math::Algebra::Symbols::Sum(3)
Math::Algebra::Symbols::Sum
Math::Algebra::Symbols::Term(3)
Math::Algebra::Symbols::Term
Math::ConvexHull(3)
Calculate convex hulls using Graham's scan (n*log(n))
Math::GSL::IEEEUtils(3)
IEEE Utility Functions 1;
Math::GSL::Poly(3)
Solve and evaluate polynomials
Math::IntervalSearch(3)
Search where an element lies in a list of sorted elements
Math::MatrixReal(3)
Matrix of Reals Implements the data type "matrix of real numbers" (and consequently also "vector of real numbers").
Math::Symbolic::Base(3)
Base class for symbols in symbolic calculations
Math::Utils(3)
Useful mathematical functions not in Perl.
mbksetautoackchld(3)
Tells Alliance to automatically handle terminaison of child process.
mchar_list_charset(3, 3m17n)
List symbols representing charsets.
mconv_list_codings(3, 3m17n)
List symbols representing coding systems.
mdebug_dump_all_symbols(3, 3m17n)
Dump all symbol names.
Memcached::libmemcached::memcached_pool, memcached_pool_create, memcached_pool_destroy, memcached_pool_pop, memcached_pool_push(3)
Manage pools
memlayer, memdraw, memlalloc, memldelete, memlexpose, memlfree, memlhide, memline, memlnorefresh, memload, memlorigin, memlsetrefresh, memltofront, memltofrontn, memltorear, memltorearn, memunload(3)
windows of memory-resident images
Meta::Builder(3)
Tools for creating Meta objects to track custom metrics.
MetaCPAN::Client::Package(3)
A package data object (02packages.details entry)
MIME::Base64::URLSafe(3)
Perl version of Python's URL-safe base64 codec
MIME::Tools, MIME-tools(3)
modules for parsing (and creating!) MIME entities
Mock::Quick::Util(3)
Uitls for Mock::Quick.
modelmbkrds(3)
gets all models of instances contained in a figure.
ModPerl::MM(3)
A "subclass" of ExtUtils::MakeMaker for mod_perl 2.0
Module::Build::Compat(3)
Compatibility with ExtUtils::MakeMaker
Module::CoreList::Utils(3)
what utilities shipped with versions of perl
Module::Install::Makefile, Module::Install::MakeMaker(3)
Extension Rules for ExtUtils::MakeMaker
Module::Install::With(3)
find environnement for Module::Install interactive The "interactive" function tests for an install that has a user present (or at least, one in which it is reasonable for us to present prompts and other similar types of things). Returns true if in an interactive environment, or false otherwise. automated_testing Are we currently running in an automated testing environment, such as CPAN Testers. This is primarily a cleaner and more human-readable equivalent of checking $ENV{AUTOMATED_TESTING} yourself, but may be improved in line with best practices at a later date. release_testing Are we currently running in an release testing environment. That is, are we in the process of running in a potential highly-intensive and high dependency bloat testing process prior to packaging a module for release. This is primarily a cleaner and more human-readable equivalent of checking $ENV{RELEASE_TESTING} yourself, but may be improved in line with best practices at a later date. win32 The "win32" function tests if the Makefile.PL is currently running in a native Microsoft Windows Perl, such as ActivePerl or Strawberry Perl. This is primarily a cleaner and more human-readable equivalent of checking "$^O eq 'MSWin32'" yourself, but may be improved in line with best practices at a later date. winlike The "winlike" function tests if the Makefile.PL is currently running in a Microsoft Windows Perl, under either cygwin or a native Win32 Perl. This is primarily a cleaner and more human-readable equivalent of checking "$^O eq 'MSWin32' or $^O eq 'cygwin'"yourself, but may be improved in line with best practices at a later date.
Module::Setup::Test::Utils(3)
Test utils
Module::Util(3)
Module name tools and transformations
MogileFS::Utils(3)
Command line utilities for the MogileFS distributed file system.
Mojo::IOLoop::TLS(3)
Non-blocking TLS handshake
Mojolicious::Plugin::SetUserGroup(3)
Mojolicious plugin to set unprivileged credentials
MojoMojo::Prefs(3)
info on MojoMojo configurable preferences MojoMojo has a number of preferences that can be set in "Site settings" ("/.admin"). If values are not set in the database, they are read from mojomojo.conf, or default values are used. admins Login names of users with admin privileges. Default: 'admin'. name Site name. Default: 'MojoMojo'. main_formatter Specify which formatter to use as the main text formatter. The two options so far ares Markdown and Textile, with Markdown being default thanks to its versatility. For a comparison between the two, see <http://mojomojo.org/documentation/cheatsheet>. open_registration Controld whether user registration is available. Default: false. anonymous_user If set, users are allowed to post anonymously, and the edit will be shown with the username set in this option. restricted_user If set to a true value, normal users are restricted to editing pages inside their user space (the subpages of "/username"). Admin users can edit the entire site. Default: false. enforce_login If set, users are forced to login before performing any action. Default: false. check_permission_on_view If set, permissions to view are checked on view and search. Default: is false. create_allowed, delete_allowed, edit_allowed, view_allowed, attachment_allowed If true, anonymous users can create, delete, edit, view, and manipulate attachments, respectively. Defaults: true. entropy Random string used to generate secret keys for mail verification and such. disable_search If set, will use Google for site search. Currently highly recommended because KinoSearch consumes 100% CPU (see <http://github.com/marcusramberg/mojomojo/issues#issue/32>). use_captcha Control CAPTCHA for new user registration and anonymous edits. Default: false. theme Name of the active theme. Default: 'default'. cache_permission_data If set, permissions are cached. Default: true. default_lang Set the default language used for: o 4 roles and the 'admin' username when creating the database o 4 whenever no language is set via the UI and one is needed to display site text and navigation links, configure CAPTCHA, output language-specific plugin text etc. Currently supported values are: o 4 "en" - English o 4 "de" - German o 4 "fr" - French o 4 "ja" - Japanese o 4 "no" - Norwegian o 4 "ca" - Catalan o 4 "es" - Spanish o 4 "pl" - Polish o 4 "ru" - Russian Default: "en"
MojoMojo::Schema::Result::Journal(3)
store journals
MojoMojo::Schema::ResultSet::Attachment(3)
resulset methods on attachments
MongoDB::BSON(3)
Tools for serializing and deserializing data in BSON form
Monitor::Simple::Utils(3)
See documentation in Monitor::Simple
Moose::Cookbook::Legacy::Labeled_AttributeMetaclass(3)
A meta-attribute, attributes with labels
Moose::Cookbook::Meta::Labeled_AttributeTrait(3)
Labels implemented via attribute traits
Moose::Manual::Resources(3)
Links to various tutorials, videos, blogs, presentations, interviews, etc...
MooseX::App::Utils(3)
Utility functions
MooseX::MarkAsMethods(3)
Mark overload code symbols as methods
MooseX::Meta::Method::Authorized(3)
Authorization in method calls
MooseX::Params::Validate::Exception::ValidationFailedForTypeConstraint(3)
Exception thrown when a type constraint check fails
MooseX::Types::Signal(3)
a type to represent valid UNIX or Perl signals
MooX::Options::Manual::MooXCmd(3)
Manage your tools with MooX::Cmd
MoreLabels(3, 3o)
Extra labeled libraries.
MoreLabels.Hashtbl(3, 3o)
no description
MoreLabels.Hashtbl.HashedType(3, 3o)
no description
MoreLabels.Hashtbl.Make(3, 3o)
no description
MoreLabels.Hashtbl.MakeSeeded(3, 3o)
no description
MoreLabels.Hashtbl.S(3, 3o)
no description
MoreLabels.Hashtbl.SeededHashedType(3, 3o)
no description
MoreLabels.Hashtbl.SeededS(3, 3o)
no description
MoreLabels.Map(3, 3o)
no description
MoreLabels.Map.Make(3, 3o)
no description
MoreLabels.Map.OrderedType(3, 3o)
no description
MoreLabels.Map.S(3, 3o)
no description
MoreLabels.Set(3, 3o)
no description
MoreLabels.Set.Make(3, 3o)
no description
MoreLabels.Set.OrderedType(3, 3o)
no description
MoreLabels.Set.S(3, 3o)
no description
mouse_needs_poll(3)
Tells if the mouse driver requires polling. Allegro game programming library.
mouse_on_screen(3)
Tells you whether the mouse pointer is currently on screen. Allegro game programming library.
mousescrollsize(3)
compute mouse scroll increment
mp, mpsetminbits, betomp, crtin, crtout, crtpre, crtprefree, crtresfree, itomp, letomp, mpadd, mpassign, mpbits, mpcmp, mpcopy, mpdigdiv, mpdiv, mpexp, mpextendedgcd, mpfactorial, mpfmt, mpfree, mpinvert, mpleft, mplowbits0, mpmagadd, mpmagcmp, mpmagsub, mpmod, mpmul, mpnew, mpnorm, mprand, mpright, mpsignif, mpsub, mptoa, mptobe, mptoi, mptole, mptoui, mptouv, mptov, mpvecadd, mpveccmp, mpvecdigmuladd, mpvecdigmulsub, mpvecmul, mpvecsub, strtomp, uitomp, uvtomp, vtomp(3)
extended precision arithmetic
MP3::Tag::Utils(3)
Assorted utilities for manipulating MP3 files via MP3::Tag.
mp3lint-tools(3)
tools and tests available in mp3lint
MP4GetTrackVideoHeight(3)
Get the video height in pixels of the specified video track
MP4GetTrackVideoWidth(3)
Get the video width in pixels of the specified video track
MPI_Cancel(3)
Cancels a communication request
MPI_Cancel(3)
Cancels a communication request.
MPI_Pcontrol(3)
Controls profiling
MPI_Pcontrol(3)
Controls profiling.
MPI_Win_fence(3)
Synchronizes RMA calls on a window.
MrmFetchSetValues(3)
Fetches the values to be set from literals stored in UID files
MRO::Compat(3)
mro::* interface compatibility for Perls < 5.9.5
mtools(3, 5)
mtools
Munin::Common::TLS, Munin::Node::TLS(3)
Abstract base class implementing the STARTTLS protocol
Munin::Common::TLSClient, Munin::Node::TLSClient(3)
Implements the client side of the STARTTLS protocol
Munin::Common::TLSServer, Munin::Node::TLSServer(3)
Implements the server side of the STARTTLS protocol
Munin::Master::Utils(3)
Exports a lot of utility functions.
Munin::Node::Utils(3)
Various utility functions
Munin::Plugin(3)
Utility functions for Perl Munin plugins. Usage CW use lib $ENV{'MUNIN_LIBDIR'}; use Munin::Plugin; R If your Munin installation predates the MUNIN_* environment variables (introduced in 1.3.3) you can put this in your plugin configuration: CW [*] env.MUNIN_PLUGSTATE /var/lib/munin-node/plugin-state env.MUNIN_LIBDIR /usr/share/munin R IF, indeed that is the munin plugin state directory. The default install directory for Munin::Plugin is in Perl's module search path, the "use lib" is there for the cases where this is not so, and the variable needs to be set to stop Perl from complaining. The module exports these functions: clean_fieldname, set_state_name, save_state, restore_state, tail_open, tail_close. Variables The module instantiates a number of variables in the $Munin::Plugin scope. None of these are exported, and they must be referenced by the full names shown here. $Munin::Plugin::me The name of the plugin without any prefixing directory names and so on. Same as "basename $0" in a shell. It is a very good idea to use this in warning and/or error messages so that the logs show clearly what plugin the error message comes from. $Munin::Plugin::pluginstatedir Identical to the environment variable MUNIN_PLUGSTATE (available since Munin 1.3.3) You can use this if you need to save several different state files. But there is also a function to change the state file name so the state file support functions can be used for several state files. If its value cannot be determined the plugin will be aborted at once with an explanatory message. The most likely causes are: o 8 You are running the plugin directly and not from munin-node or munin-run; o 8 Your munin-node is too old; o 8 munin-node was installed incorrectly. The two last points can be worked around by the plugin configuration shown at the beginning of this document. $Munin::Plugin::statefile The automatically calculated name for the plugins state file. The name is supplied by munin-node or munin-run (in the MUNIN_STATEFILE environment variable). The file name contains the plugin name and the IP address of the munin-master the node is talking to (munin-run leaves the master part blank). This enables stateful plugins that calculate gauges and assume a 5 minute run interval to work correctly in setups with multiple masters (this is not a uncommon way to set up Munin). To change the value of this please use the set_state_name($) procedure (see below). $Munin::Plugin::DEBUG Set to true if the plugin should emit debug output. There are some (but not many) debug print statements in the Module as well, which all obey this variable. Set from the MUNIN_DEBUG environment variable. Defaults to false (0). Functions $fieldname = clean_fieldname($input_fieldname) Munin plugin field names are restricted with regards to what characters they may use: The characters must be "[a-zA-Z0-9_]", while the first character must be "[a-zA-Z_]". To satisfy these demands the function replaces illegal characters with a '_'. See also <http://munin-monitoring.org/wiki/notes_on_datasource_names> set_state_name($statefile_name) Override the default statefile name. This only modifies the filename part, not the directory name. The function unconditionally appends "-$MUNIN_MASTER_IP" to the file name to support multiple masters as described in the documentation for the statefile variable (above). Calling this function is not normally needed and is not recommended. save_state(@state_vector) Save the passed state vector to the state file appropriate for the plugin. The state vector should contain only strings (or numbers), and absolutely no objects or references. The strings may contain newlines without ill effect. If the file cannot be opened for writing the plugin will be aborted. The state file name is determined automatically based on the name of the process we're running as. See $Munin::Plugin::me, $Munin::Plugin::statefile and set_state_name above about the file name. The file will contain a starting line with a magic number so that the library can see the difference between an actual state file and a file containing rubbish. Currently this magic number is '%MUNIN-STATE1.0\n'. Files with this magic number will contain the vector verbatim with \r, \n and % URL encoded. The function takes security precautions, like protesting fatally if the state file is a symbolic link (symbolic link overwriting can have unfortunate security ramifications). @state_vector = restore_state() Read state from the state file written by save_state(@). If everything is OK the state vector will be returned. undef will be returned if the file cannot be opened. Likewise if it does not have a recognized magic number (in this case a warning will also be printed, which will appear in the munin-node logs). ($warning, $critical) = get_thresholds($field, [$warning_env, [$critical_env]]) Look up the thresholds for the specified field from the environment variables named after the field: "$field_warning" and "$field_critical". Return their values. If there are no $field_warning or $field_critical values then look for the variables "warning" and "critical" and return those values if any. If the second and/or third arguments are specified then they will be used to specify the name of variables giving the the warning and critical levels. If no values are found for a threshold then undef is returned. print_thresholds($field, [$warning_env, [$critical_env]]) If $field has warning or critical thresholds set for it, prints them in the default fashion (eg. 'field.warning 42'). See get_thresholds for an explanation of the arguments. adjust_threshold($threshold, $base) If $threshold contains % signs, return a new threshold with adjusted values for these percentages against $base. ($file_handle,$rotated) = tail_open($file_name, $position) Open the file and seek to the given position. If this position is beyond the end of the file the function assumes that the file has been rotated, and the file position will be at the start of the file. If the file is opened OK the function returns a tuple consisting of the file handle and a file rotation indicator. $rotated will be 1 if the file has been rotated and 0 otherwise. Also, if the file was rotated a warning is printed (this can be found in the munin-node log or seen in the terminal when using munin-run). At this point the plugin can read from the file with <$file_handle> in loop as usual until EOF is encountered. If the file cannot be stat'ed "(undef,undef)" is returned. If the file cannot be opened for reading the plugin is aborted with a error in the interest of error-obviousness. $position = tail_close($file_handle) Close the the file and return the current position in the file. This position can be stored in a state file until the next time the plugin runs. If the "close" system call fails, a warning will be printed (which can be found in the munin-node log or seen when using munin-run). $string = scaleNumber($number, $unit, $ifZero, $format); Returns a string representation of the given number scaled in SI prefixes such as G(iga), M(ega), and k(ilo), m(illi), u (for micro) and so on for magnitudes from 10^-24 to 10^24. The $unit is the base unit for the number and is appended to the prefix. The contents of $ifZero is used if the number is 0 (smaller than 10^-26), instead of any other string. In some contexts "" (empty string) is most appropriate and sometimes "0" without any scale or prefix is more appropriate. $format can be any valid Perl printf format string. The default is "%.1f%s%s". The $format may be specified as a whole string such as "The interface speed is %.1f%s%s.". In that case, $ifZero could be set to "The interface is down" -- some equipment uses an interface speed of 0 for a downed interface, and some don't. need_multigraph() Should be called at the top of all multigraph plugins. Checks the current environment, and exits with appropriate output if it doesn't support multigraph plugins. Testing There is some test stuff in this module. CW Test like this: MUNIN_PLUGSTATE=/var/lib/munin-node/plugin-state -e 'require "Plugin.pm.in"; Munin::Plugin::_test;' -- or something. sub _test () { my $pos; my $fh; my $reset; warn "Testing tail and state file. Press ^C to stop\n"; do { $pos = undef; ($pos) = restore_state(); $pos = 0 unless defined($pos); ($fh,$reset) = tail_open('/var/log/messages',$pos); while (<$fh>) { print; } $pos = tail_close($fh); print "**Position is $pos\n"; save_state($pos); } while sleep 1; } R
MySQL::Diff::Utils(3)
Supporting functions for MySQL:Diff
mysqlsla(3)
Parse, filter, analyze and sort MySQL slow, general and binary logs
naturalstrcmp(3)
compare string in alphabetical order for letters and numerical for digits.
need_uconvert(3)
Tells if a string requires encoding conversion. Allegro game programming library.
Net::Abuse::Utils(3)
Routines useful for processing network abuse
Net::Abuse::Utils::Spamhaus(3)
Perl extension for checking data against the spamhaus blacklists
Net::Amazon::EC2::Details(3)
Net::Amazon::EC2::Details
Net::Amazon::MechanicalTurk::Command::AddRetry(3)
Adds retry support for MechanicalTurk API calls. This module adds the addRetry method to the Net::Amazon::MechanicalTurk class.
Net::Amazon::Validate::ItemSearch::de::Tools(3)
valid search indicies for the de locale and the Tools SearchIndex.
Net::Amazon::Validate::ItemSearch::us::Tools(3)
valid search indicies for the us locale and the Tools SearchIndex.
Net::AMQP::Common(3)
A collection of exportable tools for AMQP (de)serialization
Net::DBus::Error(3)
Error details for remote method invocation
Net::DBus::Exporter(3)
Export object methods and signals to the bus
Net::DBus::Tutorial(3)
tutorials on the Perl DBus APIs
Net::DBus::Tutorial::ExportingObjects(3)
tutorials on providing a DBus service
Net::DNS::RR::TLSA(3)
DNS TLSA resource record
Net::DNS::ToolKit(3)
tools for working with DNS packets
Net::DNS::ToolKit::Debug(3)
ToolKit print tools
Net::DRI::Protocol(3)
Superclass of all Net::DRI Protocols
Net::DRI::Protocol::EPP::Connection(3)
EPP over TCP/TLS Connection Handling (RFC4934) for Net::DRI
Net::DRI::Protocol::IRIS(3)
IRIS Protocols (RFC 3981,3982,3983,4414,4698,4991,4992,4993,5144) for Net::DRI
Net::DRI::Protocol::ResultStatus(3)
Encapsulate Details of an Operation Result (with Standardization on EPP) for Net::DRI
Net::DRI::Transport::Socket(3)
TCP/TLS Socket connection for Net::DRI
Net::FTPSSL(3)
A FTP over SSL/TLS class
Net::Gnats::Command::DBLS(3)
Net::Gnats::Command::DBLS
Net::HTTPS(3)
Low-level HTTP over SSL/TLS connection (client)
Net::IMAP::Simple::PipeSocket(3)
a little wrapper around IPC-Open3 that feels like a socket
Net::Interface::NetSymbols(3)
AF_ PF_ IFxxx type symbols
Net::NSCA::Client::Connection::TLS(3)
Represents the transport layer security on a connection.
Net::NSCA::Client::Utils(3)
Utility functions for Net::NSCA::Client
Net::OpenID::JanRain::Stores::MySQLStore(3)
Net::OpenID::JanRain::Stores::MySQLStore
Net::OpenID::JanRain::Stores::PostgreSQLStore(3)
Net::OpenID::JanRain::Stores::PostgreSQLStore
Net::OpenID::JanRain::Stores::SQLStore(3)
Net::OpenID::JanRain::Stores::SQLStore
Net::OpenID::URIFetch(3)
fetch and cache content from HTTP URLs
Net::OpenID::Yadis(3)
Perform Yadis discovery on URLs
Net::OpenStack::Attack(3)
Tools for stress testing an OpenStack deployment.
Net::OSCAR::Buddylist(3)
tied hash class whose keys are Net::OSCAR::Screennames and which also maintains the ordering of its keys.
Net::Packet::Utils(3)
useful subroutines used in Net::Packet
Net::PcapUtils, "Net::PcapUtils"(3)
Utility routines for Net::Pcap module
Net::Proxy::Connector(3)
Base class for Net::Proxy protocols
Net::Proxy::Connector::connect(3)
Create CONNECT tunnels through HTTP proxies
Net::Proxy::Connector::connect_ssl(3)
Create SSL/CONNECT tunnels through HTTP proxies
Net::SMTP::TLS(3)
An SMTP client supporting TLS and AUTH
Net::SMTP::TLS::ButMaintained(3)
An SMTP client supporting TLS and AUTH (DEPRECATED, use Net::SMTPS instead)
Net::SMTPS(3)
SSL/STARTTLS support for Net::SMTP
Net::SSH::Perl::ChannelMgr(3)
Manages a list of open channels
Net::SSL::CipherSuites, CW(3)
Net::SSL::CipherSuites - functions for getting, filtering lists of SSL/TLS cipher suites R
Net::SSL::GetServerProperties, CW(3)
Net::SSL::GetServerProperties - get properties from SSL/TLS servers R
Net::SSL::Handshake::Extensions(3)
Base class for TLS handshake extensions
Net::SSL::Handshake::Extensions::ECPointFormats(3)
client extension for TLS Handshake to show supported elliptic courves
Net::SSL::Handshake::Extensions::EllipticCurves(3)
client extension for TLS Handshake to show supported elliptic courves
Net::SSL::Handshake::Extensions::ServerName(3)
SNI extension for TLS Handshake
Net::SSL::Handshake::StartTLS::SMTP(3)
SSL Handshake via SMTP+StartTLS
Net::Trac::Mechanize(3)
Provides persistent credentials for the Trac instance
Net::Twitter::Role::RetryOnError(3)
Retry Twitter API calls on error
Net::vCard(3)
Read and write vCard files (RFC 2426). vCard files hold personal information that you would typically find on a business card. Name, numbers, addresses, and even logos. This module can also serve as a base class for other vFile readers.
Net::XMPP2::Error::MUC(3)
MUC error Subclass of Net::XMPP2::Error METHODS type 4 This method returns either: 4 join_timeout 4 If the joining of the room took too long. no_config_form 4 If the room we requested the configuration from didn't provide a data form. subject_change_forbidden 4 If changing the subject of a room is not allowed. message_error 4 If this is an unidentified message error. 4 If we got a presence error the method "presence_error" returns a Net::XMPP2::Error::Presence object with further details. However, this class tries to provide a mapping for you (the developer) to ease the load of figuring out which error means what. To make identification of the errors with XEP-0045 more clear I included the error codes and condition names. Here are the more descriptive types: password_required 4 Entering a room Inform user that a password is required. (Condition: not-authorized, Code: 401) banned 4 Entering a room Inform user that he or she is banned from the room (Condition: forbidden, Code: 403) room_locked 4 Entering a room Inform user that the room does not exist and someone is currently creating it. (Condition: item-not-found, Code: 404) room_not_creatable 4 Entering a room Inform user that room creation is restricted (Condition: not-allowed, Code: 405) use_reserved_nick 4 Entering a room Inform user that the reserved roomnick must be used (Condition: not-acceptable, Code: 406) not_on_memberlist 4 Entering a room Inform user that he or she is not on the member list (Condition: registration-required, Code: 407) nickname_in_use 4 Entering a room Inform user that his or her desired room nickname is in use or registered by another user (Condition: conflict, Code: 409) room_full 4 Entering a room Inform user that the maximum number of users has been reached (Condition: service-unavailable, Code: 503) 4 The condition and code are also available through the Net::XMPP2::Error::Presence object returned by "presence_error", see below. text 4 This method returns a human readable text if one is available. presence_error 4 Returns a Net::XMPP2::Error::Presence object if this error origins to such an error and not some internal error. message_error 4 Returns a Net::XMPP2::Error::Message object if this error origins to such an error and not some internal error.
Net::XMPP2::SimpleConnection(3)
Low level TCP/TLS connection
new_prescr, assume_default_colors_sp, baudrate_sp, beep_sp, can_change_color_sp, cbreak_sp, ceiling_panel, color_content_sp, curs_set_sp, curs_sp_funcs, def_prog_mode_sp, def_shell_mode_sp, define_key_sp, del_curterm_sp, delay_output_sp, doupdate_sp, echo_sp, endwin_sp, erasechar_sp, filter_sp, flash_sp, flushinp_sp, get_escdelay_sp, getmouse_sp, getwin_sp, ground_panel, halfdelay_sp, has_colors_sp, has_ic_sp, has_il_sp, has_key_sp, has_mouse_sp, init_color_sp, init_pair_sp, intrflush_sp, is_term_resized_sp, isendwin_sp, key_defined_sp, keybound_sp, keyname_sp, keyok_sp, killchar_sp, mcprint_sp, mouseinterval_sp, mousemask_sp, mvcur_sp, napms_sp, new_form_sp, new_menu_sp, newpad_sp, newterm_sp, newwin_sp, nl_sp, nocbreak_sp, noecho_sp, nofilter_sp, nonl_sp, noqiflush_sp, noraw_sp, pair_content_sp, putp_sp, qiflush_sp, raw_sp, reset_prog_mode_sp, reset_shell_mode_sp, resetty_sp, resize_term_sp, resizeterm_sp, restartterm_sp, ripoffline_sp, savetty_sp, scr_init_sp, scr_restore_sp, scr_set_sp, set_curterm_sp, set_escdelay_sp, set_tabsize_sp, slk_attr_set_sp, slk_attr_sp, slk_attroff_sp, slk_attron_sp, slk_attrset_sp, slk_clear_sp, slk_color_sp, slk_init_sp, slk_label_sp, slk_noutrefresh_sp, slk_refresh_sp, slk_restore_sp, slk_set_sp, slk_touch_sp, sp_funcs, start_color_sp, term_attrs_sp, termattrs_sp, termname_sp, tgetent_sp, tgetflag_sp, tgetnum_sp, tgetstr_sp, tigetflag_sp, tigetnum_sp, tigetstr_sp, tputs_sp, typeahead_sp, unctrl_sp, unget_wch_sp, ungetch_sp, ungetmouse_sp, update_panels_sp, use_default_colors_sp, use_env_sp, use_legacy_coding_sp, vid_attr_sp, vid_puts_sp, vidattr_sp, vidputs_sp, wunctrl_sp(3, 3X)
curses screen-pointer extension
new_prescr, assume_default_colors_sp, baudrate_sp, beep_sp, can_change_color_sp, cbreak_sp, ceiling_panel, color_content_sp, curs_set_sp, curs_sp_funcs, def_prog_mode_sp, def_shell_mode_sp, define_key_sp, del_curterm_sp, delay_output_sp, doupdate_sp, echo_sp, endwin_sp, erasechar_sp, filter_sp, flash_sp, flushinp_sp, get_escdelay_sp, getmouse_sp, getwin_sp, ground_panel, halfdelay_sp, has_colors_sp, has_ic_sp, has_il_sp, has_key_sp, has_mouse_sp, init_color_sp, init_pair_sp, intrflush_sp, is_term_resized_sp, isendwin_sp, key_defined_sp, keybound_sp, keyname_sp, keyok_sp, killchar_sp, mcprint_sp, mouseinterval_sp, mousemask_sp, mvcur_sp, napms_sp, new_form_sp, new_menu_sp, newpad_sp, newterm_sp, newwin_sp, nl_sp, nocbreak_sp, noecho_sp, nofilter_sp, nonl_sp, noqiflush_sp, noraw_sp, pair_content_sp, putp_sp, qiflush_sp, raw_sp, reset_prog_mode_sp, reset_shell_mode_sp, resetty_sp, resize_term_sp, resizeterm_sp, restartterm_sp, ripoffline_sp, savetty_sp, scr_init_sp, scr_restore_sp, scr_set_sp, set_curterm_sp, set_escdelay_sp, set_tabsize_sp, slk_attr_set_sp, slk_attr_sp, slk_attroff_sp, slk_attron_sp, slk_attrset_sp, slk_clear_sp, slk_color_sp, slk_init_sp, slk_label_sp, slk_noutrefresh_sp, slk_refresh_sp, slk_restore_sp, slk_set_sp, slk_touch_sp, start_color_sp, term_attrs_sp, termattrs_sp, termname_sp, tgetent_sp, tgetflag_sp, tgetnum_sp, tgetstr_sp, tigetflag_sp, tigetnum_sp, tigetstr_sp, tputs_sp, typeahead_sp, unctrl_sp, unget_wch_sp, ungetch_sp, ungetmouse_sp, update_panels_sp, use_default_colors_sp, use_env_sp, use_legacy_coding_sp, vid_attr_sp, vid_puts_sp, vidattr_sp, vidputs_sp, wunctrl_sp(3, 3X, 3x)
curses screen-pointer extension
nn_symbol(3)
query the names and values of nanomsg symbols
nn_symbol_info(3)
query the names and properties of nanomsg symbols
npm-ls(3)
List installed packages
nutscan(3)
Network UPS Tools (NUT) device discovery library
o2i_SCT_LIST, i2o_SCT, i2o_SCT_LIST, o2i_SCT(3)
decode and encode Signed Certificate Timestamp lists in TLS wire format
Object::Array::Plugin::ListMoreUtils(3)
Object::Array::Plugin::ListMoreUtils
Olson::Abbreviations(3)
globally unique timezones abbreviation handling
ONVIF::Analytics::Types::Dot11SignalStrength(3)
ONVIF::Analytics::Types::Dot11SignalStrength
ONVIF::Analytics::Types::MotionInCells(3)
ONVIF::Analytics::Types::MotionInCells
ONVIF::Analytics::Types::RelayLogicalState(3)
ONVIF::Analytics::Types::RelayLogicalState
ONVIF::Analytics::Types::TLSConfiguration(3)
ONVIF::Analytics::Types::TLSConfiguration
ONVIF::Device::Elements::GetNetworkProtocols(3)
ONVIF::Device::Elements::GetNetworkProtocols
ONVIF::Device::Elements::GetNetworkProtocolsResponse(3)
ONVIF::Device::Elements::GetNetworkProtocolsResponse
ONVIF::Device::Elements::SetNetworkProtocols(3)
ONVIF::Device::Elements::SetNetworkProtocols
ONVIF::Device::Elements::SetNetworkProtocolsResponse(3)
ONVIF::Device::Elements::SetNetworkProtocolsResponse
ONVIF::Device::Types::Dot11SignalStrength(3)
ONVIF::Device::Types::Dot11SignalStrength
ONVIF::Device::Types::MotionInCells(3)
ONVIF::Device::Types::MotionInCells
ONVIF::Device::Types::RelayLogicalState(3)
ONVIF::Device::Types::RelayLogicalState
ONVIF::Device::Types::TLSConfiguration(3)
ONVIF::Device::Types::TLSConfiguration
ONVIF::Media::Types::Dot11SignalStrength(3)
ONVIF::Media::Types::Dot11SignalStrength
ONVIF::Media::Types::MotionInCells(3)
ONVIF::Media::Types::MotionInCells
ONVIF::Media::Types::RelayLogicalState(3)
ONVIF::Media::Types::RelayLogicalState
ONVIF::Media::Types::TLSConfiguration(3)
ONVIF::Media::Types::TLSConfiguration
ONVIF::PTZ::Types::Dot11SignalStrength(3)
ONVIF::PTZ::Types::Dot11SignalStrength
ONVIF::PTZ::Types::MotionInCells(3)
ONVIF::PTZ::Types::MotionInCells
ONVIF::PTZ::Types::RelayLogicalState(3)
ONVIF::PTZ::Types::RelayLogicalState
ONVIF::PTZ::Types::TLSConfiguration(3)
ONVIF::PTZ::Types::TLSConfiguration
openpam_borrow_cred(3)
temporarily borrow user credentials
openpam_restore_cred(3)
restore credentials
OpenXPKI::Client::SC::Changecardpolicy(3)
handle_get_card_policy Get the card command to enable/disable the PUK policy on the card. Requires the aes key set in the session. parameters disable 4 Set to the string true to get the PUK disable command, all other values will result in the PUK enable command. response changecardpolicy_wfID 4 0 exec 4 handle_confirm_policy_change parameters changecardpolicy_wfID 4 0 Result 4 Status word from the card plugin, SUCCESS if ok, anything else if not. Reason 4 Verbose reason in case of failure. response state 4
OpenXPKI::Client::SC::Personalization(3)
handle_server_personalization Main interface to personalization workflow, translates action commands and parameters from the frontend to the backend workflow. parameters Parameters depend on the current state. wf_action 4 0 perso_wfID 4 cert0...cert15 4 PKCS10Request 4 KeyID 4 userAccount 4 Result 4 Status word from the card plugin, SUCCESS if ok, anything else if not. Reason 4 Verbose reason in case of failure. response error wf_state perso_wfID exec action
OpenXPKI::Client::SC::Utilities(3)
handle_get_server_status Run without any user/login information. parameters none response #TODO use in frontend unclear, seems like it just pops up the value of get_server_status as message. Should be moved to server to check if capacity for personalizaion is available (volatile workflow) handle_get_card_status Calls the backend API to evaluate the status of the given card parameters cardID 4 cardSerialNumber cardType 4 CardType String cert[int] (optional) 4 certificates cert0 ,cert1 etc. response TODO server_log Write a log message to the log file parameters cardID 4 cardSerialNumber cardType 4 CardType String message 4 Message to write (String) level 4 Log level, one of info|debug|error|warn response TODO
OpenXPKI::FileUtils(3)
OpenXPKI::FileUtils
OpenXPKI::Server::Workflow::Activity::SCEPv2::CalcApprovals(3)
OpenXPKI::Server::Workflow::Activity::SCEPv2::CalcApprovals
OpenXPKI::Server::Workflow::Activity::Tools::Approve(3)
OpenXPKI::Server::Workflow::Activity::Tools::Approve
OpenXPKI::Server::Workflow::Activity::Tools::CalculateApprovalPoints(3)
OpenXPKI::Server::Workflow::Activity::Tools::CalculateApprovalPoints
OpenXPKI::Server::Workflow::Activity::Tools::CalculateKeyId(3)
OpenXPKI::Server::Workflow::Activity::Tools::CalculateKeyId
OpenXPKI::Server::Workflow::Activity::Tools::CancelApprovals(3)
OpenXPKI::Server::Workflow::Activity::Tools::CancelApprovals
OpenXPKI::Server::Workflow::Activity::Tools::CertificateExport(3)
OpenXPKI::Server::Workflow::Activity::Tools::CertificateExport
OpenXPKI::Server::Workflow::Activity::Tools::CertificateExportArchive(3)
OpenXPKI::Server::Workflow::Activity::Tools::CertificateExportArchive
OpenXPKI::Server::Workflow::Activity::Tools::Connector::GetValue(3)
OpenXPKI::Server::Workflow::Activity::Tools::Connector::GetValue
OpenXPKI::Server::Workflow::Activity::Tools::Datapool::AppendToEntry(3)
OpenXPKI::Server::Workflow::Activity::Tools::Datapool::AppendToEntry
OpenXPKI::Server::Workflow::Activity::Tools::Datapool::DeleteEntry(3)
OpenXPKI::Server::Workflow::Activity::Tools::Datapool::DeleteEntry
OpenXPKI::Server::Workflow::Activity::Tools::Datapool::GetEntry(3)
OpenXPKI::Server::Workflow::Activity::Tools::Datapool::GetEntry
OpenXPKI::Server::Workflow::Activity::Tools::Datapool::ModifyEntry(3)
OpenXPKI::Server::Workflow::Activity::Tools::Datapool::ModifyEntry
OpenXPKI::Server::Workflow::Activity::Tools::Datapool::SetEntry(3)
OpenXPKI::Server::Workflow::Activity::Tools::Datapool::SetEntry
OpenXPKI::Server::Workflow::Activity::Tools::Disconnect(3)
OpenXPKI::Server::Workflow::Activity::Tools::Disconnect
OpenXPKI::Server::Workflow::Activity::Tools::EvaluateEligibility(3)
OpenXPKI::Server::Workflow::Activity::Tools::EvaluateEligibility
OpenXPKI::Server::Workflow::Activity::Tools::EvaluateSignerTrust(3)
OpenXPKI::Server::Workflow::Activity::Tools::EvaluateSignerTrust
OpenXPKI::Server::Workflow::Activity::Tools::Export(3)
OpenXPKI::Server::Workflow::Activity::Tools::Export
OpenXPKI::Server::Workflow::Activity::Tools::ExportToFile(3)
OpenXPKI::Server::Workflow::Activity::Tools::ExportToFile
OpenXPKI::Server::Workflow::Activity::Tools::GenerateKey(3)
OpenXPKI::Server::Workflow::Activity::Tools::GenerateKey
OpenXPKI::Server::Workflow::Activity::Tools::GeneratePassword(3)
OpenXPKI::Server::Workflow::Activity::Tools::GeneratePassword
OpenXPKI::Server::Workflow::Activity::Tools::GetCertificateIdentifier(3)
OpenXPKI::Server::Workflow::Activity::Tools::GetCertificateIdentifier
OpenXPKI::Server::Workflow::Activity::Tools::InjectExtraParam(3)
OpenXPKI::Server::Workflow::Activity::Tools::InjectExtraParam
OpenXPKI::Server::Workflow::Activity::Tools::ListActiveToken(3)
OpenXPKI::Server::Workflow::Activity::Tools::ListActiveToken
OpenXPKI::Server::Workflow::Activity::Tools::LoadCertificateMetadata(3)
OpenXPKI::Server::Workflow::Activity::Tools::LoadCertificateMetadata
OpenXPKI::Server::Workflow::Activity::Tools::LoadPolicy(3)
OpenXPKI::Server::Workflow::Activity::Tools::LoadPolicy
OpenXPKI::Server::Workflow::Activity::Tools::Notify(3)
OpenXPKI::Server::Workflow::Activity::Tools::Notify
OpenXPKI::Server::Workflow::Activity::Tools::ParseCertificate(3)
OpenXPKI::Server::Workflow::Activity::Tools::ParseCertificate
OpenXPKI::Server::Workflow::Activity::Tools::ParsePKCS10(3)
OpenXPKI::Server::Workflow::Activity::Tools::ParsePKCS10
OpenXPKI::Server::Workflow::Activity::Tools::Pause(3)
OpenXPKI::Server::Workflow::Activity::Tools::Pause
OpenXPKI::Server::Workflow::Activity::Tools::PublishCA(3)
OpenXPKI::Server::Workflow::Activity::Tools::PublishCA
OpenXPKI::Server::Workflow::Activity::Tools::PublishCertificate(3)
OpenXPKI::Server::Workflow::Activity::Tools::PublishCertificate
OpenXPKI::Server::Workflow::Activity::Tools::PublishCRL(3)
OpenXPKI::Server::Workflow::Activity::Tools::PublishCRL
OpenXPKI::Server::Workflow::Activity::Tools::RenderSubject(3)
OpenXPKI::Server::Workflow::Activity::Tools::RenderSubject
OpenXPKI::Server::Workflow::Activity::Tools::RetrieveCertificate(3)
OpenXPKI::Server::Workflow::Activity::Tools::RetrieveCertificate
OpenXPKI::Server::Workflow::Activity::Tools::RevokeCertificate(3)
OpenXPKI::Server::Workflow::Activity::Tools::RevokeCertificate
OpenXPKI::Server::Workflow::Activity::Tools::SearchCertificates(3)
OpenXPKI::Server::Workflow::Activity::Tools::SearchCertificates
OpenXPKI::Server::Workflow::Activity::Tools::SearchWorkflow(3)
OpenXPKI::Server::Workflow::Activity::Tools::SearchWorkflow
OpenXPKI::Server::Workflow::Activity::Tools::SetAttribute(3)
OpenXPKI::Server::Workflow::Activity::Tools::SetAttribute
OpenXPKI::Server::Workflow::Activity::Tools::SetContext(3)
OpenXPKI::Server::Workflow::Activity::Tools::SetContext
OpenXPKI::Server::Workflow::Activity::Tools::SetContextHash(3)
OpenXPKI::Server::Workflow::Activity::Tools::SetContextHash
OpenXPKI::Server::Workflow::Activity::Tools::SetErrorCode(3)
OpenXPKI::Server::Workflow::Activity::Tools::SetErrorCode
OpenXPKI::Server::Workflow::Activity::Tools::SetSource(3)
OpenXPKI::Server::Workflow::Activity::Tools::SetSource
OpenXPKI::Server::Workflow::Activity::Tools::StringToArray(3)
OpenXPKI::Server::Workflow::Activity::Tools::StringToArray
OpenXPKI::Server::Workflow::Activity::Tools::TriggerCertificatePublish(3)
OpenXPKI::Server::Workflow::Activity::Tools::TriggerCertificatePublish
OpenXPKI::Server::Workflow::Activity::Tools::VerifySignature(3)
OpenXPKI::Server::Workflow::Activity::Tools::VerifySignature
OpenXPKI::Server::Workflow::Activity::Tools::WFArray(3)
OpenXPKI::Server::Workflow::Activity::Tools::WFArray
OpenXPKI::Server::Workflow::Activity::Tools::WFHash(3)
OpenXPKI::Server::Workflow::Activity::Tools::WFHash
OpenXPKI::Server::Workflow::Condition::AlwaysFalse(3)
OpenXPKI::Server::Workflow::Condition::AlwaysFalse
Oryx::Manual::Guts(3)
Oryx internals documentation for developers
pack_ferror(3)
Tells if an error occurred during an operation on the stream. Allegro game programming library.
Padre::Plugin::Devel(3)
tools used by the Padre developers
Padre::Wx::Dialog::OpenURL(3)
a dialog for opening URLs "new" CW my $find = Padre::Wx::Dialog::OpenURL->new($main); R Create and return a "Padre::Wx::Dialog::OpenURL" "Open URL" widget. "modal" CW my $url = Padre::Wx::Dialog::OpenURL->modal($main); R Single-shot modal dialog call to get a URL from the user. Returns a string if the user clicks OK (it may be a null string if they did not enter anything). Returns "undef" if the user hits the cancel button.
Padre::Wx::Role::Idle(3)
Role for delaying method calls until idle time
Padre::Wx::Role::View(3)
A role for GUI tools that live in panels
page_cert(3)
The basic certificate The basic hx509 cerificate object in hx509 is hx509_cert. The hx509_cert object is representing one X509/PKIX certificate and associated attributes; like private key, friendly name, etc. A hx509_cert object is usully found via the keyset interfaces (Certificate store operations), but its also possible to create a certificate directly from a parsed object with hx509_cert_init() and hx509_cert_init_data(). See the library functions here: hx509 certificate functions
pam_setcred(3)
modify / delete user credentials for an authentication service
panda_fullscreen(3)
ask the viewer to display the PDF document in fullscreen mode
panda_nfspagemodde(3)
defines display characteristics for the PDF document if it is using non fullscreen mode after defaulting to fullscreen mode
panda_sethorizontalscaling(3)
set the horizontal scaling of text
PandoraFMS::Tools(3)
PandoraFMS::Tools
panel, bottom_panel, del_panel, hide_panel, move_panel, new_panel, panel_above, panel_below, panel_hidden, panel_userptr, panel_window, replace_panel, set_panel_userptr, show_panel, top_panel, update_panels(3, 3X, 3x)
panel stack extension for curses
panel, bottom_panel, del_panel, hide_panel, move_panel, new_panel, panel_above, panel_below, panel_hidden, panel_userptr, panel_window, replace_panel, set_panel_userptr, show_panel, top_panel, update_panels(3, 3X)
panel stack extension for curses
Parse::CPAN::Packages(3)
Parse 02packages.details.txt.gz
parse_time, print_time_table, unparse_time, unparse_time_approx(3)
parse and unparse time intervals
Path::IsDev::Heuristic::Tool::MakeMaker(3)
Determine if a path is an ExtUtils::MakeMaker Tooled source directory
Paws::CloudTrail::DescribeTrails(3)
Arguments for method DescribeTrails on Paws::CloudTrail
Paws::CloudTrail::DescribeTrailsResponse(3)
Paws::CloudTrail::DescribeTrailsResponse
Paws::CloudTrail::GetTrailStatus(3)
Arguments for method GetTrailStatus on Paws::CloudTrail
Paws::CloudTrail::GetTrailStatusResponse(3)
Paws::CloudTrail::GetTrailStatusResponse
Paws::CodePipeline::GetJobDetails(3)
Arguments for method GetJobDetails on Paws::CodePipeline
Paws::CodePipeline::GetJobDetailsOutput(3)
Paws::CodePipeline::GetJobDetailsOutput
Paws::CodePipeline::GetThirdPartyJobDetails(3)
Arguments for method GetThirdPartyJobDetails on Paws::CodePipeline
Paws::CodePipeline::GetThirdPartyJobDetailsOutput(3)
Paws::CodePipeline::GetThirdPartyJobDetailsOutput
Paws::CognitoIdentity::GetCredentialsForIdentity(3)
Arguments for method GetCredentialsForIdentity on Paws::CognitoIdentity
Paws::CognitoIdentity::GetCredentialsForIdentityResponse(3)
Paws::CognitoIdentity::GetCredentialsForIdentityResponse
Paws::CognitoIdentity::ListIdentityPools(3)
Arguments for method ListIdentityPools on Paws::CognitoIdentity
Paws::CognitoIdentity::ListIdentityPoolsResponse(3)
Paws::CognitoIdentity::ListIdentityPoolsResponse
Paws::CognitoSync::GetBulkPublishDetails(3)
Arguments for method GetBulkPublishDetails on Paws::CognitoSync
Paws::CognitoSync::GetBulkPublishDetailsResponse(3)
Paws::CognitoSync::GetBulkPublishDetailsResponse
Paws::Config::DescribeDeliveryChannels(3)
Arguments for method DescribeDeliveryChannels on Paws::Config
Paws::Config::DescribeDeliveryChannelsResponse(3)
Paws::Config::DescribeDeliveryChannelsResponse
Paws::Config::DescribeDeliveryChannelStatus(3)
Arguments for method DescribeDeliveryChannelStatus on Paws::Config
Paws::Config::DescribeDeliveryChannelStatusResponse(3)
Paws::Config::DescribeDeliveryChannelStatusResponse
Paws::DeviceFarm::ListDevicePools(3)
Arguments for method ListDevicePools on Paws::DeviceFarm
Paws::DeviceFarm::ListDevicePoolsResult(3)
Paws::DeviceFarm::ListDevicePoolsResult
Paws::EC2::CancelSpotFleetRequests(3)
Arguments for method CancelSpotFleetRequests on Paws::EC2
Paws::EC2::CancelSpotFleetRequestsResponse(3)
Paws::EC2::CancelSpotFleetRequestsResponse
Paws::EC2::CancelSpotInstanceRequests(3)
Arguments for method CancelSpotInstanceRequests on Paws::EC2
Paws::EC2::CancelSpotInstanceRequestsResult(3)
Paws::EC2::CancelSpotInstanceRequestsResult
Paws::EC2::DescribeNetworkAcls(3)
Arguments for method DescribeNetworkAcls on Paws::EC2
Paws::EC2::DescribeNetworkAclsResult(3)
Paws::EC2::DescribeNetworkAclsResult
Paws::ElastiCache::CacheParameterGroupDetails(3)
Paws::ElastiCache::CacheParameterGroupDetails
Paws::IAM::GetAccountAuthorizationDetails(3)
Arguments for method GetAccountAuthorizationDetails on Paws::IAM
Paws::IAM::GetAccountAuthorizationDetailsResponse(3)
Paws::IAM::GetAccountAuthorizationDetailsResponse
Paws::MachineLearning::DescribeMLModels(3)
Arguments for method DescribeMLModels on Paws::MachineLearning
Paws::MachineLearning::DescribeMLModelsOutput(3)
Paws::MachineLearning::DescribeMLModelsOutput
Paws::RDS::DBClusterParameterGroupDetails(3)
Paws::RDS::DBClusterParameterGroupDetails
Paws::RDS::DBParameterGroupDetails(3)
Paws::RDS::DBParameterGroupDetails
Paws::RDS::DownloadDBLogFilePortionDetails(3)
Paws::RDS::DownloadDBLogFilePortionDetails
Paws::RedShift::ClusterParameterGroupDetails(3)
Paws::RedShift::ClusterParameterGroupDetails
Paws::StorageGateway::DeleteChapCredentials(3)
Arguments for method DeleteChapCredentials on Paws::StorageGateway
Paws::StorageGateway::DeleteChapCredentialsOutput(3)
Paws::StorageGateway::DeleteChapCredentialsOutput
Paws::StorageGateway::DescribeChapCredentials(3)
Arguments for method DescribeChapCredentials on Paws::StorageGateway
Paws::StorageGateway::DescribeChapCredentialsOutput(3)
Paws::StorageGateway::DescribeChapCredentialsOutput
Paws::StorageGateway::UpdateChapCredentials(3)
Arguments for method UpdateChapCredentials on Paws::StorageGateway
Paws::StorageGateway::UpdateChapCredentialsOutput(3)
Paws::StorageGateway::UpdateChapCredentialsOutput
Paws::Support::DescribeSeverityLevels(3)
Arguments for method DescribeSeverityLevels on Paws::Support
Paws::Support::DescribeSeverityLevelsResponse(3)
Paws::Support::DescribeSeverityLevelsResponse
pbs_rlsjob(3, 3B)
release a hold on a pbs batch job
pbs_selstat(3, 3B)
obtain status of selected pbs batch jobs
PDF::API2::Basic::PDF::Bool(3)
A special form of PDF::String which holds the strings true or false
PDF::API2::Basic::PDF::Objind(3)
PDF indirect object reference. Also acts as an abstract superclass for all elements in a PDF file.
PDF::API2::Basic::PDF::Utils(3)
Utility functions for PDF library
PDF::API3::Compat::API2::Basic::PDF::Bool(3)
A special form of PDF::String which holds the strings true or false
PDF::API3::Compat::API2::Basic::PDF::Objind(3)
PDF indirect object reference. Also acts as an abstract superclass for all elements in a PDF file.
PDF::API3::Compat::API2::Basic::PDF::Utils(3)
Utility functions for PDF library
PDF::API3::Compat::API2::Basic::TTF::AATutils(3)
PDF::API3::Compat::API2::Basic::TTF::AATutils
PDF::API3::Compat::API2::Basic::TTF::Utils(3)
Utility functions to save fingers
PDL::Char(3)
PDL subclass which allows reading and writing of fixed-length character strings as byte PDLs
PDL::Dumper, PDL::IO::Dumper(3)
data dumping for structs with PDLs
PDL::IFiles, PDL::Install::Files(3)
Module for use by ExtUtils::Depends and Inline
PDL::Polynomial, PDL::Fit::Polynomial(3)
routines for fitting with polynomials
PDL::PP::Dump(3)
dump pp_xxx calls to stdout
Perl::Critic::Policy::BuiltinFunctions::ProhibitBooleanGrep(3)
Use "List::MoreUtils::any" instead of "grep" in boolean context.
Perl::Critic::Policy::CodeLayout::RequireFinalSemicolon(3)
require a semicolon at the end of code blocks
Perl::Critic::Policy::ControlStructures::ProhibitCascadingIfElse(3)
Don't write long "if-elsif-elsif-elsif-elsif...else" chains.
Perl::Critic::Policy::ControlStructures::ProhibitCStyleForLoops(3)
Write "for(0..20)" instead of "for($i=0; $i<=20; $i++)".
Perl::Critic::Policy::ControlStructures::ProhibitDeepNests(3)
Don't write deeply nested loops and conditionals.
Perl::Critic::Policy::ControlStructures::ProhibitLabelsWithSpecialBlockNames(3)
Don't use labels that are the same as the special block names.
Perl::Critic::Policy::ControlStructures::ProhibitMutatingListFunctions(3)
Don't modify "$_" in list functions.
Perl::Critic::Policy::ControlStructures::ProhibitNegativeExpressionsInUnlessAndUntilConditions(3)
Don't use operators like "not", "!~", and "le" within "until" and "unless".
Perl::Critic::Policy::ControlStructures::ProhibitPostfixControls(3)
Write "if($condition){ do_something() }" instead of "do_something() if $condition".
Perl::Critic::Policy::ControlStructures::ProhibitUnlessBlocks(3)
Write "if(! $condition)" instead of "unless($condition)".
Perl::Critic::Policy::ControlStructures::ProhibitUnreachableCode(3)
Don't write code after an unconditional "die, exit, or next".
Perl::Critic::Policy::ControlStructures::ProhibitUntilBlocks(3)
Write "while(! $condition)" instead of "until($condition)".
Perl::Critic::Policy::ControlStructures::ProhibitYadaOperator(3)
Never use "..." in production code.
Perl::Critic::Policy::Documentation::ProhibitDuplicateSeeAlso(3)
don't duplicate L<> links in SEE ALSO
Perl::Critic::Policy::Documentation::RequireLinkedURLs(3)
use L<> markup on URLs in POD
Perl::Critic::Policy::InputOutput::ProhibitBacktickOperators(3)
Discourage stuff like "@files = `ls $directory`".
Perl::Critic::Policy::InputOutput::RequireCheckedSyscalls(3)
Return value of flagged function ignored.
Perl::Critic::Policy::Miscellanea::TextDomainPlaceholders(3)
check placeholder names in Locale::TextDomain calls
Perl::Critic::Policy::Modules::ProhibitAutomaticExportation(3)
Export symbols via "@EXPORT_OK" or "%EXPORT_TAGS" instead of "@EXPORT".
Perl::Critic::Policy::Moose::RequireCleanNamespace(3)
Require removing implementation details from you packages.
Perl::Critic::Policy::References::ProhibitDoubleSigils(3)
Write "@{ $array_ref }" instead of "@$array_ref".
Perl::Critic::Policy::Subroutines::ProhibitAmpersandSigils(3)
Don't call functions with a leading ampersand sigil.
Perl::Critic::Policy::TestingAndDebugging::RequireTestLabels(3)
Tests should all have labels.
Perl::Critic::Policy::ValuesAndExpressions::ProhibitInterpolationOfLiterals(3)
Always use single quotes for literal strings.
Perl::Critic::Policy::ValuesAndExpressions::ProhibitLongChainsOfMethodCalls(3)
Long chains of method calls indicate tightly coupled code.
Perl::Critic::Policy::ValuesAndExpressions::ProhibitNullStatements(3)
disallow empty statements (stray semicolons)
Perl::Critic::Policy::ValuesAndExpressions::UnexpandedSpecialLiteral(3)
specials like __PACKAGE__ used literally
Perl::Critic::Policy::Variables::ProhibitPackageVars(3)
Eliminate globals declared with "our" or "use vars".
Perl::Critic::Pulp::Utils(3)
shared helper code for the Pulp perlcritic add-on
Perl::Critic::TestUtils(3)
Utility functions for testing new Policies.
Perl::Critic::Utils(3)
General utility subroutines and constants for Perl::Critic and derivative distributions.
Perl::Critic::Utils::Constants(3)
Global constants.
Perl::Critic::Utils::DataConversion(3)
Utilities for converting from one type of data to another.
Perl::Critic::Utils::McCabe(3)
Functions that calculate the McCabe score of source code.
Perl::Critic::Utils::Perl(3)
Utility functions for dealing with Perl language issues.
Perl::Critic::Utils::POD(3)
Utility functions for dealing with POD.
Perl::Critic::Utils::POD::ParseInteriorSequence(3)
Pod::Parser subclass to find all interior sequences.
Perl::Critic::Utils::PPI(3)
Utility functions for dealing with PPI objects.
Perl::Critic::Utils::PPIRegexp(3)
Utility functions for dealing with PPI regexp tokens.
Perl::Lint::Policy::ControlStructures::ProhibitCascadingIfElse(3)
Perl::Lint::Policy::ControlStructures::ProhibitCascadingIfElse
Perl::Lint::Policy::ControlStructures::ProhibitCStyleForLoops(3)
Perl::Lint::Policy::ControlStructures::ProhibitCStyleForLoops
Perl::Lint::Policy::ControlStructures::ProhibitDeepNests(3)
Perl::Lint::Policy::ControlStructures::ProhibitDeepNests
Perl::Lint::Policy::ControlStructures::ProhibitLabelsWithSpecialBlockNames(3)
Perl::Lint::Policy::ControlStructures::ProhibitLabelsWithSpecialBlockNames
Perl::Lint::Policy::ControlStructures::ProhibitMutatingListFunctions(3)
Perl::Lint::Policy::ControlStructures::ProhibitMutatingListFunctions
Perl::Lint::Policy::ControlStructures::ProhibitNegativeExpressionsInUnlessAndUntilConditions(3)
Perl::Lint::Policy::ControlStructures::ProhibitNegativeExpressionsInUnlessAndUntilConditions
Perl::Lint::Policy::ControlStructures::ProhibitPostfixControls(3)
Perl::Lint::Policy::ControlStructures::ProhibitPostfixControls
Perl::Lint::Policy::ControlStructures::ProhibitUnlessBlocks(3)
Perl::Lint::Policy::ControlStructures::ProhibitUnlessBlocks
Perl::Lint::Policy::ControlStructures::ProhibitUnreachableCode(3)
Perl::Lint::Policy::ControlStructures::ProhibitUnreachableCode
Perl::Lint::Policy::ControlStructures::ProhibitUntilBlocks(3)
Perl::Lint::Policy::ControlStructures::ProhibitUntilBlocks
Perl::Lint::Policy::InputOutput::RequireCheckedSyscalls(3)
Perl::Lint::Policy::InputOutput::RequireCheckedSyscalls
Perl::Lint::Policy::References::ProhibitDoubleSigils(3)
Perl::Lint::Policy::References::ProhibitDoubleSigils
Perl::Lint::Policy::Subroutines::ProhibitAmpersandSigils(3)
Perl::Lint::Policy::Subroutines::ProhibitAmpersandSigils
Perl::Lint::Policy::TestingAndDebugging::RequireTestLabels(3)
Perl::Lint::Policy::TestingAndDebugging::RequireTestLabels
Perl::Lint::Policy::ValuesAndExpressions::ProhibitInterpolationOfLiterals(3)
Perl::Lint::Policy::ValuesAndExpressions::ProhibitInterpolationOfLiterals
Perl::Lint::Policy::ValuesAndExpressions::ProhibitLongChainsOfMethodCalls(3)
Perl::Lint::Policy::ValuesAndExpressions::ProhibitLongChainsOfMethodCalls
Perl::Metrics::Lite::Analysis(3)
Contains anaylsis results.
Perl::Metrics::Lite::FileFinder(3)
find perl files in paths find_files( @directories_and_files ) Uses list_perl_files to find all the readable Perl files and returns a reference to a (possibly empty) list of paths. list_perl_files Takes a list of one or more paths and returns an alphabetically sorted list of only the perl files. Uses is_perl_file so may throw an exception if a file is unreadable. is_perl_file($path) Takes a path to a file and returns true if the file appears to be a Perl file, otherwise returns false. If the file name does not match any of @Perl::Metrics::Lite::PERL_FILE_SUFFIXES then the file is opened for reading and the first line examined for a a Perl 'shebang' line. An exception is thrown if the file cannot be opened in this case.
Perl::Metrics::Simple::Analysis(3)
Contains anaylsis results.
Perl::Unsafe::Signals(3)
Allow unsafe handling of signals in selected blocks
Perlbal::FAQ(3)
Frequently Asked Questions about Perlbal VERSION Perlbal 1.78. DESCRIPTION This document aims at listing several Frequently Asked Questions regarding Perlbal. Configuring Perlbal Is there a sample "perlbal.*" I can use for my "init.d"? Yes, you can find one under "debian/perlbal.init". It implements "start", "stop" and "restart/force-reload". Make sure you adjust it to your particular taste and/or needs. Is there a way to make perlbal re-read the config file without shuting it down? No, there is not. But typically, if you're making changes, you can just make them on the management console, which doesn't require any restart whatsoever. Still, restarting is probably easy. The trick to it is to simulate a graceful restart. How can I implement a graceful restart? Here's a sample script that will allow you to perform a graceful restart: CW $ cat restart-perlbal.sh echo "shutdown graceful" | nc localhost 60000 /usr/local/bin/perlbal --conf=/etc/perlbal.conf R The idea is that you tell the old Perlbal to do a graceful shutdown; that immediately closes all of the listening sockets, so new connections are not accepted. As soon as that's done (which is instant) you can start up a new Perlbal. This gives you a minimum of downtime that can be measured on the order of milliseconds (the time it takes for the new Perlbal to start up). Remember that you need to have a "management" service listening on port 60000 for this example to work. See Perlbal::Manual::Management. Load Balancing What balancing algorithm does Perlbal use? Currently, Perlbal supports only one balancing method: "random". CW SET pool balance_method = 'random' R With this mode, Perlbal selects one of the nodes within the pool randomly for each request received. It prefers reusing existing idle backend connections if backend_persist is enabled, which is faster than waiting for a new connection to open each time. Plugins Can I influence the order plugins are used? Yes. When you set the plugins for your service they get to register their hooks in order. CW SET plugins = AccessControl HighPri R These hooks are pushed into an array, which means that they preserve the order of the plugins. HTTP, SSL Does perlbal support HTTP 1.1? Perlbal for the most part only speaks HTTP/1.0 both to clients and to backend webservers. It happily takes requests advertising HTTP/1.1 and downgrading them to HTTP/1.0 when speaking to backend serves. It knows all about persistent connections (in both 1.0 and 1.1) and will reply with HTTP/1.0 Connection: keep-alive the request was only implicitly keep-alive with HTTP/1.1. etc. Perlbal is now also starting to speak more of 1.1. For instance, Perlbal does support receiving transfer-encoding "chunked" requests from clients (a feature of HTTP/1.1), will send a "100 Continue" in response to "Expect: 100-continue", and will parse the chunked requests, writing the request-of-unknown-length to disk (only if "buffered_uploads" is enabled), and then will send an HTTP/1.0 request to the backends, with the actual "Content-Length" (now known) filled in. When more of 1.1 is supported, it will become an option, and later become the default. However, after several years of usage, there just hasn't been that much of a reason. The chunked requests (common from mobile phones uploading large images) has been the most annoying shortcoming but now that it's solved, it's questionable whether or not more of HTTP/1.1 will be supported. Does perlbal support SSL? Yes. To use SSL mode you'll need IO::Socket::SSL "v0.98+" installed. You can do SSL either on "web_server", "reverse_proxy" or "selector" modes, but not on a vhost-based "selector" service, because SSL and vhosts aren't compatible. See the configuration file ssl.conf under conf/ for an example. SEE ALSO Perlbal::Manual.
Perlbal::Manual(3)
Guide and reference manual for Perlbal VERSION Perlbal 1.78. DESCRIPTION This is the comprehensive guide and reference manual for Perlbal. Perlbal::Manual::Configuration 4 How to configure Perlbal: pools, services, syntax and more. Perlbal::Manual::Contributing 4 How to contribute to Perlbal. Perlbal::Manual::Credits 4 Author and contributor credits for Perlbal. Perlbal::Manual::Debugging 4 How Perlbal's Debugging system works. Perlbal::Manual::FailOver 4 How Perlbal's Fail Over mechanism works. Perlbal::Manual::HighPriority 4 Perlbal's high/low priority queueing system and how to use it. Perlbal::Manual::Hooks 4 Existing hooks and how they work. Perlbal::Manual::Install 4 Installation procedures for Perlbal. Perlbal::Manual::Internals 4 Perlbal's architecture at a glance. Useful for developers. Perlbal::Manual::LoadBalancer 4 Setting up a Perlbal Load Balancing service. Perlbal::Manual::Logging 4 How Perlbal's Logging system works. Perlbal::Manual::Management 4 Setting up a "management" service, connecting to that service and managing Perlbal on-the-fly. Perlbal::Manual::Plugins 4 Known plugins and how to create new ones. Perlbal::Manual::ReverseProxy 4 Setting up a Perlbal "reverse_proxy" service. Perlbal::Manual::Roles 4 Brief description of existing roles. Perlbal::Manual::Selector 4 Setting up a Perlbal "selector" service. Perlbal::Manual::WebServer 4 Setting up a Perlbal "web_server" service.
Perlbal::Manual::Configuration(3)
How to configure Perlbal VERSION Perlbal 1.78. DESCRIPTION By default, Perlbal looks for a configuration file at /usr/local/etc/perlbal/perlbal.conf. You can also point perlbal at a different configuration file with the -c flag. CW $ perlbal -c /home/user/perlbal.conf R -c has the alias --conf. Setting up Perlbal as a daemon You can run "perlbal" as a daemon: CW $ perlbal --daemon -c /home/user/perlbal.conf R --daemon has the alias -d. A common practice is to create a "perlbal.sh" file that supports the common operations you'll require (start, stop, restart) and place it under "/etc/init.d". You can find a sample file in "debian/perlbal.init". Configuration file A Perlbal's configuration file is a text file where you create pools and services, add servers to pools, set services' parameters and enable/disable services. Indentation is not mandatory, but it's considered a good practice for readability issues. Configuration is case insensitive, but it's also a good practice to uppercase all directives. Pools Here's a sample configuration of a pool: CW CREATE POOL mywebsite POOL mywebsite ADD 10.0.0.1:80 POOL mywebsite ADD 10.0.0.2:80 R The first line creates a pool called "mywebsite". The second and third lines add two different servers to that pool. From here on you'll be able to use this pool in a service. Also, note that right after creating the pool, you don't need to specify which pool you're adding servers to, as it is considered to be the active pool: CW CREATE POOL mywebsite POOL ADD 10.0.0.1:80 POOL ADD 10.0.0.2:80 R Configuring a pool in a separate file You can create a pool in a separate file by using the "nodefile" parameter: CW CREATE POOL dynamic SET nodefile = conf/nodelist.dat R This separate file should contain addresses in the form of "ip:port", one per line (empty lines are ignored, as well as comments started by the "#" sign). Perlbal will check the file periodically for updates. The path to the file is relative to where perlbal was started. Note that: CW SET pool nodefile = none (also undef, null, "", '') R ...unsets the nodefile, but does not remove current members. Also note: If you set a nodefile, then modify the pool via POOL ADD or POOL REMOVE, Perlbal will stop checking the nodefile for updates! Check conf/load-balancer.conf and conf/nodelist.dat for an example. Pool balance method You can set the pool balance method: CW SET pool balance_method = 'random' R At the present time, "random" is the only load balancing method available. Services Here's a sample service: CW CREATE SERVICE service_mywebsite SET role = reverse_proxy SET pool = mywebsite SET listen = 10.0.0.3:80 R The first line creates a service called "service_mywebsite". On the three following lines we are setting up three parameters for that service (you can see this same example in Perlbal::Manual::LoadBalancer in more detail). It is good practice to always start a service with the definition of its role; this way you'll avoid error messages caused by attempting to set parameters that are only acceptable for certain roles while Perlbal doesn't know which role the service is supposed to be yet. Setting parameters You can set parameters via commands of either forms: CW SET <service-name> <param> = <value> SET <param> = <value> R For a full list of parameters see Perlbal::Manual::LoadBalancer, Perlbal::Manual::ReverseProxy or Perlbal::Manual::WebServer. Note on types: 'bool' values can be set using one of 1, true, yes, on, 0, false, off, or no. 'size' values are in integer bytes, or an integer followed by 'b', 'k', or 'm' (case-insensitive) for bytes, KiB, or MiB. Setting parameter defaults Outside the scope of a service you can set parameter defaults for all following created services: CW SET <param> = <value> R This takes the same parameters as the section above ""Setting parameters" Enabling/Disabling services To enable a service: CW ENABLE service_mywebsite R To disable a service: CW DISABLE service_mywebsite R These lines is what allows you to have several services configured in a file even if they are not currently active (a common scenario is to configure everything on the file and then enable/disable services on-the-fly as required; see Perlbal::Manual::Management for more information on this process). Including configuration files While Perlbal doesn't natively let you include a configuration file within another, one of its core Plugins does. By using Perlbal::Plugin::Include you can use this feature: CW LOAD include INCLUDE = /usr/local/etc/perlbal/my.conf INCLUDE = /usr/local/etc/perlbal/other.conf /usr/local/etc/perlbal/*.conf R See Perlbal::Plugin::Include for further examples and more information. Expansions The following things expand/interpolate in config files/commands: "${ip:eth0}" 4 Expands to the configured IP for interface "eth0". Probably only works on Linux. Comments Comments in Perlbal's configuration files start with a "#": CW # this is a comment ENABLE myservice # this is also a comment R Environment variables DANGABUILD_DAEMONONLY Used in "Makefile.PL". If set to a true value the modules will not be built. DANGABUILD_MODULESONLY Used in "Makefile.PL". If set to a true value only the modules will be built, not the "perlbal" executable. PERLBAL_DEBUG There are four levels of debugging in Perlbal. By setting this variable to a value between 0 and 4 (included) you will activate Perbal's debug. CW PERLBAL_DEBUG = 0 # no debug PERLBAL_DEBUG = 4 # debug everything R These four levels are described in more detail in Perlbal::Manual::Debugging. PERLBAL_DEBUG_BUFFERED_UPLOADS By setting this variable to 1 you can tell Perlbal to add a "X-PERLBAL-BUFFERED-UPLOAD-REASON" header to requests that have to be buffered. This can be useful to let your backend machine know that Perlbal is buffering the request. The value of the header contains the reason why the request was buffered. PERLBAL_DEBUG_OBJ This is the variable you'll have to set to a true value in order to properly use the commands "obj" or "track". See Perlbal::Manual::Management for more information. PERLBAL_REMOVE_FIELDS Setting this variable true will give perlbal an extra speed boost on perl 5.10+ by removing run-time locking of field names on internal objects. As a tradeoff this will make code such as plugins or patch sets that incorrectly handling fields in perlbal to silently fail rather than giving warnings and errors. Use with caution until you trust your combination of perlbal version, plugins and versions and other patches you may have applied. Once you trust you perlbal instance to have no problems this option should simply make perlbal faster. PERLBAL_TEST_ALPHA This is a variable used to test Perlbal's alpha features. If you're a developer working on one of these features, first set the variable to a true value: CW PERLBAL_TEST_ALPHA = 1 R And then, on your test file, use something like: CW unless ($ENV{PERLBAL_TEST_ALPHA}) { plan skip_all => 'Alpha feature; test skipped without $ENV{PERLBAL_TEST_ALPHA}'; exit 0; } else { plan tests => 4; } R PERLBAL_TRACK_STATES This is the variable you'll have to set to a true value in order to properly use the command "state changes". See Perlbal::Manual::Management for more information. PERLBAL_XS_HEADERS By setting to a true value you can enable Perlbal::XS::HTTPHeaders, if installed. Note that if you enable Perlbal::XS::HTTPHeaders you won't have access to the fields of Perlbal::HTTPHeaders. TEST_PERLBAL_FOREGROUND This variable is used by Perlbal::Test to test Perlbal. "TEST_PERLBAL_FOREGROUND" with a true value tells Perlbal::Test that it should run a server in the foreground. See Perlbal::Test for more information. TEST_PERLBAL_USE_EXISTING This variable is used by Perlbal::Test to test Perlbal. If "TEST_PERLBAL_USE_EXISTING" is set to a true value then "Perlbal::Test::start_server" will be return a socket which is connected to an existing server's management port. See Perlbal::Test for more information. SEE ALSO Perlbal::Manual::Management.
Perlbal::Manual::Contributing(3)
How to contribute to Perlbal VERSION Perlbal 1.78. DESCRIPTION This document aims at providing useful pointers for people wanting to contribute to Perlbal. Knowing more about the project There's a description of Perlbal's internals in Perlbal::Manual::Internals. There's a list of to-do items at http://code.google.com/p/perlbal/issues/list Also, join the mailing list at http://groups.google.com/group/perlbal. How to submit patches Send your patch to the mailing list: <http://groups.google.com/group/perlbal> Preferred format is either a URL to your change, or a unified diff ("diff -u") attachment. For bonus points, include your patch inline also for ease of inline commenting during code reviews, but be sure to also attach the patch or include a URL. Be sure to follow local style conventions. Useful links Project homepage 4 CW http://www.danga.com/perlbal/ R Code repository 4 CW https://github.com/perlbal/Perlbal (git) R Mailing list 4 CW http://groups.google.com/group/perlbal R Bug Tracker and ToDo 4 CW http://code.google.com/p/perlbal/issues/list R SEE ALSO Perlbal::Manual::Credits, Perlbal::Manual::Internals,
Perlbal::Manual::Credits(3)
Author and contributor credits VERSION Perlbal 1.78. DESCRIPTION Lots of incredible people have contributed to make Perlbal the amazing tool that it is. They have provided code, reports, tests, documentation and inspiration to Perlbal. We are all very grateful for their help. Please let us know if you think someone is missing from this list. The primary git repo may also be more up to date. CONTRIBUTORS Andreas J Koenig, Andrew McClain, Andy Armstrong, Artur Bergman, Ask Bjoern Hansen, Bart van der Schans, Boris Zentner, Brad Fitzpatrick, Chuck Remes, Chris Hondl, Dan Conlon, dormando, Eamon Daly, Fred Moyer, Giao Phan, Greg Denton, Jab, Jacques Marneweck, Jay Bonci, Jeremy James, Jonathan Steinert, Jonty Wareing, Jordi Funollet, Kevin Lewandowski, Mark Smith, Nick Andrew, Pavel Skaldin, Paul Baker, Radu Greab, Richard Bronosky, Slaven Rezic. SEE ALSO Perlbal::Manual::Contributing.
Perlbal::Manual::Debugging(3)
Debugging Perlbal VERSION Perlbal 1.78. DESCRIPTION Perlbal has two ways of debugging. One of them is through a management console; the other is through debugging messages. Debugging in a console You'll need to set up a management service and use it to dump all the information you require. The comprehensive documentation on this process can be found at Perlbal::Manual::Management. Debugging messages You can control the ammount of debugging messages Perlbal dumps by setting the environment variable "PERLBAL_DEBUG" to a value between 0 and 4: CW PERLBAL_DEBUG = 0 # no debug PERLBAL_DEBUG = 4 # debug everything R Debug level 1 You can activate basic debug by setting "PERLBAL_DEBUG" to 1: CW PERLBAL_DEBUG = 1 R The following debugging messages are turned on: o 4 When a connection to a backend is closed, Perlbal::BackendHTTP prints "Backend $self is done; closing..." o 4 When a connection to a backend is killed, Perlbal::ClientProxy prints "Client ($self) closing backend ($backend)" o 4 When an HTTP request fails to be parsed, Perlbal::HTTPHeaders prints "HTTP parse failure: $reason" o 4 When the connection is promoted to SSL, Perlbal::TCPListener prints " .. socket upgraded to SSL!" Debug level 2 By setting the debug level to 2 you'll get all the messages from level 1. CW PERLBAL_DEBUG = 2 R You will also get a few others: o 4 When a connection to a backend is opened and ready to be written to, Perlbal::BackendHTTP prints "Backend $self is writeable!" o 4 When a response is about to be handled, Perlbal::BackendHTTP prints "BackendHTTP: handle_response" o 4 When a backend is ready to be read from, Perlbal::BackendHTTP prints "Backend $self is readable!" o 4 When there's an error with the connection to the backend, Perlbal::BackendHTTP prints "BACKEND event_err" o 4 Whenever we're determining if we should be sending keep-alive header information back to the client, Perlbal::ClientHTTPBase prints "ClientHTTPBase::setup_keepalive($self)" o 4 Whenever the client is ready for more of its file, Perlbal::ClientHTTPBase prints "REPROXY SSL done" o 4 Right after we've read a chunk of a file and when a reproxy request is about to be sent, Perlbal::ClientHTTPBase prints "REPROXY Sent: $sent" o 4 When we've written all data in the queue (and are about to stop waiting for write notifications), Perlbal::ClientHTTPBase prints "All writing done to $self" o 4 Whenever a client proxy is about to be closed, Perlbal::ClientProxy prints "Perlbal::ClientProxy closed", followed by a possible "again" and a possible "saying $reason" o 4 When a client has disconnected, Perlbal::ClientProxy prints "ClientProxy::client_disconnected" o 4 When a backend requests a client of a high priority request and the client is available, "Service" in Perlbal prints "Got from fast queue, in front of $backlog others" o 4 When a backend requests a client of a normal priority request and the client is available, "Service" in Perlbal prints "Backend requesting client, got PRIORITY = $cp-"{fd}.> o 4 When a backend requests a client of a low priority request and the client is available, "Service" in Perlbal prints "Backend requesting client, got low priority = $cp-"{fd}.> o 4 When header are being read, Perlbal::Socket prints "Perlbal::Socket::read_headers($self) is_res=$is_res" Debug level 3 CW PERLBAL_DEBUG = 3 R By setting the debug level to 3 you'll get all the messages from level 1 and 2 plus the following: o 4 Right before response headers are written to the client, Perlbal::BackendHTTP prints " writing response headers to client" o 4 As we're writing to the client, Perlbal::BackendHTTP prints " content_length=VALUE" and " remain=VALUE", where the values are "undef" if they are not defined o 4 If we're done writing to the client, Perlbal::BackendHTTP prints " done. detaching." o 4 Whenever we're determining if we should be sending keep-alive header information back to the client, Perlbal::ClientHTTPBase prints " service's persist_client = $persist_client" o 4 While determining if we should be sending keep-alive header information back to the client, if we were sent "content-length" or it's a head request, as we're doing a keep alive Perlbal::ClientHTTPBase prints " doing keep-alive to client" o 4 If we're not sending keep-alive header information back ot the client, Perlbal::ClientHTTPBase prints " doing connection: close" o 4 Right after we've finished sending all of the results to the user, Perlbal::ClientProxy prints "ClientProxy::backend_finished" o 4 When we've sent a response to a user fully and we need to reset state, Perlbal::ClientProxy prints "ClientProxy::http_response_sent -- resetting state" o 4 When we're writing a response to a client, Perlbal::ClientProxy prints "ClientProxy::event_write" o 4 After writing a response to a client, if it is still connected and we're triggering trigger our backend to keep reading, Perlbal::ClientProxy prints " unstalling backend" o 4 When reading a request, Perlbal::ClientProxy prints "ClientProxy::event_read" o 4 When reading a request and just before we read the headers, Perlbal::ClientProxy prints " no headers. reading." o 4 When reading a request, if we're not buffering to disk or we're no longer reading, as we disable reads, Perlbal::ClientProxy prints " disabling reads." o 4 As we're reading, Perlbal::ClientProxy prints " reading $read_size bytes (VALUE bytes remain)", where "VALUE bytes remain" can be <undef> o 4 After each read, Perlbal::ClientProxy prints " read $len bytes" o 4 After we finished reading the request, Perlbal::ClientProxy prints " done_reading = $done_reading, backend = BACKEND", where "BACKEND" can be "undef" o 4 When we send the headers to the backend and it responds before we're done reading from the client, further reads from the client are discarded; in this situation Perlbal::ClientProxy prints " already responded.". If the client continues to send data, Perlbal::ClientProxy prints " already responded [2]." and then gives up on reading o 4 After reading, and having a backend available where we can write to, just before we do, Perlbal::ClientProxy prints " got a backend. sending write to it." o 4 After reading, if there's no backend available, Perlbal::ClientProxy prints " no backend. read_ahead = $self-"{read_ahead}.> o 4 If we know we've already started spooling a file to disk and we're about to continue doing so, Perlbal::ClientProxy prints " bureason = $self-"{bureason}> o 4 If a backend wasn't available and we're about to request one, Perlbal::ClientProxy prints " finally requesting a backend" o 4 When we're trying to read headers and the client has disconnected, Perlbal::Socket prints " client disconnected" o 4 If we need to remove a trailing "\r\n" from the headers, Perlbal::Socket prints " throwing away leading \r\n" o 4 If we've read a packet with headers and by the end of it we can't find the end of them, Perlbal::Socket prints " can't find end of headers" o 4 Once we've read some headers, Perlbal::Socket prints " pre-parsed headers: [$hstr]" o 4 After reading headers, if there's additional content that we've read, we push it back; when we do so, Perlbal::Socket prints " pushing back $len bytes after header" o 4 If we got bogus headers, and right before we close the connection due to a parsing failure, Perlbal::Socket prints " bogus headers" o 4 If we got valid headers, Perlbal::Socket prints " got valid headers" o 4 If we're reading buffered data from a client, Perlbal::Socket prints "draining readbuf from $self to $dest: [$$bref]" Debug level 4 By setting the debug level to 4 you get all the messages from levels 1 to 3. Plus, "write" is redefined so that whenever "write" is called it first prints "write($self, <$clen>"$content") from ($pkg, $filename, $line)". CW PERLBAL_DEBUG = 4 R SEE ALSO Perlbal::Manual::Configuration, Perlbal::Manual::Management.
Perlbal::Manual::FailOver(3)
Fail Over mechanism in Perlbal VERSION Perlbal 1.78. DESCRIPTION How Perlbal's Fail Over mechanism works. Fail Over Whenever Perlbal fails to open a connection to a machine, it assumes that machine is not available and spreads the load between the remaining servers. It keeps trying to open connections to that server according to "error_retry_schedule". If there are no available servers, Perlbal will keep trying to open connections to the servers until "idle_timeout" is reached, upon which it will close the connection to the user. Clients interpret that closing differently: most will assume a 500 HTTP code, a few assume a 200 OK with empty content. For more information on parameters "idle_timeout" and "error_retry_schedule" see Perlbal::Manual::ReverseProxy. SEE ALSO Perlbal::Manual::LoadBalancer, Perlbal::Manual::ReverseProxy.
Perlbal::Manual::HighPriority(3)
Perlbal's high/low priority queueing system. VERSION Perlbal 1.78. DESCRIPTION This document describes Perlbal's high/low priority queueing system. Queuing system Perlbal has three queues: normal, high priority and low priority. As their names suggest, this means that usually requests get to the normal queue and are dispatched in FIFO order, with high priority requests going to a different queue that gets ahead of the normal one and a low priority queue that only gets done when the high and normal queues are empty. In a nutshell, whenever Perlbal needs to select which request to take care of next, it first looks for requests in the high priority queue; if that one is empty, it then looks into the normal queue; and, if the normal queue is empty too, it finally looks in the low priority queue. High priority with cookies Perlbal can use cookies to determine if a request should go to the high priority queue (configurable). The parameters to configure this are "high_priority_cookie" and "high_priority_cookie_contents"; the first defines the name of the field to check for on the cookie and the second one defines the content in that field that will trigger the request going to the fast queue: CW SET myservice.high_priority_cookie = name_of_the_field SET myservice.high_priority_cookie_contents = required_content_on_that_field R Here's a clearer example: CW SET myservice.high_priority_cookie = highpriority SET myservice.high_priority_cookie_contents = yes R High priority with plugins The plugin Perlbal::Plugin::Highpri supports making requests high priority by URI or Host. Also check "make_high_priority" under Perlbal::Manual::Hooks. Queue relief Sometimes if the high priority queue is really busy, the standard queue will suffer from resource starvation. The queue relief system helps prevent this. When there are "queue_relief_size" or more connections in the standard queue, newly available backends have a "queue_relief_chance" percent chance of taking a request from the standard priority queue instead of the high priority queue. CW SET web_proxy.queue_relief_size = 2000 SET web_proxy.queue_relief_chance = 30 # 0-100, in percent R SEE ALSO "make_high_priority" and "make_low_priority" in Perlbal::Manual::Hooks, Perlbal::Plugin::HighPriority.
Perlbal::Manual::Hooks(3)
How Perlbal's hooks work VERSION Perlbal 1.78. DESCRIPTION Basically, a hook is a bit of code that is run at certain stages in the requests that Perlbal handles.There are all kinds of hooks available and they all do different things. Some are only applicable to some of the roles and others are applicable only to certain classes. Each hook is described in detail below, but first a description of the basics of a hook. In general, you define a hook by calling the "register_hook" method on a Perlbal::Service object. You specify what hook you are interested in and provide a reference to a subroutine that will be called with the parameters particular to that hook. There are three types of hooks: Global hooks These are hooks that are defined on a global scale. They are set like so: CW Perlbal::register_global_hook('foo', sub { return 0; }); R That would define a global hook named foo that would return 0 when it's called. (Return codes from hooks will be explained below) Global hooks are useful to define management commands. See "manage_command" under Perlbal::Manual::Plugins for more information. Service handler hooks A handler hook is attached to a particular service. These hooks are called one at a time until one hook returns 1. At that point, no further hooks are called. For example: CW $service->register_hook('bar', sub { # do something return 1; }); R When this hook runs, it would return 1, signalling to Perlbal that it had done what it needed to do and that Perlbal shouldn't call any further hooks. You can use this type of hook to create sets of plugins that all handle different types of requests, and when one hook had handled a request it wouldn't continue telling other hooks about the request. backend_client_assigned Happens right after a backend is assigned to a client, but before we've talked to the backend and asked it to do something. If you return a true value, the process is stopped and you will manually have to send the client's request to the backend, etc. Called in Perlbal::BackendHTTP. Available in role "reverse_proxy". backend_readable_verify When the backend is about to start sending the response. Called in Perlbal::BackendHTTP. Available in all roles. backend_response_received Called as soon as response headers are read from the backend. If you return a true value, will stop all handling at that point. Called in Perlbal::BackendHTTP. Available in all roles. backend_write_verify When the backend is ready to receive the request. Called in Perlbal::BackendHTTP. Available in all roles. concat_get_poststat_file_missing Called when a missing file was requested in a request for multiple files concatenated, right before sending the 404 response. Return a true value to overtake the connection. Called in Perlbal::ClientHTTPBase. Available in role "web_server". See also "concat_get_poststat_pre_send", "static_get_poststat_file_missing" and "static_get_poststat_pre_send". concat_get_poststat_pre_send Called when the resulting file of a request for multiple files concatenated is about to be sent, right before the 200 response code is added as a header. Return a true value to overtake the connection. Called in Perlbal::ClientHTTPBase. Available in role "web_server". See also "concat_get_poststat_file_missing", "static_get_poststat_file_missing" and "static_get_poststat_pre_send". handle_put Called when handling a PUT request. Called in Perlbal::ClientHTTP. Available in role "web_server". make_high_priority Called when a request is received and right before we're about to determine if this request is high priority or not. Return a true value to make the request high priority; false to leave it alone. Note that this is only called when the request isn't already high priority due to cookie priority scheduling, which is done inside Perlbal::Service. Called in Perlbal::ClientProxy. Available in all roles. make_low_priority Called when a request is received and right before we're about to determine if this request is high priority or not. Return a true value to make the request low priority; false to leave it alone. Called in Perlbal::ClientProxy. Available in all roles. modify_response_headers Called when we've set all the headers, and are about to serve a file. You can change or add response headers at this point, or cancel the process by returning a true value. You will have to send the response to the client yourself if you do this. Called in Perlbal::ClientHTTPBase. Available in role "web_server". proxy_read_request Called on the request before we send the request to a backend. Called in Perlbal::ClientProxy. Available in all roles. put_writeout Called when there is some put data to write out. Called in Perlbal::ClientHTTP. Available in role "web_server". reproxy_fh_finished Called when a reproxy file has completed and is about to close the file handle. You can cancel the process by returning a true value (in which case you will have to close the reproxy_fh yourself). Called in Perlbal::ClientHTTPBase. Available in role "web_server". reproxy_response_received Called as soon as response headers are read from a reproxied backend. If you return a true value, will stop all handling at that point. Called in Perlbal::ClientProxy. Available in role "reverse_proxy". return_to_base Called when a request has been finished, and control of the Client* object is about to be transferred back to ownership by a service selector. Return a true value if the perlbal core action in this situation should be bypassed. Called in Perlbal::ClientHTTPBase. Available in all roles. start_file_reproxy Called when we've been told to reproxy a file. If you return a true value, Perlbal will not perform any operations on the file and will simply return. You can also change the file in the scalar ref passed as the second parameter. Called in Perlbal::ClientProxy; receives $filename_ref, a reference to the filename. Available in role "reverse_proxy". start_http_request A generic hook that works for both webserver and proxy modes, run after either the specific "start_proxy_request" or "start_web_request" hooks below. Like those, you return true from this hook to takeover the connection. Called in Perlbal::ClientProxy and Perlbal::ClientHTTP. Available in roles "reverse_proxy" and "web_server". start_proxy_request Called as soon as we've read in headers from a user but right before we've requested a backend connection. If a true value is returned, Perlbal will not request a backend. Called in Perlbal::ClientProxy. Available in role "reverse_proxy". start_send_file Called when we've opened a file and are about to start sending it to the user using sendfile. Return a true value to cancel the default sending. Called in Perlbal::ClientHTTPBase. Available in role "web_server". start_serve_request Called when we're about to serve a local file, before we've done any work. You can change the file served by modifying $uri_ref, or cancel the process by returning a true value. Called in Perlbal::ClientHTTPBase; receives $uri_ref, a reference to the URI. Available in role "web_server". start_web_request When a service has gotten headers and is about to serve it. Return a true value to cancel the default handling of web requests. Called in Perlbal::ClientHTTP. Available in role "web_server". static_get_poststat_file_missing Called when a missing static single file was requested, right before sending the 404 response. Return a true value to overtake the connection. Called in Perlbal::ClientHTTPBase. Available in role "web_server". See also "concat_get_poststat_file_missing", "concat_get_poststat_pre_send" and "static_get_poststat_pre_send". static_get_poststat_pre_send Called when a static single file is about to be sent, right before the 200 response code is added as a header. Return a true value to overtake the connection. Called in Perlbal::ClientHTTPBase. Available in role "web_server". See also "concat_get_poststat_file_missing", "concat_get_poststat_pre_send" and "static_get_poststat_file_missing". Service general hooks These hooks are defined the same way as above, but general hooks are all run. The return code is ignored. This can be useful for putting in code that records statistics about an action or something to that effect. end_proxy_request This hook is called when the Perlbal::ClientProxy object is being closed. Available in role "reverse_proxy". SEE ALSO Perlbal::Manual::Internals, Perlbal::Manual::Plugins.
Perlbal::Manual::Install(3)
Steps, dependencies and requirements to install Perlbal VERSION Perlbal 1.78. DESCRIPTION How to install Perlbal. Installing Perlbal for the impatient CW $ perl -MCPAN -e shell cpan> install Perlbal R App::cpanminus is also good at quickly installing Perlbal and all of its dependencies CW $ cpanm Perlbal IO::AIO Perlbal::XS::HTTPHeaders R ... will give you an ideal Perlbal environment. Installing Perlbal (with a little more detail) You need to have perl on the machine. If you don't have it yet, you can grab it from http://www.perl.org/. Having perl on the machine should give you access to the CPAN shell, one of several possible ways to install and upgrade Perl modules. Start your CPAN shell: CW $ perl -MCPAN -e shell R And now tell it to install Perlbal: CW cpan> install Perlbal R In the end you should see a message stating "make install -- OK" (if that's not the case, please refer to section Troubleshooting later in this document). Installing Perlbal by hand (without using the CPAN shell) Head to <http://search.cpan.org/dist/Perlbal/> and find the download link. Download the file and untar it: CW $ tar zxvf Perlbal-X.XX.tar.gz R Note that X.XX stands for the version number. Replace that with the latest version you got. Now you need to create the Makefile and run it; we're also going to run the tests before installing Perlbal: CW $ cd Perlbal-X.XX.tar.gz $ perl Makefile.PL $ make $ make test $ sudo make install R Installing the latest development version You can clone Perlbal's repository from github and install it by hand by following the next steps: CW $ git clone http://github.com/perlbal/Perlbal.git $ cd Perlbal $ perl Makefile.PL $ make $ make test $ sudo make install R Optional Dependencies and Asynchronous IO It is very highly recommended that Perlbal::XS::HTTPHeaders is installed and enabled. If you have poor performance, the first thing to do is install Perlbal::XS::HTTPHeaders. CW $ perl -MCPAN -e shell cpan> install Perlbal::XS::HTTPHeaders R Enable it in your configuration: CW XS enable headers R Perlbal checks for IO::AIO availability and uses it to perform asynchronous IO operations. If you're performing disk operations (e.g., using Perlbal as a web server), having IO::AIO will improve your response times. The only thing required in order to benefit from this feature is to install IO::AIO: CW $ perl -MCPAN -e shell cpan> install IO::AIO R If you don't have IO::AIO installed a warning message will be displayed when you start perlbal: CW WARNING: AIO mode disabled or not available. Perlbal will run slowly under load if you're doing any disk operations. (e.g. web_server mode). Install IO::AIO for better performance. R Checking that Perlbal is succesfully installed Perlbal is shipped with some sample configuration files that reside in the conf directory (of the source). You can give Perlbal a try by heading to the directory where the source is and using the following command: CW $ sudo perlbal -c conf/webserver.conf R By pointing your browser at "localhost:80" you should now see Perlbal responding (showing you the contents of "/usr/share/doc"). Note that the webserver.conf file sets up a Perlbal web server that listens on port 80. If you already have something listening on port 80 you need to either stop that service or change the port number on webserver.conf. Also note that if your machine doesn't have a "/usr/share/docs" directory you'll see an "ERROR: Directory not found for service docs" error message. Change the directory in the configuration file to something that exists. Troubleshooting Prerequisites not found If you're installing Perlbal by hand you may encounter some error messages describing how some prerequisites are not available: CW user@machine:~/Perlbal-X.XX$ perl Makefile.PL Checking if your kit is complete... Looks good Warning: prerequisite BSD::Resource 0 not found. Warning: prerequisite Danga::Socket 1.44 not found. Warning: prerequisite HTTP::Date 0 not found. Warning: prerequisite HTTP::Response 0 not found. Warning: prerequisite Sys::Syscall 0 not found. Writing Makefile for Perlbal R This is perl's way of telling you that since you're installing Perlbal by hand you'll also need to install its prerequisites by hand. Your first choice is to download each of them separately and perform the same installation procedure for each. Unfortunately, they are all likely to have additional prerequisites. Recursively. Alternately, see the following Troubleshooting item: "No connection to the internet". No connection to the internet If you don't have a connection to the internet you can still install Perlbal, but you'll have to tranfer the source somehow to the machine. Given that Perlbal has other module dependencies from CPAN (and those have their own dependencies too), here's a solution for this problem: Step 1: On a machine with connection to the internet, install CPAN::Mini: CW $ perl -MCPAN -e shell cpan> install CPAN::Mini R Run "minicpan" to create a minimal CPAN mirror (it contains only the latest version of each module): CW $ minicpan -l /home/user/minicpan/ -r http://cpan.org/ R Now grab that directory and record it to something you can read on the other machine (e.g., a DVD, a hard drive). Once you're on that machine, you can run the CPAN shell and tell it to look for distributions on the local directory where you now have your own CPAN mirror: CW $ perl -MCPAN -e shell cpan> o conf urllist push file:///home/user/path/to/minicpan cpan> install Perlbal R If you want "cpan" to record this change don't forget to commit: CW cpan> o conf commit R No compiler available If there's no compiler available on the machine you will probably see an error ending in something like: CW Failed during this command: DORMANDO/Perlbal-X.XX.tar.gz : writemakefile NO '/usr/bin/perl Makefile.PL INSTALLDIRS=site' returned status -1 R You need to install something like "gcc" (check <http://gcc.gnu.org/>). After installing "gcc", when trying to install Perlbal again you may get another error message: CW cpan> install Perlbal Running install for module 'Perlbal' Running make for D/DO/DORMANDO/Perlbal-X.XX.tar.gz Has already been unwrapped into directory /home/myself/.cpan/build/Perlbal-X.XX-GFko0J '/usr/bin/perl Makefile.PL INSTALLDIRS=site' returned status -1, won't make Running make test Make had some problems, won't test Running make install Make had some problems, won't install R This is the cpan shell assuming nothing changed in the system and skipping a few steps. You need to let it know you're willing to forget the past: CW cpan> look Perlbal $ rm -rf * $ exit R And now you can try installation again: CW cpan> install Perlbal R SEE ALSO Perlbal::Manual.
Perlbal::Manual::Internals(3)
Perlbal's architecture at a glance VERSION Perlbal 1.78. DESCRIPTION Connections come in from wherever and get to the TCPListener. It uses Service objects to determine what kind of Client* to spawn. The Client classes then handle crafting the response for the user. CW {{ INTERNET }} | v [Service]<===>[TCPListener] ___/ | \___ v v v [ClientManage] [ClientHTTP] [ClientProxy] ^ | v [BackendHTTP] R Perlbal decides what backend to send a request to randomly (only presently supported method). If that service has idle backend connections available, configured by "backend_persist" and "connect_ahead", it will reuse those connections and greatly reduce latency. See more detail in Perlbal::Manual::LoadBalancer. Perlbal also specializes in "spoonfeeding" data to slow clients. This allows backends to continue serving requests while Perlbal transfers responses back as fast as the client can read. Classes The following is a brief introduction/overview to the main Perlbal's classes: Perlbal::Socket Descends from Danga::Socket. Adds on to the base class to provide some functionality specifically useful for creating HTTP sockets. Fields headers_string 4 Headers as they're being read. req_headers 4 The final Perlbal::HTTPHeaders object inbound. res_headers 4 Response headers outbound (Perlbal::HTTPHeaders object). create_time 4 Creation time. alive_time 4 Last time noted alive. state 4 General purpose state; used by descendants. do_die 4 If on, die and do no further requests. read_buf 4 Arrayref of scalarref read from client. read_ahead 4 Bytes sitting in read_buf. read_size 4 Total bytes read from client, ever. ditch_leading_rn 4 If true, the next header parsing will ignore a leading \r\n. observed_ip_string 4 If defined, contains the observed IP string of the peer we're serving. This is intended for holding the value of the X-Forwarded-For and using it to govern ACLs. Perlbal::TCPListener Descends from Perlbal::Socket. Very lightweight and fast connection accept class. Takes incoming connections as fast as possible and passes them off, instantiating one of the various Client* classes to handle it. Fields service 4 Perlbal::Service. hostport 4 Scalar IP port of where this service is listening for new connections. sslopts 4 The SSL Options. CW use Data::Dumper; warn Dumper( $tcp_listener->{'sslopts'} ); R The above lines would print something like the following: CW $VAR1 = { 'ssl' => { 'SSL_cipher_list' => '...', 'SSL_cert_file' => '...', 'SSL_key_file' => ',,,', 'SSL_ca_path' => '...', 'SSL_verify_mode' => '...' } }; R v6 4 Boolean value stating whether the installation of Perlbal supports IPv6 (which basically boils down to Danga::Socket v1.6.1 and IO::Socket::INET6 being available). Perlbal::BackendHTTP Descends from Perlbal::Socket. This class handles connections to the backend web nodes for getting data back to the user. This class is used by other classes such as Perlbal::ClientProxy to send a request to an internal node. Fields client 4 Perlbal::ClientProxy connection, or undef. service 4 Perlbal::Service. pool 4 Perlbal::Pool; whatever pool we spawned from. ip 4 IP scalar. port 4 Port scalar. ipport 4 "$ip:$port". reportto 4 Object; must implement reporter interface. has_attention 4 Has been accepted by a webserver and we know for sure we're not just talking to the TCP stack. waiting_options 4 If true, we're waiting for an OPTIONS * response to determine when we have attention. disconnect_at 4 Time this connection will be disconnected, if it's kept-alive and backend told us; otherwise "undef" for unknown. content_length 4 Length of document being transferred. Only applies when the backend server sends a content-length header. content_length_remain 4 Bytes remaining to be read. Only applies when the backend server sends a content-length header. use_count 4 Number of requests this backend's been used for. generation 4 Int; counts what generation we were spawned in. buffered_upload_mode 4 Boolean. If on, we're doing a buffered upload transmit. scratch 4 Extra storage; plugins can use it if they want. Perlbal::HTTPHeaders Header management. Parses headers (request and response) and stores data for further user. Also manages validation of the request line so that it conforms to HTTP specifications. Fields headers 4 href; lowercase header -> comma-sep list of values. origcase 4 Href; lowercase header -> provided case. hdorder 4 Aref; order headers were received (canonical order). method 4 Scalar; request method (if GET request). uri 4 Scalar; request URI (if GET request). type 4 "res" or "req". code 4 HTTP response status code. codetext 4 Status text that for response code. ver 4 Version (string) "1.1". vernum 4 Version (number: major*1000+minor): "1.1" => 1001. responseLine 4 First line of HTTP response (if response). requestLine 4 First line of HTTP request (if request). Perlbal::ClientHTTPBase Descends from Perlbal::Socket. Provides base functionality to Perlbal::ClientHTTP and Perlbal::ClientProxy. Notably, the ability to efficiently send files to the remote user. Also handles most of the state logic for statistics and such. Is also used for services of type "selector". Perlbal::ClientHTTPBase then reads in the request headers, and asks the service to re-bless the client instance to a more specific type, for either a Perlbal::ClientProxy or Perlbal::ClientHTTP (depending on selector's mapping). Fields service 4 Perlbal::Service object. replacement_uri 4 URI to send instead of the one requested; this is used to instruct "_serve_request" to send an index file instead of trying to serve a directory and failing. scratch 4 Extra storage; plugins can use it if they want. reproxy_file 4 Filename the backend told us to start opening. reproxy_file_size 4 Size of file, once we "stat()" it. reproxy_fh 4 If needed, IO::Handle of fd. reproxy_file_offset 4 How much we've sent from the file. post_sendfile_cb 4 Subref to run after we're done sendfile'ing the current file. requests 4 Number of requests this object has performed for the user. selector_svc 4 The original service from which we came. is_ssl 4 Whether the socket was SSL attached (restricted operations). Perlbal::ClientHTTP Descends from Perlbal::ClientHTTPBase. Very simple and lightweight class. Handles sending files to the user without much overhead. Most of the functionality is contained in the parent class, and this class doesn't implement much new stuff. Fields put_in_progress 4 1 when we're currently waiting for an async job to return. put_fh 4 File handle to use for writing data. put_fh_filename 4 Filename of put_fh. put_pos 4 File offset to write next data at. content_length 4 Length of document being transferred. content_length_remain 4 Bytes remaining to be read. chunked_upload_state 4 Boolean/obj: if processing a chunked upload, Perlbal::ChunkedUploadState object, else undef. Perlbal::ClientProxy Descends from Perlbal::ClientHTTPBase. Takes an incoming connection from a user and connects to a backend node ("Perlbal::BackendHTTP") and relays the request. The backend can then either tell the proxy to reproxy and load a file from disk, or return a file directly, or just return a status message. Fields backend 4 Perlbal::BackendHTTP object (or "undef" if disconnected). backend_requested 4 True if we've requested a backend for this request. reconnect_count 4 Number of times we've tried to reconnect to backend. high_priority 4 Boolean; 1 if we are or were in the high priority queue. low_priority 4 Boolean; 1 if we are or were in the low priority queue. reproxy_uris 4 Arrayref; URIs to reproxy to, in order. reproxy_expected_size 4 Int: size of response we expect to get back for reproxy. currently_reproxying 4 Arrayref; the host info and URI we're reproxying right now. content_length_remain 4 Int: amount of data we're still waiting for. responded 4 Bool: whether we've already sent a response to the user or not. last_request_time 4 Int: time that we last received a request. primary_res_hdrs 4 If defined, we are doing a transparent reproxy-URI and the headers we get back aren't necessarily the ones we want. Instead, get most headers from the provided "res" headers object here. is_buffering 4 Bool; if we're buffering some/all of a request to memory/disk. is_writing 4 Bool; if on, we currently have an "aio_write" out. start_time 4 Hi-res time when we started getting data to upload. bufh 4 Buffered upload filehandle object. bufilename 4 String; buffered upload filename. bureason 4 String; if defined, the reason we're buffering to disk. buoutpos 4 Int; buffered output position. backend_stalled 4 Boolean: if backend has shut off its reads because we're too slow. unread_data_waiting 4 Boolean: if we shut off reads while we know data is yet to be read from client. chunked_upload_state 4 Bool/obj: if processing a chunked upload, Perlbal::ChunkedUploadState object, else undef. request_body_length 4 Integer: request's body length, either as-declared, or calculated after chunked upload is complete. last_upload_packet 4 Unixtime we last sent a UDP upload packet. For perlbal sending out UDP packets related to upload status (for xmlhttprequest upload bar). upload_session 4 Client's self-generated upload session. For perlbal sending out UDP packets related to upload status (for xmlhttprequest upload bar). retry_count 4 Number of times we've retried this request so far after getting 500 errors. Perlbal::ClientManage Descends from Perlbal::Socket. Simple interface that provides a way for users to use the management interface of Perlbal. You can connect to the management port (as defined in the config file) with a web browser or regular telnet (see Perlbal::Manual::Management for more information on this). Fields service 4 Perlbal::Service. buf 4 Read buffer. is_http 4 Boolean stating whether the request is HTTP. ctx 4 Perlbal::CommandContext. Perlbal::Service A service is a particular item that Perlbal is doing. Services can have a role which defines how they behave. Each service can also have a bunch of parameters set to further adjust its behavior. By itself, the Service class handles maintaining pools of backend connections and managing statistics about itself. Fields name 4 Name of the service. role 4 Role type ("web_server", "reverse_proxy", etc). enabled 4 Boolean; whether we're enabled or not (enabled = listening). pool 4 Perlbal::Pool that we're using to allocate nodes if we're in proxy mode. listener 4 Perlbal::TCPListener object, when enabled. reproxy_cache 4 Perlbal::Cache object, when enabled. End-user tunables listen 4 "IP:port" of where we're listening for new connections. docroot 4 Document root for "web_server" role. dirindexing 4 Boolean; directory indexing (for "web_server" role). Not async. index_files 4 Arrayref of filenames to try for index files. enable_concatenate_get 4 Boolean; if user can request concatenated files. enable_put 4 Boolean; whether PUT is supported. max_put_size 4 Max size in bytes of a put file. max_chunked_request_size 4 Max size in bytes of a chunked request (to be written to disk first). min_put_directory 4 Number of directories required to exist at beginning of URIs in put. enable_delete 4 Boolean; whether DELETE is supported. high_priority_cookie 4 Cookie name to check if the client's requests should be considered high priority. See also "high_priority_cookie_contents". high_priority_cookie_contents 4 Aforementioned cookie value must contain this substring. backend_persist_cache 4 Max number of persistent backends to hold onto while no clients. persist_client 4 Boolean; persistent connections for clients. persist_backend 4 Boolean; persistent connections for backends. verify_backend 4 Boolean; get attention of backend before giving it clients (using OPTIONS). verify_backend_path 4 Path to check with the OPTIONS request (default is "*"). max_backend_uses 4 Max requests to send per kept-alive backend (default 0 = unlimited). connect_ahead 4 Number of spare backends to connect to in advance all the time. buffer_size 4 How much data a Perlbal::ClientProxy object should buffer from a backend. buffer_size_reproxy_url 4 Same as above but for backends that are reproxying for us. queue_relief_size 4 Number of outstanding standard priority connections to activate pressure relief at. queue_relief_chance 4 Int, 0-100; % chance to take a standard priority request when we're in pressure relief mode. trusted_upstream_proxies 4 Array of Net::Netmask objects containing netmasks for trusted upstreams. always_trusted 4 Boolean; if true, always trust upstreams. blind_proxy 4 Boolean; if true, do not modify "X-Forwarded-For", "X-Host", or "X-Forwarded-Host" headers. enable_reproxy 4 Boolean; if true, advertise that server will reproxy files and/or URLs. reproxy_cache_maxsize 4 Maximum number of reproxy results to be cached. (0 is disabled and default). client_sndbuf_size 4 Bytes for "SO_SNDBUF". server_process 4 Path to server process (executable). persist_client_idle_timeout 4 Keep-alive timeout in seconds for clients (default is 30). idle_timeout 4 Idle timeout outside of keep-alive time (default is 30). Internal state waiting_clients 4 Arrayref of clients waiting for backendhttp connections. waiting_clients_highpri 4 Arrayref of high-priority clients waiting for backendhttp connections. waiting_clients_lowpri 4 Arrayref of low-priority clients waiting for backendhttp connections. waiting_client_count 4 Number of clients waiting for backends. waiting_client_map 4 Map of clientproxy fd -> 1 (if they're waiting for a connection). pending_connects 4 Hashref of "ip:port" -> $time (only one pending connect to backend at a time). pending_connect_count 4 Number of outstanding backend connects. bored_backends 4 Arrayref of backends we've already connected to, but haven't got clients. hooks 4 Hashref: hookname => [ [ plugin, ref ], [ plugin, ref ], ... ]. plugins 4 Hashref: name => 1. plugin_order 4 Arrayref: name, name, name... plugin_setters 4 Hashref: { plugin_name => { key_name => coderef } }. extra_config 4 Hashref with extra config options; name => values. spawn_lock 4 Boolean; if true, we're currently in "spawn_backends". extra_headers 4 { insert => [ [ header, value ], ... ], remove => [ header, header, ... ], set => [ [ header, value ], ... ] }. Used in header management interface. generation 4 Int; generation count so we can slough off backends from old pools. backend_no_spawn 4 { "ip:port" => 1 }. If on, "spawn_backends" will ignore this "ip:port" combo. buffer_backend_connect 4 0 if off; otherwise, number of bytes to buffer before we ask for a backend. selector 4 CODE ref, or undef, for role "selector" services. default_service 4 Name of a service a selector should default to. buffer_uploads 4 Boolean; enable/disable the buffered uploads to disk system. buffer_uploads_path 4 Path to store buffered upload files. buffer_upload_threshold_time 4 Int; buffer uploads estimated to take longer than this. buffer_upload_threshold_size 4 Int; buffer uploads greater than this size (in bytes). buffer_upload_threshold_rate 4 Int; buffer uploads uploading at less than this rate (in bytes/sec). upload_status_listeners 4 Comma separated list of "ip:port" of UDP upload status receivers. upload_status_listeners_sockaddr 4 Arrayref of sockaddrs (packed ip/port). enable_ssl 4 Boolean; whether this service speaks SSL to the client. ssl_key_file 4 File path to key pem file. ssl_cert_file 4 File to path to cert pem file. ssl_cipher_list 4 OpenSSL cipher list string. ssl_ca_path 4 Path to certificates directory. ssl_verify_mode 4 Int; verification mode, see IO::Socket::SSL. enable_error_retries 4 Boolean; whether we should retry requests after errors. error_retry_schedule 4 Comma-separated seconds (full or partial) to delay between retries. latency 4 Milliseconds of latency to add to request. server_tokens 4 Boolean; whether to provide a "Server" header. _stat_requests 4 Total requests to this service. _stat_cache_hits 4 Total requests to this service that were served via the reproxy-url cache.
Perlbal::Manual::LoadBalancer(3)
Using Perlbal as a Load Balancer VERSION Perlbal 1.78. DESCRIPTION How to configure a Perlbal Load Balancing service. READ ME FIRST Please read Perlbal::Manual::Configuration first for a better explanation on how to configure Perlbal. This document will make much more sense after reading that. Using Perlbal as a Load Balancer For a better understanding of how to set up Perbal as a Load Balancer, it should be noted that a Load Balancer and a Reverse Proxy can often be the same thing; not always, but often. A Load Balancer is a server (or device) that balances requests across a number of servers to spread the load. A Reverse Proxy can still do this but also have a number of other features. Perlbal as a Reverse Proxy provides features such as buffering content, preserving connections to the backend servers, starting connections ahead of time and a high priority queue, among others. You could almost say that a Load Balancer is a subset of a Reverse Proxy (it's not, but you could). When it comes to Perlbal, the Load Balancer is implemented as a Reverse Proxy without all the extra options, and that's why you set the role of a Load Balancer to "reverse_proxy": CW SET role = reverse_proxy R Simple load balancing Let's assume you want to configure two machines to serve your website and you want to let Perlbal decide how to balance the requests. For the sake of this exercise let's assume you have two servers at: CW 10.0.0.1:80 10.0.0.2:80 R And now you want to use these two machines to serve your website at: CW 10.0.0.3:80 R Here's a sample configuration to make this happen: CW CREATE POOL mywebsite POOL mywebsite ADD 10.0.0.1:80 POOL mywebsite ADD 10.0.0.2:80 CREATE SERVICE service_mywebsite SET role = reverse_proxy SET pool = mywebsite SET listen = 10.0.0.3:80 ENABLE service_mywebsite R The first line defines a pool of machines called "mywebsite". The second and third lines add your two machines to that pool (note that the indentation is not mandatory). After that you define a service called "service_mywebsite" with the role "reverse_proxy" set to listen on "10.0.0.3:80" and using the pool "mywebsite" to serve the requests. The last line is what allows you have several services configured in a file even if they are not currently active (a common scenario is to configure everything on the file and then enable/disable services on-the-fly as required; see Perlbal::Manual::Management for more information on this process). The Load Balancing algorithm Perlbal uses a highly efficient load balancing algorithm. It is very effective for distributing dynamic web requests among potentially heterogeneous hardware. First, backend servers must have their MaxClients (for apache, or equivalent) setting tuned to a reasonable limit. If your hardware can run 20 requests in parallel before running out of CPU, set MaxClients to 20. Next, by default Perlbal will distribute requests randomly. Opening a new connection to any available backend, and issuing the request. The proper algorithm is able to be used if "verify_backend", "backend_persist", "backend_persist_cache", and "connect_ahead" are enabled. CW SET persist_backend = on SET verify_backend = on SET backend_persist_cache = 5 SET connect_ahead = 2 R In this configuration, Perlbal will only route client requests to backends that it knows are real processes, instead of the OS listen queue. It will attempt to reuse pre-verified backends, and will attempt to create slightly more idle connections than it needs in preparation of future requests. When you put all this together, it becomes less likely that a client will wait for Perlbal to find an available backend. By setting your MaxClients properly, backends are able to serve traffic without getting overwhelmed. If no backends are available, Perlbal will queue them internally, rather than overload backends. You would want to disable "verify_backend" if you are balancing across image servers, or other extremely lightweight requests. SEE ALSO Perlbal::Manual::Configuration, Perlbal::Manual::FailOver, Perlbal::Manual::Management, Perlbal::Manual::ReverseProxy.
Perlbal::Manual::Logging(3)
How Perlbal's logging system works VERSION Perlbal 1.78. DESCRIPTION Perlbal supports logging of a few messages (and you can log your messages in your plugins, for instance). This document describes how to achieve that. IMPORTANT: foreground vs. background If Perlbal is running on the foreground, it logs by calling "printf", which means you should get the logs on "STDOUT". If Perlbal is running on the background, it logs through Sys::Syslog. If Sys::Syslog is not available, there will be no logging, and THAT'S THE MOST IMPORTANT THING TO KNOW ABOUT PERLBAL'S LOGGING SYSTEM. How to log a message You can log a message by calling "Perlbal::log" as you'd call Sys::Syslog's "syslog": CW Perlbal::log( $priority, $format, @args ); R You should read the documentation for Sys::Syslog for more information, but here's an example: CW Perlbal::log( 'info', 'beginning run' ); R And here's another example: CW Perlbal::log( 'crit', "this thing crashed: $!" ); R What is logged? o 4 When we try to read from or write to a filehandle that is undefined, Perlbal::AIO logs a critical message: CW Perlbal::log("crit", "Undef \$fh: $stack_trace"); R o 4 When failing to create a socket, Perlbal::BackendHTTP logs a critical message: CW Perlbal::log('crit', "Error creating socket: $!"); R o 4 When "inet_aton" fails to create a socket, Perlbal::BackendHTTP logs a critical message: CW Perlbal::log('crit', "inet_aton failed creating socket for $ip"); R o 4 When writing to a client, if we try to read more than we should from the backend, Perlbal::ClientHTTPBase logs a warning message: CW Perlbal::log('warning', "tried to readahead negative bytes. filesize=$self->{reproxy_file_size}, offset=$self->{reproxy_file_offset}"); R o 4 When opening a file being PUT for writing to disk, if there's an error (which is going to originate a 500 server error), Perlbal::ClientHTTPBase logs a warning message: CW Perlbal::log('warning', "system error: $msg ($info)"); R o 4 If we receive a request with a content lenght different from the actual length of the request, Perlbal::ClientProxy logs a critical message: CW Perlbal::log('crit', "Content length of $clen declared but $self->{buoutpos} bytes written to disk"); R o 4 When trying to buffer data to disk, if the operation fails Perlbal::ClientProxy logs a critical message: CW Perlbal::log('crit', "Failure to open $fn for buffered upload output"); R o 4 After buffering data to disk, if the file is empty, Perlbal::ClientProxy logs a critical message: CW Perlbal::log('crit', "Error writing buffered upload: $!. Tried to do $len bytes at $self->{buoutpos}."); R o 4 When purging a buffered upload on the disk, if an error occurs, Perlbal::ClientProxy logs a critical message: CW Perlbal::log('warning', "Unable to link $self->{bufilename}: $!"); R o 4 When marking a backend as pending, if there's already another one in that ip/port, Perlbal::Service will log a couple of warning messages: CW Perlbal::log('warning', "Warning: attempting to spawn backend connection that already existed."); Perlbal::log('warning', " -- [$filename:$line] $package::$subroutine"); R o 4 When deciding whether we should spawn one or more backend connections, if the total of pending conections is negative, Perlbal::Service will log a critical message: CW Perlbal::log('crit', "Bogus: service $self->{name} has pending connect count of $self->{pending_connect_count}?! Resetting."); R o 4 When spawning a backend connection, if there is no IP address for the backend, Perlbal::Service will log a critical message: CW Perlbal::log('crit', "No backend IP for service $self->{name}"); R o 4 When starting, Perlbal will log an info message: CW Perlbal::log('info', 'beginning run'); R o 4 When shutting down, Perlbal will log an info message: CW Perlbal::log('info', 'ending run'); R o 4 After each loop, is some error occurred, Perlbal will log a critical message: CW Perlbal::log('crit', "crash log: $_") foreach split(/\r?\n/, $@); R o 4 When attempting to create the pidfile, if unsuccessful, Perlbal will log an info message: CW Perlbal::log('info', "couldn't create pidfile '$file': $!" ); R o 4 When attempting to write to the pidfile, if unsuccessful, Perlbal will log an info message: CW Perlbal::log('info', "couldn't write into pidfile '$file': $!" ); R Generating more logs by sending a USR1 signal to perlbal If you send a USR1 signal to perlbal, that tells it to log some basic statistics to the syslog. It's similar to connecting to a management service and issue a "show service" for each service, plus a "states" and a "queues" commands. Where is it logged to? The way Perlbal opens Sys::Syslog, it logs to /var/log/daemon.log by default. SEE ALSO You can tweek Sys::Syslog's configuration under /etc/syslog.conf. See Sys::Syslog for more details.
Perlbal::Manual::Management(3)
Managing Perlbal on-the-fly VERSION Perlbal 1.78. DESCRIPTION How to configure a Perlbal "management" service for on-the-fly configuration and debugging. READ ME FIRST Please read Perlbal::Manual::Configuration first for a better explanation on how to configure Perlbal. This document will make much more sense after reading that. Setting up a management service You can create a management service in the following way: CW CREATE SERVICE mgmt SET role = management SET listen = 127.0.0.1:16000 ENABLE mgmt R Consulting information with a browser If you access the management service (in this case, 127.0.0.1 on port 16000) with a browser you'll reach a page with information on the services that are enabled. You're also able to click those services and reach further information on each of them. Managing Perlbal via telnet If you telnet to the management service you get a connection that allows you manage your Perlbal's instance. CW $ telnet 127.0.0.1 16000 Trying 127.0.0.1... Connected to 127.0.0.1. Escape character is '^]'. R You now have access to several commands (which are case insensitive): Admin Commands create pool <name> 4 0 create service <name> 4 Creates a pool or a service. CW create pool my_new_pool create service my_new_service R disable <service> 4 Disables a service (stops listening). CW disable my_service R Note that you can not disable "management" services. enable <service> 4 Enables a service (starts listening). CW enable my_service R header <service> insert <header>:<value> 4 0 header <service> remove <header> 4 Inserts or removes headers from the request before they're passed on to the backend. When adding headers you must state the value: CW header my_service insert x-myamazingheader:myamazingvalue R When removing headers you don't need the state any value, the header will be removed regardless of the value it holds: CW header my_service remove Connection R Note: the usage of "x-" in the beginning of your header is not required, but the convention is that non-standard headers be prefixed with "x-". load <plugin> 4 Loads a Perlbal plugin. CW load AccessControl R plugins 4 Lists plugins pool <name> add <ip[:port]> 4 0 pool <name> remove <ip[:port]> 4 Allows you to add or remove nodes from a service. CW pool add my_service 127.0.0.1:1337 pool remove my_service 127.0.0.1:1337 R Note that adding a node that already exists or removing a non-existing node do not result in an error message. Also note that the port number defaults to :80 if omitted. reproxy_state 4 Dumps the state of reproxy status. CW reproxy_state SERVER max_reproxy_connections = 0 R server <param> = <value> 4 Sets a server parameter, where param is one of: 4 o 8 max_reproxy_connections = <value> Maximum number of concurrent connections to the backends. o 8 max_reproxy_connections("ip") = <value> Maximum number of concurrent connections to one specific backend. o 8 max_connections = <value> Sets the value of "RLIMIT_NOFILE" (maximum number of open files for this process). Requires BSD::Resource. Also, Perlbal must be run under a superuser. o 8 nice_level = <value> Sets the "nice" level for the process. o 8 aio_mode = <value> One of "none", "linux" for Linux::AIO, or "ioaio" for IO::AIO. This controls how disk IO is done asynchronously. Highly recommended to use Linux::AIO or IO::AIO for webserving or reproxying files. For purely reverse proxy or only reproxying URLs, none is fine. o 8 aio_threads = <value> Number of child threads doing disk IO. Use between 2 and 50. o 8 track_obj = <value> Developer option to track objects. o 8 pidfile = <value> Filename to write pidfile to (no pidfile if not specified). o 8 crash_backtrace = <value> 1 or 0 indicating whether to perform a backtrace while the server is crashing. 4 set [<pool_name>] <param> = <value> 4 Sets a property on a pool. If the pool was just created, specifying the pool name is optional. Setting the file to autoload nodes from (Perlbal will periodically check the file for updates): CW SET my_pool nodefile = /path/to/file R Unsetting the file to autoload nodes from (note that this does not remove current members): CW SET my_pool nodefile = none R "undef", "null", "" and '' are interpreted just like "none". Note that manually modifying the pool (via POOL ADD or POOL REMOVE) will disable the periodic checking of the nodefile. Setting the load balancing method: CW SET pool balance_method = 'random' R Yes, we do realize that "random" is the only method currently available, but hey. set [<service_name>] <param> = <value> 4 Sets a property on a service. If the service was just created, specifying the service name is optional. See Perlbal::Manual::LoadBalancer, Perlbal::Manual::ReverseProxy and Perlbal::Manual::WebServer for the list of available parameters. show service [<service_name>] 4 0 show pool [<pool_name>] 4 List all services: CW show service R Show details of a service: CW show service my_service R Lists all pools, nodes and services using them: CW show pool R Show the members of a pool: CW show pool my_pool R shutdown [graceful] 4 Shuts down the server (you'll also lose your telnet session). Can be used instantly, killing all active connections: CW shutdown R Using the parameter "graceful" listening sockets are closed and perlbal stays alive until clients bleed off. CW shutdown graceful R unload <plugin> 4 Unloads a plugin. CW unload AccessControl R use <service> 4 0 use <pool> 4 Sets the implied service or pool for future operations. For instance, after: CW use my_pool R You can just type: CW pool add 127.0.0.1:6000 R Note that creating a service or pool also sets it as the implied service. xs 4 0 xs [enable <module>] 4 xs [disable <module>] 4 Show status of XS modules loaded: CW xs R Turn on an already-loaded XS module: CW xs enable module_name R Turn off an already-loaded XS module: CW xs disable module_name R Diagnostic Commands aio 4 Shows Perlbal::AIO stats. backends 4 Lists the open connections to the backends. CW backends 127.0.0.1:3080 1 127.0.0.1:3081 2 R In the above example, there are 3 open connections (they may be being used or they may simply be open according to the value of "connect_ahead"). dumpconfig 4 Shows the current configuration for each service. If a service uses a plugin that supports "dumpconfig", that plugin's configuration is also dumped (see "dumpconfig" under Perlbal::Manual::Plugins for more information). fd 4 Shows the maximum number of file descriptors and how many are currently in use. CW fd max 1024 cur 8 R gladiator 4 Requires Devel::Gladiator. Iterate's Perl's internal memory structures and can be used to enumerate all the currently live SVs. This can be used to hunt leaks and to profile memory usage. help 4 Displays the list of available commands. leaks 4 0 leaks <code> 4 Iterates over active objects. If an argument is specified, it is treated as code with $_ being the reference to the object. Shows objects that might have been leaked. mime 4 Lists known mime types. CW mime css text/css doc application/msword ... R node <ip[:port]> 4 Dumps information on a specific node. CW node 127.0.0.1:8181 127.0.0.1:8181 attempts 10 127.0.0.1:8181 lastattempt 1290461126 R Calling "node" with a parameter is the same as calling "nodes". nodes 4 Dumps information on all nodes. CW nodes 127.0.0.1:8181 attempts 10 127.0.0.1:8181 lastattempt 1290461126 127.0.0.1:8081 connects 19 127.0.0.1:8081 lastconnect 1290461127 127.0.0.1:8081 attempts 19 127.0.0.1:8081 responsecodes 200 11 127.0.0.1:8081 lastattempt 1290461127 R noverify 4 Shows the amount of time left for each node marked as noverify. If the "verify_backend" parameter is set to a true value, perlbal tries to send an "OPTIONS" command to a node before sending it the actual client request. If the node doesn't support the "OPTIONS" command, the node is added to an internal hash so that an "OPTIONS" command is not issued for new requests during the next 60 seconds. CW noverify 127.0.0.1:8081 42 R In the above example, node 127.0.0.1:8081 is on that list and still has 42 seconds until an "OPTIONS" command is tried again. If the time is a negative value it means that the "OPTIONS" command will be issued before the next request. obj 4 Shows objects count in scope. The environment variable "DEBUG_OBJ" must be set to a true value (see "Environment Variables" under Perlbal::Manual::Configuration for more information). pending 4 Shows pending backend connections by service, node, and age. proc 4 Shows CPU usage, current time, pid, and total requests processed. prof on 4 0 prof off 4 prof data 4 Enables/disables profiling or dumps profile data. queues 4 Shows status of all queues (normal, high priority and low priority) for all enabled services. CW queues service_mywebsite-normal.age 1 service_mywebsite-normal.count 8 service_mywebsite-highpri.age 0 service_mywebsite-highpri.count 0 service_mywebsite-lowpri.age 0 service_mywebsite-lowpri.count 0 R reload <plugin_name> 4 Reloads a plugin that supports reloading. socks [all] 4 0 socks summary 4 Lists all sockets or shows a summary of the sockets (by default lists all sockets). CW socks fd age 3 748s Perlbal::ClientManage(R): open to 85.245.86.253:52248 4 1003s Perlbal::TCPListener(R): open: listening on 82.102.30.112:80 for service 'ws' 6 1003s Perlbal::TCPListener(R): open: listening on 0.0.0.0:60000 for service 'mgmt' socks summary 1 Perlbal::ClientManage 2 Perlbal::TCPListener Aggregate write buffer: 0.0k Open files: 0 R state changes 4 Lists recent state changes of requests. For instance, while a request is being processed this command may issue something like: CW state changes Perlbal::ClientProxy=HASH(0x12d7ec28): reading_headers, wait_backend, backend_req_sent, wait_res Perlbal::BackendHTTP=HASH(0x12d75f30): connecting, bored, sending_req, wait_res wait_res 2 R And as soon as the request is processed: CW state changes Perlbal::BackendHTTP=HASH(0x12d75f30): connecting, bored, sending_req, wait_res, xfer_res, closed closed 1 R Note: This functionality depends on the environment variable "PERLBAL_TRACK_STATES" being set to a true value. states 4 0 states <service> 4 Shows how many sockets of which type and in which state currently exist for all services. CW states Perlbal::ClientProxy draining_res 1 R If a service is specified, shows the information for that service only. CW states ws Perlbal::BackendHTTP wait_res 1 Perlbal::ClientProxy wait_res 1 R track 4 Dumps objects tracked, sorted by age. CW track 15s Perlbal::HTTPHeaders=HASH(0x1a043a50): Perlbal::HTTPHeaders::clone, Perlbal::BackendHTTP::assign_client, Perlbal::Service::register_boredom, Perlbal::BackendHTTP::event_write, Danga::Socket::EpollEventLoop, (eval), Perlbal::run 15s Perlbal::HTTPHeaders=HASH(0x19594fe0): Perlbal::HTTPHeaders::new, Perlbal::Socket::read_headers, Perlbal::Socket::read_response_headers, Perlbal::BackendHTTP::event_read_waiting_options, Perlbal::BackendHTTP::event_read, Danga::Socket::EpollEventLoop, (eval), Perlbal::run 15s Perlbal::HTTPHeaders=HASH(0x1a043d80): Perlbal::HTTPHeaders::new, Perlbal::Socket::read_headers, Perlbal::Socket::read_response_headers, Perlbal::BackendHTTP::event_read, Danga::Socket::EpollEventLoop, (eval), Perlbal::run 15s Perlbal::BackendHTTP=HASH(0x1a044608): Perlbal::BackendHTTP::new, Perlbal::Service::spawn_backends, Perlbal::Service::note_bad_backend_connect, Perlbal::BackendHTTP::event_err, Danga::Socket::EpollEventLoop, (eval), Perlbal::run 15s Perlbal::BackendHTTP=HASH(0x1a042588): Perlbal::BackendHTTP::new, Perlbal::Service::spawn_backends, Perlbal::Service::note_bad_backend_connect, Perlbal::BackendHTTP::verify_failure, Perlbal::BackendHTTP::event_read_waiting_options, Perlbal::BackendHTTP::event_read, Danga::Socket::EpollEventLoop, (eval), Perlbal::run 15s Perlbal::BackendHTTP=HASH(0x1a044488): Perlbal::BackendHTTP::new, Perlbal::Service::spawn_backends, Perlbal::Service::request_backend_connection, Perlbal::ClientProxy::request_backend, Perlbal::ClientProxy::handle_request, Perlbal::ClientProxy::event_read, Danga::Socket::EpollEventLoop, (eval), Perlbal::run R For this to work you must have the environment variable "DEBUG_OBJ" set to a true value and the server option "track_obj" on: CW server track_obj = 1 OK R uptime 4 0 version 4 Shows the time the server was started, the current uptime and Perlbal's version. varsize 4 Debug management command to track size of internal data structures. CW varsize svc-ws-bored_backends [] 2 svc-ws-pending_connects {} 2 {127.0.0.1:3080} = {127.0.0.1:3081} = Perlbal::BackendHTTP=HASH(0x1cfd2490) R verbose on 4 0 verbose off 4 Turns verbose mode on or off. CW verbose on load AccessControl OK verbose off load AccessControl verbose on OK load AccessControl OK R Yes, verbose mode only activates the printing of an OK message upon completion of some commands such as "load". Errors are displayed regardless of verbose status. CAVEAT Note that this functionality doesn't implement any sort of authentication. If you can telnet to the address you specify, you can access the information and change things on the fly. Some alternatives to authentication are commonly employed: o 4 specifying the address as being 127.0.0.1 means that no one outside the machine can telnet to the management service; o 4 setting the management address as a private IP available only through a VPN, for instance, will allow you to manage these accesses on the VPN instead. SEE ALSO Perlbal::Manual::Configuration, Perlbal::Manual::Debugging.
Perlbal::Manual::Plugins(3)
Creating and using plugins VERSION Perlbal 1.78. DESCRIPTION How to create and use Perlbal plugins. How to use a plugin Perlbal supports plugins through modules under "Perlbal::Plugin::*" that implement a set of functions described further down this document. Some of these plugins are shipped with Perlbal itself, while others can be found on CPAN (you can also create your own plugin and have it available only locally). In order to use a plugin you first have to load it; on your Perlbal's configuration file add something like: CW Load MyPlugin R This loads plugin "Perlbal::Plugin::MyPlugin". Each plugin will have its own way of being configured (some don't require any configuration at all), so you'll have to refer to their documentation (or code). Typically (but not always), a plugin will allow you to set additional parameters to a service; for instance: CW LOAD MaxContentLength CREATE SERVICE example SET max_content_length = 100000 SET plugins = MaxContentLength R "max_content_length" is a parameter of Perlbal::Plugin::MaxContentLength. If you're worried that two plugins may have the same parameter, of if you simply want to define those variables all in the same spot and thus will be doing it outside of the plugin's context, you can use the more verbose syntax: CW SET my_service.my_plugin.my_variable = my_value R Notice that some plugins need to be stated service by service; hence, this line: CW SET plugins = MaxContentLength R The "plugins" parameter (a list of strings separated by commas or spaces) defines which plugins are acceptable for a service. Troubleshooting If you try to load a plugin and receive the following error message: CW ERROR: Can't locate Perlbal/Plugin/MyPlugin.pm in @INC R That means that either the plugin isn't installed or perlbal couldn't find it. (perhaps it is installed in a different version of perl other than the one used to run perlbal?) How to create a plugin A Perlbal plugin consists in a package under the "Perlbal::Plugin" namespace that implements a number of functions: "register", "unregister", "load" and "unload". These steps and functions (plus some helper functions you can define or use) are described below. PLEASE KEEP IN MIND: Perlbal is a single-process, asynchronous web server. You must not do things in plugins which will cause it to block, or no other requests can be served at the same time. Creating a package While there are many ways of creating a package, we'd recommend that you use something to do it for you. A good option is Module::Starter. (note: if you really want to, you can just create a file with your package and use it; by using something like Module::Starter you're making sure that several pitfalls are avoided, lots of basic rules are followed and that your package can easily be made available as a distribution that you can deploy on any machine - or, if you feel so inclined, upload to CPAN - in a simple way) Let's assume you want to create a plugin that checks requests for a "X-Magic" header and, if present, add an header "X-Color" to the response when serving a file. Let's assume your plugin will be called "Perlbal::Plugin::ColorOfMagic". Having installed Module::Starter, here's a command you can run that will create your package for you: CW $ module-starter --module=Perlbal::Plugin::ColorOfMagic --author="My name" --email=my@email.address R That should create a file tree that you can get better acquainted with by reading Module::Starter's fine documentation. For this example, the file you really need should now reside in "lib/Perlbal/Plugin/ColorOfMagic.pm". This file probably starts with something like the following: CW package Perlbal::Plugin::ColorOfMagic; use warnings; use strict; R You'll have to add a few functions to this file. These are described below. (note: upon creating this package, some boilerplate documentation will also be present on the file; you should revise it and even remove bits that don't feel right for your plugin) register "register" is called when the plugin is being added to a service. This is where you register your plugin's hooks, if required (see Perlbal::Manual::Hooks for the list of existing hooks and further documentation on how they work). For the sake of our example ("Perlbal::Plugin::ColorOfMagic", see above), what we want to do is register a hook that modifies the response headers; that means we want a "modify_response_headers" hook. Here's what you'd do: CW sub register { my ($class, $service) = @_; my $my_hook_code = sub { my Perlbal::ClientHTTPBase $cp = shift; if ( $cp->{req_headers}->header('X-Magic') ) { $cp->{res_headers}->header( 'X-Color', 'Octarine' ); } return 0; }; $service->register_hook('ColorOfMagic','modify_response_headers', $my_hook_code); } R Inside "register", we're calling "register_hook" to register our "ColorOfMagic" "modify_response_headers" hook. Its code, that will run "when we've set all the headers, and are about to serve a file" (see Perlbal::Manual::Hooks), receives a Perlbal::ClientHTTPBase object (you can see what kind of object your hook will receive on Perlbal::Manual::Hooks). We're checking to see if "X-Magic" is defined on the request and, if so, we're setting header "X-Color" on the response to "Octarine". Notice that the hook ends with "return 0". This is because returning a true value means that you want to cancel the connection to the backend and send the response to the client yourself. unregister "unregister" is called when the plugin is removed from a service. It's a standard good practice to unregister your plugin's hooks here, like so: CW sub unregister { my ($class, $service) = @_; $service->unregister_hooks('ColorOfMagic'); return 1; } R You can also use "unregister_hook" to unregister one single hook: CW $service->unregister_hook('ColorOfMagic', 'modify_response_headers'); R load "load" is called when your plugin is loaded (or reloaded). This is where you should perform your plugin's initialization, which can go from setting up some variables to registering a management command (to register commands see the documentation for "manage_command" further down this document). CW my $color; sub load { my $class = shift; $color = 'Octarine'; return 1; } R "load" must always be defined, but if you really don't need it you can have it simply returning a true value: CW sub load { return 1; } R unload "unload" is called when your plugin is unloaded. This is where you should perform any clean up tasks. "unload" must always be defined, but if you really don't need it you can have it simply returning a true value: CW sub unload { return 1; } R Don't forget to call "unregister_global_hook" if you have registered any (see the documentation for "manage_command" further down this document and you'll see what we're talking about). register vs. load "load" is called when the plugin is loaded, while "register" is called whenever the plugin is set for a service. This means that you should use "load" for anything that is global, such as registering a global hook, and you should use "register" for things that are specific to a service, such as registering service hooks. dumpconfig "dumpconfig" is not required. When managing Perlbal (see Perlbal::Manual::Management) you can send a "dumpconfig" command that will result in a configuration dump. Apart from the global configuration, each plugin that implements a "dumpconfig" function will also have that function called. "dumpconfig" should return an array of messages to be displayed. CW sub dumpconfig { my ($class, $service) = @_; my @messages; push @messages, "COLOROFMAGIC is $color"; return @messages; } R Again, "dumpconfig" is not required, so implement it only if it makes sense for your plugin. Helper functions add_tunable Adding a tunable will allow you to set its value within each plugin: CW LOAD MyPlugin CREATE SERVICE my_service SET my_new_parameter = 42 SET plugins = MyPlugin ENABLE my_service R "add_tunable" can be used by plugins that want to add tunables so that the config file can have more options for service settings. CW sub load { Perlbal::Service::add_tunable( my_new_parameter => { check_role => '*', check_type => 'int', des => "description of my new parameter", default => 0, }, ); return 1; } R "check_role" defines for which roles the value can be set ("reverse_proxy", "web_server", etc). A value of "*" mean that the value can be set for any role. The acceptable values for "check_type" are "enum", "regexp", "bool", "int", "size", "file", "file_or_none" and "directory_or_none". An Unknown check_type error message will be displayed whenever you try to set a value that has an unknown "check_type". "check_type" can also contain a code reference that will be used to validate the type. CW check_type => sub { my $self = shift; my $val = shift; my $emesg = shift; ... }, R This code reference should return a true or false value. If returning false, the contents of $emesg (which is passed as a reference to the function) will be used as the error message. Here's a better explanation of the acceptable values for "check_type": bool 4 Boolean value. Must be defined and will be checked as a Perl value. directory_or_none 4 The value needs to be defined and the content must be an existing directory (validated against perl's -d switch). enum 4 An array reference containing the acceptable values: CW check_type => [enum => ["yellow", "blue", "green"]], R file 4 A filename, validated against perl's -f switch. file_or_none 4 A filename, validated against perl's -f switch, or the default value. int 4 An integer value, validated against "/^\d+$/". regexp 4 Regular expression. The correct form of setting a regexp tunable is by setting it as an array reference containing the type ("regexp"), the regular expression and a message that can explain it: CW check_type => ["regexp", qr/^\d+\.\d+\.\d+\.\d+:\d+$/, "Expecting IP:port of form a.b.c.d:port."], R size 4 A size, validated against "/^(\d+)[bkm]$/". manage_command Perlbal catches unknown configuration commands and tries to match them against hooks in the form of "manage_command.*". Let's say that you want to set a management command "time" that will allow you to see what time it is on the server. CW sub load { Perlbal::register_global_hook('manage_command.time', sub { my $time = localtime time; return [ "It is now:", $time ]; }); return 1; } R If you want to display a text message you should return an array reference; each of the values will be printed with a trailing newline character: CW time It is now: Wed Dec 1 19:08:58 2010 R If you need to parse additional parameters on your hook, you can use "parse" and "args" on the Perlbal::ManageCommand object that your function will receive: CW my $mc = shift; $mc->parse(qr/^time\s+(today|tomorrow)$/, "usage: TIME [today|tomorrow]"); my ($cmd, $choice) = $mc->args; R This would allow you to call your command with an argument that would have to be one of "today" or "tomorrow". register_setter "register_setter" allows you to define parameters that can be set for your plugin, using a syntax such as: CW SET my_service.my_plugin.my_variable = my_value R For instance: CW SET discworld.colorofmagic.color = 'Orange' R Here's how you'd configure a new setter, by using "register_setter" inside "load": CW my $color; sub load { $color = 'Octarine'; $svc->register_setter('ColorOfMagic', 'color', sub { my ($out, $what, $val) = @_; return 0 unless $what && $val; $color = $val; $out->("OK") if $out; return 1; }); return 1; } R selector For plugins that will work with a "selector" service, sometimes you'll want to override the "selector" itself. You can do this in "register": CW sub register { my ($class, $svc) = @_; $svc->selector(\&my_selector_function); R Don't forget to unregister your function on the way out: CW sub unregister { my ($class, $svc) = @_; $svc->selector(undef); return 1; } R Your "selector" function receives a Perlbal::ClientHTTPBase object. CW my Perlbal::ClientHTTPBase $cb = shift; R Inside your "selector" function you can set which service to forward the request to like this: CW my $service = Perlbal->service($service_name); $service->adopt_base_client($cb); return 1; R See Perlbal::Plugin::Vhosts or Perlbal::Plugin::Vpaths for examples on how to do this. Known plugins The following is a list of known plugins: o 4 Perlbal::Plugin::AccessControl (Perlbal core) Basic access control based on IPs and Netmasks. o 4 Perlbal::Plugin::Addheader Add Headers to Perlbal webserver responses. o 4 Perlbal::Plugin::AutoRemoveLeadingDir (Perlbal core) Auto-removal of leading directory path components in the URL. o 4 Perlbal::Plugin::BackendHeaders See which backend served the request. o 4 Perlbal::Plugin::Cgilike (Perlbal core) Handle Perlbal requests with a Perl subroutine. o 4 Perlbal::Plugin::EchoService (Perlbal core) Simple plugin demonstrating how to create an add-on service for Perlbal using the plugin infrastructure. o 4 Perlbal::Plugin::ExpandSSL Add a custom header according to the SSL of a service. o 4 Perlbal::Plugin::FlvStreaming (Perlbal core) Enable FLV streaming with reverse proxy. o 4 Perlbal::Plugin::ForwardedFor Rename the X-Forwarded-For header in Perlbal. o 4 Perlbal::Plugin::Highpri (Perlbal core) Makes some requests high priority. o 4 Perlbal::Plugin::Include (Perlbal core) Allows multiple, nesting configuration files. o 4 Perlbal::Plugin::LazyCDN (Perlbal core) Support for Content Delivery Networks. o 4 Perlbal::Plugin::MaxContentLength (Perlbal core) Reject large requests. o 4 Perlbal::Plugin::NotModified (Perlbal core) Automatic 304 Not Modified responses when clients send a "If-Modified-Since" header. o 4 Perlbal::Plugin::PSGI PSGI web server on Perlbal. o 4 Perlbal::Plugin::Palimg (Perlbal core) Plugin that allows Perlbal to serve palette altered images. o 4 Perlbal::Plugin::Queues (Perlbal core) Simple queue length header inclusion plugin. o 4 Perlbal::Plugin::Redirect (Perlbal core) Plugin to do redirecting in Perlbal land. o 4 Perlbal::Plugin::Stats (Perlbal core) Basic Perlbal statistics gatherer. o 4 Perlbal::Plugin::StickySessions Session affinity for Perlbal. o 4 Perlbal::Plugin::Throttle (Perlbal core) Throttle connections from hosts that connect too frequently. o 4 Perlbal::Plugin::TrustHeader Remove untrusted headers. o 4 Perlbal::Plugin::UrlGroup Let URL match it in regular expression. o 4 Perlbal::Plugin::Vhosts (Perlbal core) Name-based virtual hosts. o 4 Perlbal::Plugin::Vpaths (Perlbal core) Select by path (selector role only). o 4 Perlbal::Plugin::XFFExtras (Perlbal core) Perlbal plugin that can optionally add an X-Forwarded-Port and/or X-Forwarded-Proto header to reverse proxied requests. SEE ALSO Perlbal::Manual::Hooks, Perlbal::Manual::Internals. There are sample configuration files under conf/; some of these are examples on how to use and configure existing plugins: echoservice.conf for Perlbal::Plugin::EchoService, virtual-hosts.conf for Perlbal::Plugin::VHosts, etc.
Perlbal::Manual::ReverseProxy(3)
Configuring Perlbal as a Reverse Proxy VERSION Perlbal 1.78. DESCRIPTION How to configure a Perlbal Reverse Proxy service. READ ME FIRST Please read Perlbal::Manual::Configuration first for a better explanation on how to configure Perlbal. This document will make much more sense after reading that. Configuring Perlbal as a Reverse Proxy Configuration of Perlbal as a Reverse Proxy is similar to configuration as a Load Balancer. Check Perlbal::Manual::LoadBalancer under "Using Perlbal as a Load Balancer" for a sample configuration file and for a brief explanation of the differences between a Load Balancer and a Reverse Proxy. Parameters You can set parameters via commands of either forms: CW SET <service-name> <param> = <value> SET <param> = <value> R always_trusted = bool 8 Whether to trust all incoming requests' X-Forwarded-For and related headers. Set to true only if you know that all incoming requests from your own proxy servers that clean/set those headers. Default is false. backend_persist_cache = int 8 The number of backend connections to keep alive on reserve while there are no clients. Default is 2. blind_proxy = bool 8 Flag to disable any modification of X-Forwarded-For, X-Host, and X-Forwarded-Host headers. Default is false. buffer_backend_connect = size 8 How much content-body (POST/PUT/etc) data we read from a client before we start sending it to a backend web node. If "buffer_uploads" is enabled, this value is used to determine how many bytes are read before Perlbal makes a determination on whether or not to spool the upload to disk. Default is 100k. buffer_size = size 8 How much ahead of a client we'll get while copying from a backend to a client. If a client gets behind this much, we stop reading from the backend for a bit. Once all remaining data fits in the buffer, the backend is released and may be reused. Default is 256k. buffer_size_reproxy_url = size 8 How much ahead of a client we'll get while copying from a reproxied URL to a client. If a client gets behind this much, we stop reading from the reproxied URL for a bit. The default is lower than the regular "buffer_size" (50k instead of 256k) because it's assumed that you're only reproxying to large files on event-based webservers, which are less sensitive to many open connections, whereas the 256k buffer size is good for keeping heavy process-based free of slow clients. Default if 50k. buffer_upload_threshold_rate = int 8 If an upload is coming in at a rate less than this value in bytes per second, it will be buffered to disk. A value of 0 means the rate will not be checked. Default is 0. buffer_upload_threshold_size = size 8 If an upload is larger than this size in bytes, it will be buffered to disk. A value of 0 means the size will not be checked. Default is 250k. buffer_upload_threshold_time = int 8 If an upload is estimated to take more than this number of seconds, it will be buffered to disk. A value of 0 means the time will not be estimated. Default is 5. buffer_uploads = bool 8 Used to enable or disable the buffer uploads to disk system. If enabled, "buffer_backend_connect" bytes worth of the upload will be stored in memory. At that point, the buffer upload thresholds will be checked to see if we should just send this upload to the backend or if we should spool it to the disk. Default if false. buffer_uploads_path = path/to/directory 8 Directory root for storing files used to buffer uploads. client_sndbuf_size = size 8 How large to set the client's socket SNDBUF. Default is 0. connect_ahead = int 8 How many extra backend connections we keep alive in addition to the current ones, in anticipation of new client connections. Default is 0. enable_error_retries = bool 8 Whether Perlbal should transparently retry requests to backends if a backend returns a 500 server error. Default is false. enable_reproxy = bool 8 Enable 'reproxying' (end-user-transparent internal redirects) to either local files or other URLs. When enabled, the backend servers in the pool that this service is configured for will have access to tell this Perlbal instance to serve any local readable file, or connect to any other URL that this Perlbal can connect to. Only enable this if you trust the backend web nodes. Default is false. See the section "Reproxying" in this document for more information. error_retry_schedule = string of comma-separated seconds (full or partial) 8 String of comma-separated seconds (full or partial) to delay between retries. For example "0,2" would mean do at most two retries, the first zero seconds after the first failure, and the second 2 seconds after the second failure. You probably don't need to modify the default value. Default it 0,0.25,0.50,1,1,1,1,1 enable_ssl = bool 8 Enable SSL to the client. Default is false. high_priority_cookie = cookie_name 8 The cookie name to inspect to determine if the client goes onto the high-priority queue. See Perlbal::Manual::HighPriority for more information. high_priority_cookie_contents = string 8 A string that the "high_priority_cookie" must contain to go onto the high-priority queue. See Perlbal::Manual::HighPriority for more information. idle_timeout = int 8 Timeout in seconds for idle connections to the end user. It's also the limit for how long a backend may take to respond or transfer data. Default is 30. listen = ip:port 8 The ip:port to listen on. For a service to work, you must either make it listen, or make another selector service map to a non-listening service. max_backend_uses = int 8 The maximum number of requests to be made on a single persistent backend connection before releasing the connection. A value of 0 means there is no limit and the connection will only be discarded once the backend asks it to be or when Perlbal is sufficiently idle. Default is 0. max_chunked_request_size = size 8 The maximum size that will be accepted for a chunked request (which is written to disk, buffered uploads must be on). A value of 0 means no limit. Default is 209715200 (200MB). persist_client = bool 8 Whether to enable HTTP keep-alives to the end user. Default is false. persist_backend = bool 8 Whether to enable HTTP keep-alives to the backend webnodes. Default is false, but setting it to true is highly recommended if Perlbal is the only client to your backends. If not, beware that Perlbal will hog the connections, starving other clients. persist_client_idle_timeout = int 8 Timeout in seconds for HTTP persist_client_idle_timeout keep-alives to the end user. Default is 30. persist_client_timeout = int (DEPRECATED) 8 Set both the persist_client_timeout persist_client_idle_timeout and idle_timeout. Deprecated. pool 8 Name of previously-created pool object containing the backend nodes that this reverse proxy sends requests to. queue_relief_chance = int:0-100 8 Chance (percentage) to take a standard priority request when we're in pressure relief mode. Default is 0. See Perlbal::Manual::HighPriority for more information. queue_relief_size = int 8 Number of outstanding standard priority connections to activate pressure relief at. A value of 0 disables the high priority queue system entirely. Default is 0. See Perlbal::Manual::HighPriority for more information. reproxy_cache_maxsize = int 8 Set the maximum number of cached reproxy results (X-REPROXY-CACHE-FOR) that may be kept in the service cache. These cached requests take up about 1.25KB of RAM each (on Linux x86), but will vary with usage. Perlbal still starts with 0 in the cache and will grow over time. Be careful when adjusting this and watch your RAM usage like a hawk. Default is 0, which means cache is disabled. role = reverse_proxy|web_server|management|selector 8 What type of service. One of 'reverse_proxy' for a service that load balances to a pool of backend webserver nodes, 'web_server' for a typical webserver', 'management' for a Perlbal management interface (speaks both command-line or HTTP, auto-detected), or 'selector', for a virtual service that maps onto other services. server_process 8 Executable which will be the HTTP server on stdin/stdout. (ALPHA, EXPERIMENTAL) ssl_cert_file = path/to/file 8 Path to certificate PEM file for SSL. Default is "certs/server-cert.pem". ssl_cipher_list = cipher list 8 OpenSSL-style cipher list. Default is "ALL:!LOW:!EXP". ssl_key_file = path/to/file 8 Path to private key PEM file for SSL. Default is "certs/server-key.pem". trusted_upstream_proxies = Net::Netmask filter 8 A comma separated list of Net::Netmask filters (e.g. 10.0.0.0/24, see Net::Netmask) that determines whether upstream clients are trusted or not, where trusted means their X-Forwarded-For/etc headers are not munged. upload_status_listeners = comma separated list of hosts 8 Comma separated list of hosts in form 'a.b.c.d:port' which will receive UDP upload status packets no faster than once a second per HTTP request (PUT/POST) from clients that have requested an upload status bar, which they request by appending the URL get argument ?client_up_sess=[xxxxx] where xxxxx is 5-50 'word' characters (a-z, A-Z, 0-9, underscore). verify_backend = bool 8 Whether Perlbal should send a quick OPTIONS request to the backends before sending an actual client request to them. If your backend is Apache or some other process-based webserver, this is highly recommended. All too often a loaded backend box will reply to new TCP connections, but it's the kernel's TCP stack Perlbal is talking to, not and actual Apache process yet. Using this option reduces end-user latency a ton on loaded sites. Default if false. verify_backend_path = path 8 What path the OPTIONS request sent by "verify_backend" should use. Default is "*". server_tokens = bool 8 Whether to provide a "Server" header. Perlbal by default adds a header to all replies (such as the web_server role). By setting this default to "off", you can prevent Perlbal from identifying itself. Default is "on". More on Parameters backend_persist_cache vs. connect_ahead The "backend_persist_cache" parameter refers to connections kept alive after being used, while "connect_ahead" refers to connections opened in anticipation. For instance: CW SET backend_persist_cache = 2 SET connect_ahead = 1 R Let's assume, for simplification purposes, that your service only has one server. Here's an example of what could happen: o 4 Perlbal starts No connections open until the very first request comes in (this may change in the future). o 4 one requests arrives This request starts being served on the open connection; Perlbal opens another connection because "connect_ahead"'s value tells it to always open one in anticipation. o 4 a second request arrives (the first request hasn't concluded yet) The second connection is used, a third one is created so we still have one in anticipation. o 4 the first request finishes The connection is kept open; this means we now have three open connections: two being used and one free (the first and the third one are free). o 4 the second request finishes The connection is killed, as we already have two other open connections (the first and the third), and that's the number set by "backend_persist_cache" for the number of connections to be kept alive. Reproxying Perlbal supports the concept of reproxying. Basically, this gives it the ability to ask a backend node for a file and get back a specific header that says "this file is really over there, get it there." Perlbal will then load that file or URL and send it to the user transparently, without them ever knowing that they got reproxied to another location. Add the following line to your perlbal.conf to enable reproxying on a per service basis ( reproxying is disabled by default in >= 1.38 ): CW SET enable_reproxy = true R This can be useful for having URLs that get mapped to files on disk without giving users enough information to map out your directory structure. For example, you can create a file structure such as: CW /home/pics/$userid/$pic R Then you can have URLs such as: CW http://foo.com/mysite/users/$userid/picture/$pic R When this URL gets passed to the backend web node, it could return a simple response that includes this header: CW X-REPROXY-FILE: /home/pics/$userid/$pic R Perlbal will then use asynchronous IO to send the file to the user without slowing down Perlbal at all. This support also extends to URLs that can be located anywhere Perlbal has access to. It's the same syntax, nearly: CW X-REPROXY-URL: http://foo.com:80/resource.html R You can also specify multiple URLs: CW X-REPROXY-URL: http://foo.com:80/resource.html http://baz.com:8080/res.htm R Just specify any number of space separated URLs. Perlbal will request them one by one until one returns a response code of 200. At that point Perlbal will proxy the response back to the user just like normal. Note that the user's headers are NOT passed through to the web server. To the target server, it looks simply like Perlbal is requesting the resource for itself. This behavior may change at some point. One final note: the server that returns the reproxy header can also return a "X-REPROXY-EXPECTED-SIZE" header. If present, Perlbal will consider a reproxy a failure if the file returned by the target system is of a different size than what the expected size header says. On failure, Perlbal tries the next URI in the list. If it's a file being reproxied, a 404 is returned if the file size is different. SEE ALSO Perlbal::Manual::Configuration, Perlbal::Manual::FailOver, Perlbal::Manual::LoadBalancer, Perlbal::Manual::Management.
Perlbal::Manual::Roles(3)
Roles supported by Perlbal VERSION Perlbal 1.78. DESCRIPTION Brief description of Perlbal's roles. Available Roles management Used to set a management service (a port you can telnet to and issue configuration/debugging commands to). See Perlbal::Manual::Management for more information. reverse_proxy Used for reverse proxy and load balancing. See Perlbal::Manual::LoadBalancer and Perlbal::Manual::ReverseProxy for more information. selector A virtual service that maps onto other services. See Perlbal::Manual::Selector for more information. web_server Used to set Perlbal as a web server. See Perlbal::Manual::WebServer for more information. SEE ALSO Perlbal::Manual::LoadBalancer, Perlbal::Manual::Management, Perlbal::Manual::ReverseProxy, Perlbal::Manual::Selector, Perlbal::Manual::WebServer.
Perlbal::Manual::Selector(3)
Configuring Perlbal as a virtual service that maps onto other services VERSION Perlbal 1.78. DESCRIPTION How to configure a Perlbal "selector" service. READ ME FIRST Please read Perlbal::Manual::Configuration first for a better explanation on how to configure Perlbal. This document will make much more sense after reading that. Configuring Perlbal as a Selector The "selector" role allows you to create a service that selects to which other service a request should be sent to. Here's an example of how to do that with the help of Perlbal::Plugin::VHosts: CW LOAD vhosts CREATE SERVICE selector_service SET listen = 0.0.0.0:80 SET role = selector SET plugins = vhosts VHOST *.site1.com = service1 VHOST *.site2.com = service2 ENABLE selector_service R In this case, requests to both "site1" and "site2" are received by "selector_service", which then sends requests for "site1" to "service1" and requests for "site2" to "service2". Depending on your needs, you may want to use an existing plugin (e.g., Perlbal::Plugin::Vhosts, Perlbal::Plugin::VPaths) or create your own (see "selector" under Perlbal::Manual::Plugins). SEE ALSO Perlbal::Manual::Configuration, Perlbal::Manual::Management, Perlbal::Manual::Plugins, Perlbal::Plugin::Vhosts, Perlbal::Plugin::VPaths.
Perlbal::Manual::WebServer(3)
Configuring Perlbal as a Web Server VERSION Perlbal 1.78. DESCRIPTION How to configure a Perlbal Web Server service. READ ME FIRST Please read Perlbal::Manual::Configuration first for a better explanation on how to configure Perlbal. This document will make much more sense after reading that. Configuring Perlbal as a Web Server By default, perlbal looks for a configuration file at /etc/perlbal/perlbal.conf. You can also point perlbal at a different configuration file with the -c flag. CW $ perlbal -c /home/user/perlbal.conf R Here's a very simple example where we configure a simple web server that serves an index file under /tmp CW CREATE SERVICE perlbal_test SET role = web_server SET listen = 0.0.0.0:80 SET docroot = /tmp ENABLE perlbal_test R The first line creates a service called "perlbal_test". The last line enables that service. The three parameters state - in order - that the service is a web server, that it listens on all addresses on port 80, and that its document root is "/tmp". Parameters You can set parameters via commands of either forms: CW SET <service-name> <param> = <value> SET <param> = <value> R dirindexing = bool 8 Show directory indexes when an HTTP request is for a directory. Warning: this is not an async operation, so will slow down Perlbal on heavily loaded sites. Default if false. docroot = directory/root 8 Directory root for web server. enable_concatenate_get = bool 8 Enable Perlbal's multiple-files-in-one-request mode, where a client have use a comma-separated list of files to return, always in text/plain. Useful for web apps which have dozens/hundreds of tiny css/js files, and don't trust browsers/etc to do pipelining. Decreases overall round-trip latency a bunch, but requires app to be modified to support it. See t/17-concat.t test for details. Default is false. enable_md5 = bool 8 Enable verification of the Content-MD5 header in HTTP PUT requests. Default is true. enable_delete = bool 8 Enable HTTP DELETE requests. Default is false. enable_put = bool 8 Enable HTTP PUT requests. Default is false. index_files = comma-separated list of filenames 8 Comma-separated list of filenames to load when a user visits a directory URL, listed in order of preference. Default is index.html. max_put_size = size 8 The maximum content-length that will be accepted for a PUT request, if enable_put is on. Default is 0, which means there is no limit. min_put_directory = int 8 If PUT requests are enabled, require this many levels of directories to already exist. If not, fail. Default is 0. server_tokens = bool 8 Whether to provide a "Server" header. Perlbal by default adds a header to all replies (such as the web_server role). By setting this default to "off", you can prevent Perlbal from identifying itself. Default is "on". SEE ALSO Perlbal::Manual::Configuration, Perlbal::Manual::Management.
PerlReq::Utils(3)
auxiliary routines for B::PerlReq, perl.req and perl.prov
Petal::Utils(3)
Useful template modifiers for Petal.
Pipeline::Segment::Async::Handler(3)
interface for asynchronous segment models
Pithub::Issues::Labels(3)
Github v3 Issue Labels API
Pithub::Users::Emails(3)
Github v3 User Emails API
Plack::Builder::Conditionals(3)
Plack::Builder extension
Plack::Middleware::Debug::Base(3)
Base class for Debug panels
Plack::Middleware::Status(3)
Plack Middleware for mapping urls to status code-driven responses
Plack::Test::ExternalServer(3)
Run HTTP tests on external live servers
Plagger::Plugin::Filter::HTMLScrubber(3)
Scrub feed content
Plagger::Plugin::Subscription::Bookmarks(3)
Subscribe to URLs in Favorites / Bookmarks
Plagger::Plugin::Subscription::File(3)
Store feed URLs in a file
Plucene::Analysis::LowerCaseTokenizer(3)
tokenizer which also lower cases text
Plucene::Utils(3)
Utility class for Plucene
Plugtools(3)
LDAP and Posix
Plugtools::Plugins::Dump(3)
A Plugtools plugin that calls Data::Dumper->Dumper on %opts and %args that are passed to the plugin.
Plugtools::Plugins::HomeOU(3)
Creates the home OU for a user.
Plugtools::Plugins::HomeOUremove(3)
Remove the home OU for a user.
pmapfilter(3)
User-defined labels for IPs and protocol/port pairs
Pod::ParseUtils(3)
helpers for POD parsing and conversion
pod::prima-gencls, gencls(3)
class interface compiler for Prima core modules
pod::Prima::internals, Prima::internals(3)
Prima internal architecture
Pod::Simple::Methody(3)
turn Pod::Simple events into method calls
Pod::Tree::PerlMap(3)
map names to URLs
Pod::WSDL::Utils(3)
Utilities and constants for Pod::WSDL (internal use only)
pods::SDL::Cookbook::PDL, SDL::CookBook::PDL(3)
CookBook for SDL + PDL PDL provides great number crunching capabilities to Perl and SDL provides game-developer quality real-time bitmapping and sound. You can use PDL and SDL ''together'' to create real-time, responsive animations and simulations. In this section we will go through the pleasures and pitfalls of working with both powerhouse libraries. CATEGORY Cookbook
pods::SDL::Mixer::Channels, SDL::Mixer::Channels(3)
SDL::Mixer channel functions and bindings
pods::SDL::Tutorial, SDL::Tutorial(3)
introduction to Perl SDL CATEGORY Tutorials
pods::SDL::Tutorial::Animation, SDL::Tutorial::Animation(3)
CATEGORY Tutorials
pods::SDL::Tutorial::LunarLander, SDL::Tutorial::LunarLander(3)
a small tutorial on Perl SDL CATEGORY Tutorials
POE::API::Peek(3)
Peek into the internals of a running POE environment
POE::Component::DBIAgent(3)
POE Component for running asynchronous DBI calls.
POE::Component::DirWatch::Role::AIO(3)
Make poll calls asynchronous
POE::Component::EasyDBI(3)
Perl extension for asynchronous non-blocking DBI calls in POE
POE::Component::IRC::Plugin::AutoJoin(3)
A PoCo-IRC plugin which keeps you on your favorite channels
POE::Component::IRC::Plugin::Connector(3)
A PoCo-IRC plugin that deals with the messy business of staying connected to an IRC server
POE::Component::IRC::Plugin::CycleEmpty(3)
A PoCo-IRC plugin which cycles channels if they become empty and opless.
POE::Component::JobQueue(3)
a component to manage queues and worker pools
POE::Loop::PerlSignals(3)
common signal handling routines for POE::Loop bridges
POE::Resource::Signals(3)
internal signal manager for POE::Kernel
POE::Session::Irssi(3)
emit POE events for Irssi signals
poll_joystick(3)
Polls the joystick. Allegro game programming library.
poll_keyboard(3)
Polls the keyboard. Allegro game programming library.
poll_mouse(3)
Polls the mouse. Allegro game programming library.
PPI::Token::Symbol(3)
A token class for variables and other symbols
PPIx::EditorTools(3)
Utility methods and base class for manipulating Perl via PPI
PPIx::EditorTools::FindUnmatchedBrace(3)
PPI-based unmatched-brace-finder
PPIx::EditorTools::FindVariableDeclaration(3)
inds where a variable was declared using PPI
PPIx::EditorTools::IntroduceTemporaryVariable(3)
Introduces a temporary variable using PPI
PPIx::EditorTools::Lexer(3)
Simple Lexer used for syntax highlighting
PPIx::EditorTools::Outline(3)
Collect use pragmata, modules, subroutiones, methods, attributes
PPIx::EditorTools::RenamePackage(3)
Change the package name
PPIx::EditorTools::RenamePackageFromPath(3)
Change the package name based on the files path
PPIx::EditorTools::RenameVariable(3)
Lexically replace a variable name in Perl code
PPIx::EditorTools::ReturnObject(3)
Simple object to return values from PPIx::EditorTools
Prima::Drawable::Gradient(3)
gradient fills for primitives
Prima::Gencls(3)
Prima::Gencls
Prima::Grids(3)
grid widgets SYNOPSIS CW use Prima::Grids; $grid = Prima::Grid-> create( cells => [ [qw(1.First 1.Second 1.Third)], [qw(2.First 2.Second 2.Third)], [qw(3.First 3.Second 3.Third)], ], onClick => sub { print $_[0]-> get_cell_text( $_[0]-> focusedCell), " is selected\n"; } ); R
Prima::IntUtils(3)
internal functions
Prima::Terminals(3)
Prima::Terminals
Prima::Test(3)
GUI test tools
Prima::Utils(3)
miscellanneous routines
Prima::VB::VBControls(3)
Prima::VB::VBControls
Protocol::XMPP::Element::StartTLS(3)
Protocol::XMPP::Element::StartTLS
PS_fill(3)
Fills the current path
PS_fill_stroke(3)
Fills and strokes the current path
Psh::Builtins::Fallback::Ls(3)
Psh::Builtins::Fallback::Ls
Psh::Builtins::Symbols(3)
Psh::Builtins::Symbols
Psh::Strategy::Perlscript(3)
Psh::Strategy::Perlscript
pthread_testcancel, pthread_setcancelstate, pthread_setcanceltype(3)
set cancelability state
pushtls, freeThumbprints, initThumbprints, okThumbprint, readcert, readcertchain, tlsClient, tlsServer(3)
attach TLS1 or SSL3 encryption to a communication channel
pvm_advise, pvmfadvise, pvm_advise()(3, 3PVM)
Controls use of direct task-to-task routing. [In Version 3.2: Replaced by pvm_setopt]
pvm_exit, pvmfexit(3, 3PVM)
Tells the local pvmd that this process is leaving PVM.
pvm_joingroup, pvmfjoingrp(3, 3PVM)
Enrolls the calling process in a named group.
pvm_lvgroup, pvmflvgrp(3, 3PVM)
Unenrolls the calling process from a named group.
Qpsmtpd::Postfix(3)
postfix queueing support for qpsmtpd DESCRIPTION This package implements the protocol Postfix servers use to communicate with each other. See src/global/rec_type.h in the postfix source for details. print_msg_line($line) print one line of a message to cleanup. This removes any linefeed characters from the end of the line and splits the line across several records if it is longer than 1024 chars. inject_mail($transaction) (class method) inject mail in $transaction into postfix queue via cleanup. $transaction is supposed to be a Qpsmtpd::Transaction object.
QwtDialScaleDraw(3)
QwtDialSimpleNeedle(3)
rc_check_tls(3)
rc_tls_fd(3)
RDF::Core::ModelSet(3)
RDF model set
RDF::Core::NodeFactory(3)
produces literals and resources, generates labels for anonymous resources
RDF::Trine::Model::Union(3)
Union models for joining multiple stores together
RDF::Trine::Node::Literal(3)
RDF Node class for literals
RDF::Trine::Store::LanguagePreference(3)
RDF Store proxy for filtering language tagged literals
RDFStore::Model(3)
An implementation of the Model RDF API using tied hashes and implementing free-text search on literals
Reaction::InterfaceModel::Reflector::DBIC(3)
Automatically Generate InterfaceModels from DBIx::Class models
Reaction::Manual::RenderPage(3) - Page rendering A little overview CW .---------------------------------------. | Controller Action | |---------------------------------------| | Decides which logical part to provide | '---------------------------------------' | v .------------------------------. | ViewPort | |------------------------------|----------. | A logical part of the page | | '------------------------------' | | Inner ViewPorts v Data .-------------------------------------. | | LayoutSet | | |-------------------------------------|------. | A representational part of the page | | '-------------------------------------' | | Looks v Structure .-------------------------------. | | Widget | | |-------------------------------|---------. | A functional part of the page | | '-------------------------------' | Preparation Structure .-------------------------------. | | Output | | |-------------------------------|<--------' | The rendered part of the page | '-------------------------------' R Or, how to track why your page failed to render Catalyst's "begin" and "end" actions are supplied by Reaction::UI::Controller::Root, which your "Root" controller should inherit from, or at least the root controller of the part of your application that is using Reaction. The "begin" action creates a new Reaction::UI::Window and stores it in $c->stash->{window}. The "end" action calls the flush() method on the stashed window object. "flush" in Reaction::UI::Window then calls "render_window" in Reaction::UI::View on the window's view. The View first fetches the root ViewPort from the Window's stack and creates a RenderingContext. The layout is chosen based on the ViewPort name or though the ViewPort's "layout" attribute. The Widget is then used to render the content via the RenderingContext. Is your head spinning yet? Ingredients used: * A Reaction::UI::Skin object built from: CW - The skin_name set on your View - The View object - The skin_base_dir (MyApp/share/skin)
The share/skin/defaults.conf + share/skin/<my_skin>/skin.conf R * A Reaction::UI::LayoutSet object built from: CW - The layoutset file itself, found in the share/skin/<my_skin>/layout directory or the share/skin/default/layout directory. - The Skin object R * A Reaction::UI::Widget object built from: CW - It's class, determined from the name of the ViewPort or read from the layoutset file, and found in the widget_search_path. - The View object - The LayoutSet object R * A Reaction::UI::RenderingContext::TT object built from: CW - Nothing R To render the window the correct Reaction::UI::Widget object is retrieved via the LayoutSet for the root ViewPort of the page. The LayoutSet used defaults to the "layout" attribute on the ViewPort. If there is no layout attribute value set, it takes the class name of the ViewPort, extracts the parts following "::ViewPort::" and constructs the layoutset name from converting camel cased parts of the namespace to lower-case underscored, and namespace parts into directories. CW ## eg: My::ViewPort::Action::UserForm ## becomes action/user_form R The layoutset file should exist in the skin_base_dir, in the "layout" directory under the "skin_name" dir set in your View config, or in the "default/layout" directory. [[ A LayoutSet object is created based on the layoutset name, skin object, source_file (path to file), top_skin (skin object), next_skin if exists ]]. The layoutset file is parsed as the LayoutSet object is created, if a "=widget" line is found, the "widget_type" attribute is set. The class of the Widget object can be set in the layoutset object args, or it defaults to being fetched via the Skin. The type of widget is either specified in the layoutset file via the "=widget" directive or retrieved by recreating the camelcased name from the layoutset name. The Widget is assumed to be in the widget search path provided by defaults.conf or your skin.conf. The Widget itself is passed the ViewPort to render, and the RenderingContext. The initial fragment name to render is also passed, "widget". The render stack is created using the widget order. The widget order is fetched for the fragment from the layoutset, this is either the widget class/layoutset, or retrieved from the extended layouts. As the render_stack is built, the fragment methods in the Widget are called to assign values from the ViewPort to arguments for the layout. (Or other interesting things). The stack is passed to the RenderingContext to complete.
Reflex::Signal(3)
receive callbacks when signals arrive
register_uformat(3)
Installs handler functions for a new text encoding format. Allegro game programming library.
Reply::Plugin::Autocomplete::Globals(3)
tab completion for global variables
Reply::Plugin::Autocomplete::Lexicals(3)
tab completion for lexical variables
REST::Application::Routes(3)
An implementation of Ruby on Rails type routes.
rest_callback(3)
Like rest(), but calls the callback during the wait. Allegro game programming library.
Return::MultiLevel(3)
return across multiple call levels
Rex::Helper::Rexfile::ParamLookup(3)
A command to manage task parameters. A command to manage task parameters. Additionally it register the parameters as template values. This module also looks inside a CMDB (if present) for a valid key.
RkCvtHan(3)
/ RkwCvtHan - convert double-width symbols, alphanumeric characters, hiragana, and katakana to single-width characters
rle_debug, rle_get_setup(3)
Read the header from an RLE file. 0 rle_get_setup_ok - Print error message and exit if rle_get_setup fails. rle_get_error - Print error message for rle_get_setup failure. rle_debug - Turn on or off debugging messages.
rle_debug, rle_get_setup(3)
Read the header from an RLE file. 0 rle_get_setup_ok - Print error message and exit if rle_get_setup fails. rle_get_error - Print error message for rle_get_setup failure. rle_debug - Turn on or off debugging messages.
rle_get_error, rle_get_setup(3)
Read the header from an RLE file. 0 rle_get_setup_ok - Print error message and exit if rle_get_setup fails. rle_get_error - Print error message for rle_get_setup failure. rle_debug - Turn on or off debugging messages.
rle_get_error, rle_get_setup(3)
Read the header from an RLE file. 0 rle_get_setup_ok - Print error message and exit if rle_get_setup fails. rle_get_error - Print error message for rle_get_setup failure. rle_debug - Turn on or off debugging messages.
rle_get_set, rle_get_setup(3)
Read the header from an RLE file. 0 rle_get_setup_ok - Print error message and exit if rle_get_setup fails. rle_get_error - Print error message for rle_get_setup failure. rle_debug - Turn on or off debugging messages.
rle_get_set, rle_get_setup(3)
Read the header from an RLE file. 0 rle_get_setup_ok - Print error message and exit if rle_get_setup fails. rle_get_error - Print error message for rle_get_setup failure. rle_debug - Turn on or off debugging messages.
rle_get_setup(3)
Read the header from an RLE file. 0 rle_get_setup_ok - Print error message and exit if rle_get_setup fails. rle_get_error - Print error message for rle_get_setup failure. rle_debug - Turn on or off debugging messages.
rle_get_setup(3)
Read the header from an RLE file. 0 rle_get_setup_ok - Print error message and exit if rle_get_setup fails. rle_get_error - Print error message for rle_get_setup failure. rle_debug - Turn on or off debugging messages.
rle_get_setup_ok, rle_get_setup(3)
Read the header from an RLE file. 0 rle_get_setup_ok - Print error message and exit if rle_get_setup fails. rle_get_error - Print error message for rle_get_setup failure. rle_debug - Turn on or off debugging messages.
rle_get_setup_ok, rle_get_setup(3)
Read the header from an RLE file. 0 rle_get_setup_ok - Print error message and exit if rle_get_setup fails. rle_get_error - Print error message for rle_get_setup failure. rle_debug - Turn on or off debugging messages.
rle_getrow(3)
Read a scanline of pixels from an RLE file.
rle_getrow(3)
Read a scanline of pixels from an RLE file.
Role::Basic(3)
Just roles. Nothing else.
Roman(3)
functions for converting between Roman and Arabic numerals
rpc(3)
library routines for remote procedure calls
RPC::PlServer(3)
Perl extension for writing PlRPC servers
RPC::Simple(3)
Perl classes to handle simple asynchronous RPC calls with call-back
RPC::Simple::CallHandler(3)
Perl class to handle RPC calls with call-back
rpc_clnt_calls, clnt_call, clnt_freeres, clnt_geterr, clnt_perrno, clnt_perror, clnt_sperrno, clnt_sperror, rpc_broadcast, rpc_broadcast_exp, rpc_call(3)
library routines for client side calls
rpc_gss_get_error(3)
Get error details
rpc_secure, authdes_create, authdes_getucred, getnetname, host2netname, key_decryptsession, key_encryptsession, key_gendes, key_setsecret, netname2host, netname2user, user2netname(3)
library routines for secure remote procedure calls
rpc_soc, authunix_create, authunix_create_default, callrpc, clnt_broadcast, clntraw_create, clnttcp_create, clntudp_bufcreate, clntudp_create, clntunix_create, get_myaddress, pmap_getmaps, pmap_getport, pmap_rmtcall, pmap_set, pmap_unset, registerrpc, rpc_createerr, svc_fds, svc_fdset, svc_getcaller, svc_register, svc_unregister, svcfd_create, svcraw_create, svcunix_create, svcunixfd_create, xdr_pmap, xdr_pmaplist, svctcp_create, svcudp_bufcreate, auth_destroy, authnone_create, clnt_call, clnt_control, clnt_create, clnt_destroy, clnt_freeres, clnt_geterr, clnt_pcreateerror, clnt_perrno, clnt_perror, clnt_spcreateerror, clnt_sperrno, clnt_sperror, svc_destroy, svc_getargs, svc_getreq, svc_getreqset, svc_run, svc_sendreply, svcerr_auth, svcerr_decode, svcerr_noproc, svcerr_noprog, svcerr_progvers, svcerr_systemerr, svcerr_weakauth, xdr_accepted_reply, xdr_authunix_parms, xdr_callhdr, xdr_callmsg, xdr_opaque_auth, xdr_rejected_reply, xdr_replymsg, xprt_register, xprt_unregister(3)
library routines for remote procedure calls
sc_ALevelShift, sc::ALevelShift(3)
sc_ALevelShift
sc_AVLSet, sc::AVLSet<(3)
K >
sc_AVLSet_iterator, sc::AVLSet<(3)
K >::iterator
sc_BLevelShift, sc::BLevelShift(3)
sc_BLevelShift
sc_CartesianIter, sc::CartesianIter(3)
CartesianIter gives the ordering of the Cartesian functions within a shell for the particular integrals specialization.
sc_CLHF, sc::CLHF(3)
CLHF is a Hartree-Fock specialization of CLSCF.
sc_CLSCF, sc::CLSCF(3)
The CLSCF class is a base for classes implementing a self-consistent procedure for closed-shell molecules.
sc_DenFunctional, sc::DenFunctional(3)
An abstract base class for density functionals.
sc_EriCints, sc::EriCints(3)
EriCints is a specialization of Int2eCints that computes electron repulsion integrals.
sc_FileOperationFailed, sc::FileOperationFailed(3)
This is thrown when an operation on a file fails.
sc_GaussianBasisSet, sc::GaussianBasisSet(3)
The GaussianBasisSet class is used describe a basis set composed of atomic gaussian orbitals.
sc_GRTCints, sc::GRTCints(3)
GRTCints is a specialization of Int2eCints that computes two-electron integrals specific to linear R12 methods.
sc_Int1eCCA, sc::Int1eCCA(3)
Int1eCCA adapts CCA integrals components for use within SC.
sc_Int2eCCA, sc::Int2eCCA(3)
Int2eCCA adapts CCA integrals components for use within SC.
sc_Integral, sc::Integral(3)
The Integral abstract class acts as a factory to provide objects that compute one and two electron integrals.
sc_IntegralCints, sc::IntegralCints(3)
IntegralCints computes integrals between Gaussian basis functions.
sc_IntegralStorer, sc::IntegralStorer(3)
sc_IntegralStorer
sc_IntegralV3, sc::IntegralV3(3)
IntegralV3 computes integrals between Gaussian basis functions.
sc_LevelShift, sc::LevelShift(3)
sc_LevelShift
sc_LocalSCMatrix, sc::LocalSCMatrix(3)
sc_LocalSCMatrix
sc_LocalSCMatrixKit, sc::LocalSCMatrixKit(3)
The LocalSCMatrixKit produces matrices that work in a single processor environment.
sc_LocalSCVector, sc::LocalSCVector(3)
sc_LocalSCVector
sc_LocalSymmSCMatrix, sc::LocalSymmSCMatrix(3)
sc_LocalSymmSCMatrix
sc_LSDACFunctional, sc::LSDACFunctional(3)
An abstract base class for local correlation functionals.
sc_MemAllocFailed, sc::MemAllocFailed(3)
This is thrown when a memory allocation fails.
sc_MOIndexSpace, sc::MOIndexSpace(3)
Class MOIndexSpace describes a range of molecular orbitals or similar objects that are linear combinations of basis functions (e.g.
sc_OneBodyDerivInt, sc::OneBodyDerivInt(3)
OneBodyDerivInt is an abstract base class for objects that compute one body derivative integrals.
sc_OneBodyDerivIntCCA, sc::OneBodyDerivIntCCA(3)
This implements one body derivative integrals.
sc_OneBodyDerivIntV3, sc::OneBodyDerivIntV3(3)
This implements one body derivative integrals in the IntV3 library.
sc_OneBodyInt, sc::OneBodyInt(3)
OneBodyInt is an abstract base class for objects that compute integrals between two basis functions.
sc_OneBodyIntCCA, sc::OneBodyIntCCA(3)
This implements one body integrals through the CCA interface.
sc_OneBodyIntCints, sc::OneBodyIntCints(3)
This implements most one body integrals in the Cints library.
sc_OneBodyIntV3, sc::OneBodyIntV3(3)
This implements most one body integrals in the IntV3 library.
sc_OneBodyOneCenterDerivInt, sc::OneBodyOneCenterDerivInt(3)
OneBodyOneCenterDerivInt is an abstract base class for objects that compute one body derivative integrals on a single center.
sc_OneBodyOneCenterInt, sc::OneBodyOneCenterInt(3)
OneBodyOneCenterInt is an abstract base class for objects that compute integrals between two basis functions.
sc_PW92LCFunctional, sc::PW92LCFunctional(3)
Implements the PW92 local (LSDA) correlation term.
sc_PZ81LCFunctional, sc::PZ81LCFunctional(3)
Implements the PZ81 local (LSDA) correlation functional.
sc_R12IntsAcc, sc::R12IntsAcc(3)
R12IntsAcc accumulates transformed (MO) integrals stored as (ijxy) where i, j, x, and, y lie in spaces I, J, X, and Y, respectively.
sc_ReplSCMatrix, sc::ReplSCMatrix(3)
sc_ReplSCMatrix
sc_ReplSCMatrixKit, sc::ReplSCMatrixKit(3)
The ReplSCMatrixKit produces matrices that work in a many processor environment.
sc_ReplSCMatrixListSubblockIter, sc::ReplSCMatrixListSubblockIter(3)
sc_ReplSCMatrixListSubblockIter
sc_ReplSCVector, sc::ReplSCVector(3)
sc_ReplSCVector
sc_ReplSymmSCMatrix, sc::ReplSymmSCMatrix(3)
sc_ReplSymmSCMatrix
sc_SCMatrixNullSubblockIter, sc::SCMatrixNullSubblockIter(3)
sc_SCMatrixNullSubblockIter
sc_SOTransform, sc::SOTransform(3)
SOTransform maintains a list of AO shells that are be used to compute the SO.
sc_SpatialMOPairIter, sc::SpatialMOPairIter(3)
SpatialMOPairIter gives the ordering of pairs of spatial orbitals.
sc_SpatialMOPairIter_eq, sc::SpatialMOPairIter_eq(3)
SpatialMOPairIter_eq gives the ordering of same-spin and different-spin orbital pairs if both orbitals of the pairs are from the same space.
sc_SpatialMOPairIter_neq, sc::SpatialMOPairIter_neq(3)
SpatialMOPairIter_neq gives the ordering of pairs of spatial orbitals from different spaces.
sc_StdDenFunctional, sc::StdDenFunctional(3)
The StdDenFunctional class is used to construct the standard density functionals.
sc_SyscallFailed, sc::SyscallFailed(3)
This is thrown when an system call fails with an errno.
sc_Timer, sc::Timer(3)
The Timer class uses RegionTimer to time intervals in an exception safe manner.
sc_TwoBodyDerivInt, sc::TwoBodyDerivInt(3)
This is an abstract base type for classes that compute integrals involving two electrons.
sc_TwoBodyDerivIntCCA, sc::TwoBodyDerivIntCCA(3)
This implements two body derivative integrals through the CCA interface.
sc_TwoBodyDerivIntCints, sc::TwoBodyDerivIntCints(3)
This implements electron repulsion derivative integrals in the IntV3 library.
sc_TwoBodyDerivIntV3, sc::TwoBodyDerivIntV3(3)
This implements electron repulsion derivative integrals in the IntV3 library.
sc_TwoBodyInt, sc::TwoBodyInt(3)
This is an abstract base type for classes that compute integrals involving two electrons.
sc_TwoBodyIntCCA, sc::TwoBodyIntCCA(3)
This implements two body integrals through the CCA interface.
sc_TwoBodyIntCints, sc::TwoBodyIntCints(3)
This implements electron repulsion integrals in the IntCints library.
sc_TwoBodyIntV3, sc::TwoBodyIntV3(3)
This implements electron repulsion integrals in the IntV3 library.
sc_TwoBodyMOIntsTransform, sc::TwoBodyMOIntsTransform(3)
TwoBodyMOIntsTransform computes two-body integrals in MO basis using parallel integrals-direct AO->MO transformation.
sc_TwoBodyMOIntsTransform_ijxy, sc::TwoBodyMOIntsTransform_ijxy(3)
TwoBodyMOIntsTransform_ijxy computes (ij|xy) integrals using parallel integrals-direct AO->MO transformation.
sc_TwoBodyMOIntsTransform_ikjy, sc::TwoBodyMOIntsTransform_ikjy(3)
TwoBodyMOIntsTransform_ikjy computes (ik|jy) integrals using parallel integrals-direct AO->MO transformation.
sc_TwoBodyMOIntsTransform_ixjy, sc::TwoBodyMOIntsTransform_ixjy(3)
TwoBodyMOIntsTransform_ixjy computes (ix|jy) integrals using parallel integrals-direct AO->MO transformation.
sc_TwoBodyThreeCenterDerivInt, sc::TwoBodyThreeCenterDerivInt(3)
This is an abstract base type for classes that compute three centers integrals involving two electrons.
sc_TwoBodyThreeCenterInt, sc::TwoBodyThreeCenterInt(3)
This is an abstract base type for classes that compute integrals involving two electrons in three Gaussian functions.
sc_TwoBodyThreeCenterIntV3, sc::TwoBodyThreeCenterIntV3(3)
This implements electron repulsion integrals involving three centers in the IntV3 library.
sc_TwoBodyTwoCenterDerivInt, sc::TwoBodyTwoCenterDerivInt(3)
This is an abstract base type for classes that compute two centers integrals involving two electrons.
sc_TwoBodyTwoCenterInt, sc::TwoBodyTwoCenterInt(3)
This is an abstract base type for classes that compute integrals involving two electrons in two Gaussian functions.
sc_TwoBodyTwoCenterIntV3, sc::TwoBodyTwoCenterIntV3(3)
This implements electron repulsion integrals involving two centers in the IntV3 library.
sc_VDWShape, sc::VDWShape(3)
The VDWShape class describes the surface of a molecule as the union of atom centered spheres, each the van der Waals radius of the atom.
Script::isAperlScript(3)
This does a basic check if something is a perl script or not.
SDL_JoystickNumBalls(3)
Get the number of joystick trackballs
SDL_PollEvent(3)
Polls for currently pending events.
SDL_WM_ToggleFullScreen(3)
Toggles fullscreen mode
Search::Elasticsearch::Cxn::Factory(3)
Used by CxnPools to create new Cxn instances.
Search::Xapian::AssertionError(3)
AssertionError is thrown if a logical assertion inside Xapian fails.
Security::TLSCheck(3)
Application for checking server's TLS capability
Security::TLSCheck::App(3)
CLI part of TLS check application
Security::TLSCheck::App::DomainFilter(3)
change wrong domain names into correct ones, if possible
Security::TLSCheck::App::Parallel(3)
run everything in parallel
Security::TLSCheck::Checks(3)
Base class for all checks
Security::TLSCheck::Checks::AgeDE(3)
Checks, if a host has an age-de.xml file
Security::TLSCheck::Checks::CipherStrength(3)
Check Strength of CipherSuites and SSL/TLS Version
Security::TLSCheck::Checks::CipherStrengthOnlyValidCerts(3)
Check Strength of CipherSuites and SSL/TLS Version, but only for domains with valid certficates
Security::TLSCheck::Checks::DNS(3)
Basic DNS Checks
Security::TLSCheck::Checks::Dummy(3)
Simple dummy check as example
Security::TLSCheck::Checks::FinalScore(3)
Creates a summary score out of the other tests
Security::TLSCheck::Checks::Heartbleed(3)
Heartbleed checks
Security::TLSCheck::Checks::Helper::MX(3)
Get all MX, cache if already checked, ...
Security::TLSCheck::Checks::Helper::Timing(3)
Timing helpers for run_check
Security::TLSCheck::Checks::Mail(3)
Checks mailservers for TLS capability
Security::TLSCheck::Checks::MailCipherStrength(3)
Checks mailservers for supported CipherSuites
Security::TLSCheck::Checks::Web(3)
(Basic) HTTP and HTTPS Checks
Security::TLSCheck::Result(3)
Result storage, aggregation and output
Security::TLSCheck::Result::CSV(3)
CSV output role
select_mouse_cursor(3)
Tells Allegro to select software or hardware cursor drawing.
Set::Infinite(3)
Sets of intervals
Set::Infinite::Basic(3)
Sets of intervals 6 =head1 SYNOPSIS CW use Set::Infinite::Basic; $set = Set::Infinite::Basic->new(1,2); # [1..2] print $set->union(5,6); # [1..2],[5..6] R
set_color_conversion(3)
Tells Allegro how to convert images during loading time.
set_display_switch_callback(3)
Installs a switching notification callback. Allegro game programming library.
set_display_switch_mode(3)
Tells Allegro how the program handles background switching.
sg_comp_destroy, sg_comp_init, sg_comp_get_tls, sg_global_lock, sg_global_unlock(3)
managing system statistics delivery
sg_comp_get_tls, sg_comp_init, sg_comp_destroy, sg_global_lock, sg_global_unlock(3)
managing system statistics delivery
sg_comp_init, sg_comp_destroy, sg_comp_get_tls, sg_global_lock, sg_global_unlock(3)
managing system statistics delivery
sg_get_error, sg_get_error_arg, sg_get_error_details, sg_get_error_errno, sg_str_error, sg_strperror(3)
get last error status
sg_get_error_arg, sg_get_error, sg_get_error_details, sg_get_error_errno, sg_str_error, sg_strperror(3)
get last error status
sg_get_error_details, sg_get_error, sg_get_error_arg, sg_get_error_errno, sg_str_error, sg_strperror(3)
get last error status
sg_get_error_errno, sg_get_error, sg_get_error_arg, sg_get_error_details, sg_str_error, sg_strperror(3)
get last error status
sg_global_lock, sg_comp_init, sg_comp_destroy, sg_comp_get_tls, sg_global_unlock(3)
managing system statistics delivery
sg_global_unlock, sg_comp_init, sg_comp_destroy, sg_comp_get_tls, sg_global_lock(3)
managing system statistics delivery
sg_str_error, sg_get_error, sg_get_error_arg, sg_get_error_details, sg_get_error_errno, sg_strperror(3)
get last error status
sg_strperror, sg_get_error, sg_get_error_arg, sg_get_error_details, sg_get_error_errno, sg_str_error(3)
get last error status
sgels.f(3)
sgelsd.f(3)
sgelss.f(3)
sgelsx.f(3)
sgelsy.f(3)
sgglse.f(3)
SGML::Parser::OpenSP::Tools(3)
Tools to process OpenSP output
shisa_enumerate_principals(3)
API function
shishi_hostkeys_for_localservice(3)
API function
shishi_hostkeys_for_localservicerealm(3)
API function
shishi_keys_for_localservicerealm_in_file(3)
API function
shishi_tkts_get_for_localservicepasswd(3)
API function
show_mouse(3)
Tells Allegro to display a mouse pointer on the screen.
shtk_cleanup_register(3)
Installs cleanup handlers to be called on script termination
shtk_unittest_fail(3)
Fails the test case
sigaddset, sigdelset, sigemptyset, sigfillset, sigismember, sigsetops(3)
????????????????????
sigemptyset, sigaddset, sigdelset, sigfillset, sigismember, sigsetops(3)
manipulate signal sets
siginterrupt(3)
allow signals to interrupt system calls
slals0.f(3)
slalsa.f(3)
slalsd.f(3)
slurm_kill_job, slurm_kill_job_step, slurm_signal_job, slurm_signal_job_step, slurm_terminate_job_step, slurm_terminate_job(3)
Slurm job signal calls
SNMP::Info::Layer3::CiscoFWSM(3)
SNMP Interface to Firewall Services Modules for features not covered elsewhere.
SNMP::Info::Layer3::Pf(3)
SNMP Interface to FreeBSD-Based Firewalls using Pf /Pf Sense
SNMP::Info::NortelStack(3)
SNMP Interface to the Avaya/Nortel S5-AGENT-MIB and S5-CHASSIS-MIB
SOAP::Transport::TCP(3)
TCP Transport Support for SOAP::Lite SOAP::Transport::TCP The classes provided by this module implement direct TCP/IP communications methods for both clients and servers. The connections don't use HTTP or any other higher-level protocol. These classes are selected when the client or server object being created uses an endpoint URI that starts with tcp://. Both client and server classes support using Secure Socket Layer if it is available. If any of the parameters to a new method from either of the classes begins with SSL_ (such as SSL_server in place of Server), the class attempts to load the IO::Socket::SSL package and use it to create socket objects. Both of the following classes catch methods that are intended for the socket objects and pass them along, allowing calls such as $client->accept( ) without including the socket class in the inheritance tree. SOAP::Transport::TCP::Client Inherits from: SOAP::Client. The TCP client class defines only two relevant methods beyond new and send_receive. These methods are: SSL(optional new boolean value) 4 CW if ($client->SSL) # Execute only if in SSL mode R Reflects the attribute that denotes whether the client object is using SSL sockets for communications. io_socket_class 4 CW ($client->io_socket_class)->new(%options); R Returns the name of the class to use when creating socket objects for internal use in communications. As implemented, it returns one of IO::Socket::INET or IO::Socket::SSL, depending on the return value of the previous SSL method. If an application creates a subclass that inherits from this client class, either method is a likely target for overloading. The new method behaves identically to most other classes, except that it detects the presence of SSL-targeted values in the parameter list and sets the SSL method appropriately if they are present. The send_receive method creates a socket of the appropriate class and connects to the configured endpoint. It then sets the socket to nonblocking I/O, sends the message, shuts down the client end of the connection (preventing further writing), and reads the response back from the server. The socket object is discarded after the response and appropriate status codes are set on the client object. SOAP::Transport::TCP::Server Inherits from: SOAP::Server. The server class also defines the same two additional methods as in the client class: SSL(optional new boolean value) 4 CW if ($client->SSL) # Execute only if in SSL mode R Reflects the attribute that denotes whether the client object is using SSL sockets for communications. io_socket_class 4 CW ($client->io_socket_class)->new(%options); R Returns the name of the class to use when creating socket objects for internal use in communications. As implemented, it returns one of IO::Socket::INET or IO::Socket::SSL, depending on the return value of the previous SSL method. The new method also manages the automatic selection of SSL in the same fashion as the client class does. The handle method in this server implementation isn't designed to be called once with each new request. Rather, it is called with no arguments, at which time it enters into an infinite loop of waiting for a connection, reading the request, routing the request and sending back the serialized response. This continues until the process itself is interrupted by an untrapped signal or similar means.
SOAP::Utils(3)
a utility package for SOAP::Lite
SOAP::WSDL::Manual::Cookbook(3)
SOAP::WSDL recipes Accessing HTTPS webservices You need Crypt::SSLeay installed to access HTTPS webservices. Accessing protected web services Passing a username and password, or a client certificate and key, to the transport layer is highly dependent on the transport backend. The descriptions below are for HTTP(S) transport using LWP::UserAgent Accessing HTTP(S) webservices with basic/digest authentication When using SOAP::WSDL::Transport::HTTP (SOAP::Lite not installed), add a method called "get_basic_credentials" to SOAP::WSDL::Transport::HTTP: CW *SOAP::WSDL::Transport::HTTP::get_basic_credentials = sub { return ($user, $password); }; R When using SOAP::Transport::HTTP (SOAP::Lite is installed), do the same to this backend: CW *SOAP::Transport::HTTP::Client::get_basic_credentials = sub { return ($user, $password); }; R Accessing HTTP(S) webservices protected by NTLM authentication If you want to connect to a windows server using some Windows Domain Login, please consider using Kerberos instead of the (older) NTLM mechanism - see below. Kerberos and NTLM are (currently) mutually exclusive - when LWP::Authen::Negotiate is installed, it will always be queried (and will always raise an error), even if you don't want to use it. See http://rt.cpan.org/Public/Bug/Display.html?id=32826 for details. You need the NTLM distribution installed to access webservices protected by NTLM authentication. More specifically, you need the Authen::NTLM module from this distribution. Note that this is different from the Authen::NTML distribution by Yee Man Chan also available from CPAN. Your user credentials usually need to include the windows domain or the windows hostname like this: CW testdomain\testuser R or CW \\testhost\testuser R Besides passing user credentials as when accessing a web service protected by basic or digest authentication, you also need to enforce connection keep_alive on the transport backens. To do so, pass a proxy argument to the new() method of the generated class. This unfortunately means that you have to set the endpoint URL, too: CW my $interface = MyInterfaces::SERVICE_NAME::PORT_NAME->new({ proxy => [ $url, keep_alive => 1 ] }); R You may, of course, decide to just hack the generated class. Be advised that subclassing might be a more appropriate solution - re-generating overwrites changes in interface classes. Accessing HTTP(S) webservices protected by NTLMv2 There are different variants of NTLM, and by default Authen::NTLM uses the v1 variant. NTLM is a connection-based handshake authentication protocol, which requires three or more requests on the same connection: CW Request POST Response 401 Unauthorized WWW-Authenticate: NTLM Request Authorization: NTLM <base64-encoded type-1-message> Response 401 Unauthorized WWW-Authenticate: NTLM <base64-encoded type-2-message> Request Authorization: NTLM <base64-encoded type-3-message> Response 200 Ok R If you try to access a NTLMv2 protected web service and switch on LWP::Debug by saying CW use LWP::Debug qw(+); R you should see at least two lines containing something like CW Authorization NTLM TlRMTVNTUAABAAAAB7IAAAAAAAAAAAAAAwADACAAAABmb28= ... Authorization NTLM TlRMTVNTUAABAAAAB7IAAAAAAAAAAAAAAw ... much longer ... ADACAAAABmb28= R If you're talking to a Server using NTLMv2 exclusively, you will only the first line in the debug output, and then an error. To explicitely enable NTLMv2, do the following in your client: CW use Authen::NTLM; ntlmv2(1); R This globally enables the use of NTLMv2. Note that this is a global setting: All clients running in the same perl interpreter will be affected. This can cause unexpected issues when running under mod_perl. Accessing webservices protected by HTTP Kerberos Authentication Use the LWP::Authen::Negotiate plugin from CPAN. You need to set up GSSAPI to perform the Kerberos authentication, though. How to do this is implementation specific (MIT or Heimdahl). See your Kerberos/GSSAPI documentation for details. (Newer) Windows Web Services usually allow to use both the Negotiate (Kerberos) and NTLM authentication scheme. Accessing HTTPS webservices protected by certificate authentication You need Crypt::SSLeay installed to access HTTPS webservices. See Crypt::SSLeay on how to configure client certificate authentication.
Software::LicenseUtils(3)
little useful bits of code for licensey things
sortlosig(3)
sort the logical signals of a figure by name
SoXtMaterialSliderSet(3, 3iv)
SoXtMaterialSliderSet
Spoon::Utils(3)
Spoon Utilities Class
Spreadsheet::XLSX(3)
Perl extension for reading MS Excel 2007 files;
Spreadsheet::XLSX::Fmt2007(3)
Spreadsheet::XLSX::Fmt2007
Spreadsheet::XLSX::Utility2007(3)
Utility function for Spreadsheet::XLSX
SQL::ReservedWords::SQLServer(3)
Reserved SQL words by SQL Server
SQL::Translator::Filter::Globals(3)
Add global fields and indices to all tables.
SQL::Translator::Generator::DDL::SQLServer(3)
A Moo based MS SQL Server DDL generation engine.
SQL::Translator::Parser::Access(3)
parser for Access as produced by mdbtools
SQL::Translator::Parser::DBI::SQLServer(3)
parser for SQL Server through DBD::ODBC
SQL::Translator::Parser::SQLServer(3)
parser for SQL Server
SQL::Translator::Producer::SQLServer(3)
MS SQLServer producer for SQL::Translator
SQL::Translator::Utils(3)
SQL::Translator Utility functions
Squatting::On::CGI(3)
if all else fails, you can still deploy on CGI
SRU::Utils(3)
Utility functions for SRU
SRU::Utils::XML(3)
XML utility functions for SRU
SRU::Utils::XMLTest(3)
XML testing utility functions
ssl, SSL(3)
OpenSSL SSL/TLS library
SSL, ssl(3)
OpenSSL SSL/TLS library
SSL_accept(3)
wait for a TLS/SSL client to initiate a TLS/SSL handshake
SSL_accept(3)
wait for a TLS/SSL client to initiate a TLS/SSL handshake
SSL_COMP_add_compression_method, SSL_COMP_free_compression_methods(3)
handle SSL/TLS integrated compression methods
SSL_COMP_add_compression_method, SSL_COMP_free_compression_methods, SSL_COMP_get0_name, SSL_COMP_get_compression_methods, SSL_COMP_get_id(3)
handle SSL/TLS integrated compression methods
SSL_connect(3)
initiate the TLS/SSL handshake with an TLS/SSL server
SSL_connect(3)
initiate the TLS/SSL handshake with an TLS/SSL server
SSL_copy_session_id(3)
copy session details between SSL objects
ssl_crl_cache_api(3)
API for a SSL/TLS CRL (Certificate Revocation List) cache.
SSL_CTX_add_client_custom_ext, SSL_CTX_add_server_custom_ext, SSL_CTX_set_custom_cli_ext(3)
custom TLS extension handling
SSL_CTX_dane_enable, SSL_CTX_dane_mtype_set, SSL_dane_enable, SSL_dane_tlsa_add, SSL_get0_dane_authority, SSL_CTX_dane_clear_flags, SSL_dane_clear_flags, SSL_dane_set_flags, SSL_get0_dane_tlsaSSL_CTX_dane_set_flags, SSL_get0_dane_tlsa(3)
SSL_CTX_dane_set_flags, SSL_CTX_dane_clear_flags, SSL_dane_set_flags, SSL_dane_clear_flags - enable DANE TLS authentication of the remote TLS server in the local TLS client
SSL_CTX_new, DTLS_client_method, DTLS_method, DTLS_server_method, DTLSv1_2_client_method, DTLSv1_2_method, DTLSv1_2_server_method, DTLSv1_client_method, DTLSv1_method, DTLSv1_server_method, SSLv23_client_method, SSLv23_method, SSLv23_server_method, SSLv2_client_method, SSLv2_method, SSLv2_server_method, SSLv3_client_method, SSLv3_method, SSLv3_server_method, TLSv1_1_client_method, TLSv1_1_method, TLSv1_1_server_method, TLSv1_2_client_method, TLSv1_2_method, TLSv1_2_server_method, TLSv1_client_method, TLSv1_method, TLSv1_server_method(3)
create a new SSL_CTX object as framework for TLS/SSL enabled functions
SSL_CTX_new, TLSv1_2_method, DTLS_client_method, DTLS_method, DTLS_server_method, DTLSv1_2_client_method, DTLSv1_2_method, DTLSv1_2_server_method, DTLSv1_client_method, DTLSv1_method, DTLSv1_server_method, SSL_CTX_up_ref, SSLv23_client_method, SSLv23_method, SSLv23_server_method, SSLv3_client_method, SSLv3_method, SSLv3_server_method, TLS_client_method, TLS_method, TLS_server_method, TLSv1_1_client_method, TLSv1_1_method, TLSv1_1_server_method, TLSv1_2_client_method, TLSv1_2_server_method, TLSv1_client_method, TLSv1_method, TLSv1_server_method, SSLv2_client_method, SSLv2_method, SSLv2_server_method(3)
create a new SSL_CTX object as framework for TLS/SSL or DTLS enabled functions
SSL_CTX_set_custom_cli_ext, SSL_CTX_add_client_custom_ext, SSL_CTX_add_server_custom_ext(3)
custom TLS extension handling
SSL_CTX_set_security_level, SSL_CTX_get0_security_ex_data, SSL_CTX_get_security_callback, SSL_CTX_get_security_level, SSL_CTX_set0_security_ex_data, SSL_CTX_set_security_callback, SSL_get0_security_ex_data, SSL_get_security_callback, SSL_get_security_level, SSL_set0_security_ex_data, SSL_set_security_callback, SSL_set_security_level(3)
SSL/TLS security framework
SSL_CTX_set_ssl_version, SSL_get_ssl_method, SSL_set_ssl_method(3)
choose a new TLS/SSL method
SSL_CTX_set_ssl_version, SSL_get_ssl_method, SSL_set_ssl_method(3)
choose a new TLS/SSL method
SSL_CTX_set_tlsext_status_cb, SSL_CTX_get_tlsext_status_arg, SSL_CTX_get_tlsext_status_cb, SSL_CTX_get_tlsext_status_type, SSL_CTX_set_tlsext_status_arg, SSL_CTX_set_tlsext_status_type, SSL_get_tlsext_status_ocsp_resp, SSL_get_tlsext_status_type, SSL_set_tlsext_status_ocsp_resp, SSL_set_tlsext_status_type(3)
OCSP Certificate Status Request functions
SSL_CTX_set_tlsext_status_cb, SSL_CTX_set_tlsext_status_arg, SSL_get_tlsext_status_ocsp_resp, SSL_set_tlsext_status_ocsp_resp, SSL_set_tlsext_status_type(3)
OCSP Certificate Status Request functions
SSL_CTX_set_tlsext_ticket_key_cb(3)
set a callback for session ticket processing
SSL_CTX_set_tlsext_ticket_key_cb(3)
set a callback for session ticket processing
SSL_do_handshake(3)
perform a TLS/SSL handshake
SSL_do_handshake(3)
perform a TLS/SSL handshake
SSL_extension_supported, custom_ext_add_cb, custom_ext_free_cb, custom_ext_parse_cb, SSL_CTX_add_client_custom_ext, SSL_CTX_add_server_custom_ext(3)
custom TLS extension handling
SSL_get_client_random, SSL_get_server_random, SSL_SESSION_get_master_key(3)
retrieve internal TLS/SSL random values and master key
SSL_get_error(3)
obtain result code for TLS/SSL I/O operation
SSL_get_error(3)
obtain result code for TLS/SSL I/O operation
SSL_get_session(3)
retrieve TLS/SSL session data
SSL_get_session, SSL_get0_session, SSL_get1_session(3)
retrieve TLS/SSL session data
SSL_get_version, SSL_is_dtls, SSL_version(3)
get the protocol information of a connection
SSL_read(3)
read bytes from a TLS/SSL connection.
SSL_read, SSL_peek(3)
read bytes from a TLS/SSL connection
SSL_renegotiate, SSL_renegotiate_abbreviated, SSL_renegotiate_pending(3)
initiate a new TLS handshake
ssl_session_cache_api(3)
Defines the API for the TLS session cache so that the data storage scheme can be replaced by defining a new callback module implementing this API.
SSL_SESSION_get0_peer(3)
get details about peer's certificate for a session
SSL_SESSION_get_compress_id(3)
get details about the compression associated with a session
SSL_SESSION_has_ticket, SSL_SESSION_get0_ticket, SSL_SESSION_get_ticket_lifetime_hint(3)
get details about the ticket associated with a session
SSL_set_session(3)
set a TLS/SSL session to be used during TLS/SSL connect
SSL_set_session(3)
set a TLS/SSL session to be used during TLS/SSL connect
SSL_shutdown(3)
shut down a TLS/SSL connection
SSL_shutdown(3)
shut down a TLS/SSL connection
SSL_want, SSL_want_async, SSL_want_async_job, SSL_want_nothing, SSL_want_read, SSL_want_write, SSL_want_x509_lookup(3)
obtain state information TLS/SSL I/O operation
SSL_want, SSL_want_nothing, SSL_want_read, SSL_want_write, SSL_want_x509_lookup(3)
obtain state information TLS/SSL I/O operation
SSL_write(3)
write bytes to a TLS/SSL connection.
SSL_write(3)
write bytes to a TLS/SSL connection
Stat::lsMode(3)
format file modes like the "ls -l" command does
Statistics::OLS(3)
perform ordinary least squares and associated statistics, v 0.07.
Statistics::PointEstimation(3)
Perl module for computing confidence intervals in parameter estimation with Student's T distribution Statistics::PointEstimation::Sufficient - Perl module for computing the confidence intervals using sufficient statistics
StdLabels(3, 3o)
Standard labeled libraries.
StdLabels.Array(3, 3o)
no description
StdLabels.Bytes(3, 3o)
no description
StdLabels.List(3, 3o)
no description
StdLabels.String(3, 3o)
no description
StringLabels(3, 3o)
String operations.
subfont, allocsubfont, freesubfont, installsubfont, lookupsubfont, mkfont, readsubfont, readsubfonti, stringsubfont, strsubfontwidth, subfontname, uninstallsubfont, writesubfont(3)
subfont manipulation
svc_dg_enablecache, svc_exit, svc_freeargs, svc_getargs, svc_getreq_common, svc_getreq_poll, svc_getreqset, svc_getrpccaller, svc_run, svc_sendreply, svc_pollset, __svc_getcallercreds, rpc_svc_calls, svc_fdset(3)
library routines for RPC servers
SVG::Graph::Glyph::axis(3)
draw CW Title : draw Usage : Function: Example : Returns : Args : R x_intercept CW Title : x_intercept Usage : $obj->x_intercept($newval) Function: Example : Returns : value of x_intercept (a scalar) Args : on set, new value (a scalar or undef, optional) R y_intercept CW Title : y_intercept Usage : $obj->y_intercept($newval) Function: Example : Returns : value of y_intercept (a scalar) Args : on set, new value (a scalar or undef, optional) R x_fractional_ticks CW Title : x_fractional_ticks Usage : $obj->x_fractional_ticks($newval) Function: Example : Returns : value of x_fractional_ticks (a scalar) Args : on set, new value (a scalar or undef, optional) R y_fractional_ticks CW Title : y_fractional_ticks Usage : $obj->y_fractional_ticks($newval) Function: Example : Returns : value of y_fractional_ticks (a scalar) Args : on set, new value (a scalar or undef, optional) R x_absolute_ticks CW Title : x_absolute_ticks Usage : $obj->x_absolute_ticks($newval) Function: Example : Returns : value of x_absolute_ticks (a scalar) Args : on set, new value (a scalar or undef, optional) R y_fractional_ticks CW Title : y_fractional_ticks Usage : $obj->y_fractional_ticks($newval) Function: Example : Returns : value of y_fractional_ticks (a scalar) Args : on set, new value (a scalar or undef, optional) R x_intertick_labels CW Title : x_intertick_labels Usage : $obj->x_intertick_labels($newval) Function: Example : Returns : value of x_intertick_labels (a scalar) Args : on set, new value (a scalar or undef, optional) R x_tick_labels CW Title : x_tick_labels Usage : $obj->x_tick_labels($newval) Function: Example : Returns : value of x_tick_labels (a scalar) Args : on set, new value (a scalar or undef, optional) R y_intertick_labels CW Title : y_intertick_labels Usage : $obj->y_intertick_labels($newval) Function: Example : Returns : value of y_intertick_labels (a scalar) Args : on set, new value (a scalar or undef, optional) R y_tick_labels CW Title : y_tick_labels Usage : $obj->y_tick_labels($newval) Function: Example : Returns : value of y_tick_labels (a scalar) Args : on set, new value (a scalar or undef, optional) R
SVK::Command::Admin(3)
Administration tools
SVK::Editor::Combine(3)
An editor combining several editor calls to one
SVK::Editor::Combiner(3)
An editor combining several editor calls to one
SVK::Editor::Copy(3)
Turn editor calls to calls with history
SVK::Editor::CopyHandler(3)
intercept copies in editor calls
SVK::Editor::Patch(3)
An editor to serialize editor calls.
SVK::Editor::Rename(3)
An editor that translates editor calls for renamed entries
SVN::Base(3)
Base class for importing symbols for svn modules
SVN::Hooks::Mailer(3)
Send emails after successful commits.
Symbol(3)
manipulate Perl symbols and their names
Symbol::Util(3)
Additional utils for Perl symbols manipulation
Sympa::HTMLSanitizer(3, 3Sympa)
Sanitize HTML contents
Sympa::Internals(3, 3Sympa)
Sympa internals
Sympa::Internals::Workflow(3, 3Sympa)
Overview on workflow of Sympa
Sympa::Spool::Digest::Collection(3, 3Sympa)
Collection of digest spools
Sympa::Tools::File(3, 3Sympa)
File-related functions
Sympa::Tools::Text(3, 3Sympa)
Text-related functions
Sympa::Tools::Time(3, 3Sympa)
Time-related functions
Syntax::Highlight::Engine::Kate::Convert::ToolKit(3)
helper routines, especially for generating highlight definitions from Kate's originals.
Syntax::Highlight::Engine::Kate::GLSL(3)
a Plugin for GLSL syntax highlighting
Syntax::Highlight::Engine::Kate::UnrealScript(3)
a Plugin for UnrealScript syntax highlighting
Sys::Syscall(3)
access system calls that Perl doesn't normally provide access to
Sys::Syslog(3)
Perl interface to the UNIX syslog(3) calls
sysdecode_syscallnames(3)
lookup name of system calls
systools(3)
A Set of Release Handling Tools.
tablesupport, FBB::TableSupport(3, 3bobcat)
Defines protocols for Table-support classes
tai_pack(3)
convert TAI64 labels to external format
taia_pack(3)
convert TAI64NA labels to external format
TAP::Formatter::Console::ParallelSession(3)
Harness output delegate for parallel console output
Tdbc_Init, Tdbc_MapSqlState, Tdbc_TokenizeSql(3)
C procedures to facilitate writing TDBC drivers
Template::Manual::Internals(3)
Template Toolkit internals
Template::Plugin::Clickable(3)
Make URLs clickable in HTML
Template::Plugin::URL(3)
Plugin to construct complex URLs
Template::Tools(3)
Command Line Tools for the Template Toolkit
Template::Tools::tpage(3)
Process templates from command line
Template::Tools::ttree(3)
Process entire directory trees of templates
Template::Tutorial(3)
Template Toolkit Tutorials
Term::Table::CellStack(3)
Combine several cells into one (vertical)
Test2(3)
Framework for writing test tools that all work together.
Test2::API(3)
Primary interface for writing Test2 based testing tools.
Test2::Compare(3)
Test2 extension for writing deep comparison tools.
Test2::Suite(3)
Distribution with a rich set of tools built upon the Test2 framework.
Test2::Tools(3)
Documentation for Tools.
Test2::Tools::Basic(3)
Test2 implementation of the basic testing tools.
Test2::Tools::Class(3)
Test2 implementation of the tools for testing classes.
Test2::Tools::ClassicCompare(3)
Classic (Test::More style) comparison tools.
Test2::Tools::Compare(3)
Tools for comparing deep data structures.
Test2::Tools::Defer(3)
Write tests that get executed at a later time
Test2::Tools::Encoding(3)
Tools for managing the encoding of Test2 based tests.
Test2::Tools::Event(3)
Tools for generating test events.
Test2::Tools::Exception(3)
Test2 based tools for checking exceptions
Test2::Tools::Exports(3)
Tools for validating exporters.
Test2::Tools::Grab(3)
Temporarily intercept all events without adding a scope level.
Test2::Tools::Mock(3)
Class/Instance mocking for Test2.
Test2::Tools::Ref(3)
Tools for validating references.
Test2::Tools::Subtest(3)
Tools for writing subtests
Test2::Tools::Target(3)
Alias the testing target package.
Test2::Tools::Tiny(3)
Tiny set of tools for unfortunate souls who cannot use Test2::Suite.
Test2::Tools::Warnings(3)
Tools to verify warnings.
Test2::Util(3)
Tools used by Test2 and friends.
Test2::Util::ExternalMeta(3)
Allow third party tools to safely attach meta-data to your instances.
Test2::Util::Ref(3)
Tools for inspecting or manipulating references.
Test2::Util::Sub(3)
Tools for inspecting and manipulating subs.
Test::DZil(3)
tools for testing Dist::Zilla plugins
Test::File::ShareDir::Utils(3)
Simple utilities for File::ShareDir testing
Test::LWP::UserAgent(3)
A LWP::UserAgent suitable for simulating and testing network calls
Test::MockDateTime(3)
mock DateTime->now calls during tests
Test::Moose::More(3)
More tools for testing Moose packages
Test::Moose::More::Utils(3)
Various utility functions for TMM (and maybe others!)
Test::SubCalls(3)
Track the number of times subs are called
Test::Taint(3)
Tools to test taintedness
Text::Decorator::Filter::URIFind(3)
Turn URLs into links
Text::MicroMason::AllowGlobals(3)
Share package vars between templates
Text::PDF::Bool, PDF::Bool(3)
A special form of PDF::String which holds the strings true or false
Text::PDF::Objind(3)
PDF indirect object reference. Also acts as an abstract superclass for all elements in a PDF file.
Text::PDF::Utils(3)
Utility functions for PDF library
Text::VisualWidth(3)
Perl extension for trimming text by the number of the columns of terminals and mobile phones.
Text::VisualWidth::EUC_JP(3)
Perl extension for Triming EUC-JP text by the number of the columns of terminals and mobile phones.
Text::VisualWidth::UTF8, Text::TrimViewWidth::UTF8(3)
Perl extension for Triming UTF-8 text by the number of the columns of terminals and mobile phones.
text_height(3)
Returns the height of a font in pixels. Allegro game programming library.
text_length(3)
Returns the length of a string in pixels. Allegro game programming library.
textdomain(3)
set domain for future gettext() calls
th_print_long_ls, th_print(3)
print out information about a tar file header
TIFFCurrentRow, TIFFCurrentDirectory, TIFFCurrentStrip, TIFFCurrentTile, TIFFFileName, TIFFFileno, TIFFGetMode, TIFFIsByteSwapped, TIFFIsMSB2LSB, TIFFIsTiled, TIFFIsUpSampled, TIFFLastDirectory, TIFFquery, TIFFGetVersion(3, 3TIFF, 3tiff)
query routines
Time::Interval(3)
Converts time intervals of days, hours, minutes, and seconds This is a rather simple perl module for dealing with time intervals. Among other things, this module can tell you the number of hours, minutes, and seconds elapsed between two dates.
timeradd, timerclear, timercmp, timerisset, timersub(3)
operations on timevals
Tk::Internals(3)
what is Perl Tk interface doing when you call Tk functions. This information is worse than useless for "perlTk" users, but can of some help for people interested in using modified Tk source with "perlTk". This document is under construction. The information is believed to be pertinent to the version of "portableTk" available when it was created. All the details are subject to change.
tls_accept_socket, tls_accept_cbs, tls_accept_fds(3)
accept an incoming client connection in a TLS server
tls_client, tls_configure, tls_free, tls_server(3)
configure a TLS connection
tls_config_ocsp_require_stapling(3)
OCSP configuration for libtls
tls_config_set_protocols, tls_config_parse_protocols, tls_config_prefer_ciphers_client, tls_config_prefer_ciphers_server, tls_config_set_alpn, tls_config_set_ciphers, tls_config_set_dheparams, tls_config_set_ecdhecurve(3)
TLS protocol and cipher selection
tls_config_set_session_id, tls_config_add_ticket_key, tls_config_set_session_lifetime(3)
configure resuming of TLS handshakes
tls_config_verify, tls_config_insecure_noverifycert, tls_config_insecure_noverifyname, tls_config_insecure_noverifytime(3)
insecure TLS configuration
tls_conn_version, tls_conn_alpn_selected, tls_conn_cipher, tls_conn_servername, tls_peer_cert_contains_name, tls_peer_cert_hash, tls_peer_cert_issuer, tls_peer_cert_notafter, tls_peer_cert_notbefore, tls_peer_cert_provided, tls_peer_cert_subject(3)
inspect an established TLS connection
tls_connect, tls_connect_cbs, tls_connect_fds, tls_connect_servername, tls_connect_socket(3)
instruct a TLS client to establish a connection
tls_init, tls_config_error, tls_config_free, tls_config_new(3)
initialize TLS client and server API
tls_load_file, tls_config_add_keypair_file, tls_config_add_keypair_mem, tls_config_add_keypair_ocsp_file, tls_config_add_keypair_ocsp_mem, tls_config_clear_keys, tls_config_set_ca_file, tls_config_set_ca_mem, tls_config_set_ca_path, tls_config_set_cert_file, tls_config_set_cert_mem, tls_config_set_key_file, tls_config_set_key_mem, tls_config_set_keypair_file, tls_config_set_keypair_mem, tls_config_set_keypair_ocsp_file, tls_config_set_keypair_ocsp_mem, tls_config_set_ocsp_staple_file, tls_config_set_ocsp_staple_mem, tls_config_set_verify_depth, tls_config_verify_client, tls_config_verify_client_optional(3)
TLS certificate and key configuration
tls_ocsp_process_response, tls_peer_ocsp_cert_status, tls_peer_ocsp_crl_reason, tls_peer_ocsp_next_update, tls_peer_ocsp_response_status, tls_peer_ocsp_result_msg, tls_peer_ocsp_revocation_time, tls_peer_ocsp_this_update, tls_peer_ocsp_url(3)
inspect an OCSP response
tls_read, tls_close, tls_error, tls_handshake, tls_reset, tls_write(3)
use a TLS connection
toolbar(3)
GUI for Starting Tools and User Contributions
ToolSet(3)
Load your commonly-used modules in a single import
ToolSet::SWC(3)
Sample toolset with strict, warnings and Carp
TopLevelShell(3)
The TopLevelShell widget class
tpmUnsealFile, tpmUnsealShred, tpmUnsealStrerror(3)
unseal routines
tt_pattern_barg_add(3, library call)
add an argument with a value that contains embedded nulls to a pattern
tt_pattern_user_set(3, library call)
store information in the user data cells of a pattern object
ttb(3)
A base for building trace tools for distributed systems.
tty, FBB::Tty(3, 3bobcat)
Controls echoing of characters entered at the terminal
Twiggy::TLS(3)
Twiggy server with TLS support.
Twiggy::TLS::Info(3)
TLS connection information
Type::Tiny::Manual::Libraries(3)
how to build a type library with Type::Tiny, Type::Library and Type::Utils
Type::Utils(3)
utility functions to make defining and using type constraints a little easier
Types::Core(3)
Core types defined as tests and literals (ease of use)
Types::Standard::ArrayRef(3)
internals for the Types::Standard ArrayRef type constraint
Types::Standard::CycleTuple(3)
internals for the Types::Standard CycleTuple type constraint
Types::Standard::Dict(3)
internals for the Types::Standard Dict type constraint
Types::Standard::HashRef(3)
internals for the Types::Standard HashRef type constraint
Types::Standard::Map(3)
internals for the Types::Standard Map type constraint
Types::Standard::ScalarRef(3)
internals for the Types::Standard ScalarRef type constraint
Types::Standard::Tuple(3)
internals for the Types::Standard Tuple type constraint
Ubic::Credentials(3)
base class for OS-specific credential methods
Ubic::Credentials::OS::MacOSX(3)
MacOSX-specific credentials implementation
Ubic::Credentials::OS::POSIX(3)
POSIX-specific credentials implementation
Ubic::Credentials::OS::Windows(3)
dummy credentials module
Ubic::Service::Utils(3)
helpers for custom service authors
uisdigit(3)
Tells if a character is a digit. Allegro game programming library.
uisspace(3)
Tells if a character is whitespace. Allegro game programming library.
UML::Sequence::PerlSeq(3)
for use with genericseq.pl script, works on Perl programs
UNIVERSAL::which(3)
tells fully qualified name of the method
Unix::Groups(3)
Perl to support "getgroups" and "setgroups" syscalls
Unix::Lsof(3)
Wrapper to the Unix lsof utility
Unix::Lsof::Result(3)
Perlish interface to lsof output
Unix::Syslog(3)
Perl interface to the UNIX syslog(3) calls
upsclient(3)
Network UPS Tools client access library
URI::Match(3)
Match URLs By Parts
URI::ParseSearchString(3)
parse search engine referrer URLs and extract keywords used
URI::Sequin(3)
Extract information from the URLs of Search-Engines
User::Identity::Collection::Emails(3)
a collection of email roles
ustrlen(3)
Tells the number of characters in a string. Allegro game programming library.
Validation::Class::Directive::MaxSymbols(3)
MaxSymbols Directive for Validation Class Field Definitions
Validation::Class::Directive::MinSymbols(3)
MinSymbols Directive for Validation Class Field Definitions
VCP::ConfigFileUtils(3)
utilities used to parse or create vcp config files
VCP::Filter::addlabels(3)
Add labels to each revision
VCP::Filter::labelmap(3)
Alter or remove labels from each revision
VCP::TestUtils(3)
support routines for VCP testing
VCP::Utils(3)
utilities used within VCP's modules.
VCP::Utils::cvs(3)
utilities for dealing with the cvs command
VCP::Utils::metadb(3)
utilities for dealing with metadbs
VCP::Utils::p4(3)
utilities for dealing with the p4 command
VCP::Utils::revml(3)
utilities for dealing with the revml command
VCP::Utils::vss(3)
utilities for dealing with the vss command
version::Internals(3)
Perl extension for Version Objects
vga_accel(3)
calls the graphics accelerator
vga_drawscanline(3)
draw a horizontal line of pixels
vga_drawscansegment(3)
draw a horizontal line of pixels
vga_getpixel(3)
get a pixels value from the screen
vgl, VGLBitmapAllocateBits, VGLBitmapCopy, VGLBitmapCreate, VGLBitmapDestroy, VGLBitmapPutChar, VGLBitmapString, VGLBlankDisplay, VGLBox, VGLCheckSwitch, VGLClear, VGLEllipse, VGLEnd, VGLFilledBox, VGLFilledEllipse, VGLGetXY, VGLInit, VGLKeyboardEnd, VGLKeyboardGetCh, VGLKeyboardInit, VGLLine, VGLMouseInit, VGLMouseMode, VGLMouseSetImage, VGLMouseSetStdImage, VGLMouseStatus, VGLPanScreen, VGLSetBorder, VGLSetPalette, VGLSetPaletteIndex, VGLSetVScreenSize, VGLSetXY, VGLTextSetFontFile(3)
Video Graphics Library functions
VM::EC2::Instance::Status::Details(3)
Object describing the details of an instance status check
VM::EC2::Security::CredentialCache(3)
Cache credentials respecting expiration time for IAM roles.
VM::EC2::Security::Credentials(3)
Temporary security credentials for EC2
VM::EC2::Volume::Status::Details(3)
Object describing the details of an volume status check
volpack-ClsfyScalar, vpClassifyScalars(3)
create a preclassified volume from scalar data
volpack-ClsfyScan, vpClassifyScanline(3)
incrementally create a preclassified volume from scanlines of scalar data
volpack-ClsfyTable, vpSetClassifierTable(3)
specify an opacity transfer function
volpack-ClsfyVolume, vpClassifyVolume, vpDestroyClassifiedVolume(3)
create/destroy a preclassified volume for fast rendering
volpack-RawVoxels, vpSetRawVoxels(3)
specify an array of volume data
volpack-ScanNormals, vpScanlineNormals(3)
compute surface normal vectors and gradient magnitudes for a scanline
volpack-TracePixel, vpTracePixel(3)
print a trace of the voxels composited into a pixel
volpack-VolumeNormals, vpVolumeNormals(3)
compute surface normal vectors and gradient magnitudes for a volume
volpack-VoxelSize, vpSetVoxelSize(3)
define the size of a voxel
votequorum_qdevice_poll(3)
Tells votequorum the result of the quorum device poll
WebService::GData::Collection(3)
Composite class redispatching method calls to query the items data.
webtool(3)
WebTool is a tool used to simplify the implementation of web based tools with Erlang/OTP.
WordNet::Tools(3)
Some tools for use with WordNet.
WordPress::XMLRPC(3)
api to wordpress xml rpc calls
WWW::Mixi::Scraper::Utils(3)
internal utilities
WWW::Shorten::Bitly(3)
Interface to shortening URLs using <http://bitly.com>
WWW::Shorten::LinkToolbot(3)
(DEPRECATED) Shorten URLs
WWW::Shorten::Linkz(3)
(DEPRECATED) Shorten URLs
WWW::Shorten::MakeAShorterLink(3)
(DEPRECATED) Shorten URLs
WWW::Shorten::Metamark(3)
(DEPRECATED) Shorten URLs
WWW::Shorten::Qurl(3)
(DEPRECATED) Shorten URLs
WWW::Shorten::TinyClick(3)
(DEPRECATED) Shorten URLs
WWW::Shorten::Tinylink(3)
(DEPRECATED) Shorten URLs
WWW::Shorten::Yourls(3)
Interface to shortening URLs using <http://yourls.org>
WWW::YoutubeViewer::Channels(3)
Channels interface.
WWW::YoutubeViewer::RegularExpressions(3)
Various utils.
WWW::YoutubeViewer::Utils(3)
Various utils.
WWWdb::ConfigPool(3)
ConfigPools for WWWdb
Wx::build::MakeMaker(3)
ExtUtils::MakeMaker specialisation for wxPerl modules
Wx::build::Utils(3)
utility routines
wxGridCellStringRenderer(3)
See external documentation: wxGridCellStringRenderer.
X11::Xlib::XVisualInfo(3)
Struct to list details of a Visual*
X509_dup, DECLARE_ASN1_FUNCTIONS, ACCESS_DESCRIPTION_free, ACCESS_DESCRIPTION_new, ASIdentifierChoice_free, ASIdentifierChoice_new, ASIdentifiers_free, ASIdentifiers_new, ASIdOrRange_free, ASIdOrRange_new, ASN1_ITEM, ASRange_free, ASRange_new, AUTHORITY_INFO_ACCESS_free, AUTHORITY_INFO_ACCESS_new, AUTHORITY_KEYID_free, AUTHORITY_KEYID_new, BASIC_CONSTRAINTS_free, BASIC_CONSTRAINTS_new, CERTIFICATEPOLICIES_free, CERTIFICATEPOLICIES_new, CMS_ContentInfo_free, CMS_ContentInfo_new, CMS_ContentInfo_print_ctx, CMS_ReceiptRequest_free, CMS_ReceiptRequest_new, CRL_DIST_POINTS_free, CRL_DIST_POINTS_new, DIRECTORYSTRING_free, DIRECTORYSTRING_new, DISPLAYTEXT_free, DISPLAYTEXT_new, DIST_POINT_free, DIST_POINT_NAME_free, DIST_POINT_NAME_new, DIST_POINT_new, DSAparams_dup, ECPARAMETERS_free, ECPARAMETERS_new, ECPKPARAMETERS_free, ECPKPARAMETERS_new, EDIPARTYNAME_free, EDIPARTYNAME_new, ESS_CERT_ID_dup, ESS_CERT_ID_free, ESS_CERT_ID_new, ESS_ISSUER_SERIAL_dup, ESS_ISSUER_SERIAL_free, ESS_ISSUER_SERIAL_new, ESS_SIGNING_CERT_dup, ESS_SIGNING_CERT_free, ESS_SIGNING_CERT_new, EXTENDED_KEY_USAGE_free, EXTENDED_KEY_USAGE_new, GENERAL_NAME_dup, GENERAL_NAME_free, GENERAL_NAME_new, GENERAL_NAMES_free, GENERAL_NAMES_new, GENERAL_SUBTREE_free, GENERAL_SUBTREE_new, IMPLEMENT_ASN1_FUNCTIONS, IPAddressChoice_free, IPAddressChoice_new, IPAddressFamily_free, IPAddressFamily_new, IPAddressOrRange_free, IPAddressOrRange_new, IPAddressRange_free, IPAddressRange_new, ISSUING_DIST_POINT_free, ISSUING_DIST_POINT_new, NAME_CONSTRAINTS_free, NAME_CONSTRAINTS_new, NETSCAPE_CERT_SEQUENCE_free, NETSCAPE_CERT_SEQUENCE_new, NETSCAPE_SPKAC_free, NETSCAPE_SPKAC_new, NETSCAPE_SPKI_free, NETSCAPE_SPKI_new, NOTICEREF_free, NOTICEREF_new, OCSP_BASICRESP_free, OCSP_BASICRESP_new, OCSP_CERTID_dup, OCSP_CERTID_new, OCSP_CERTSTATUS_free, OCSP_CERTSTATUS_new, OCSP_CRLID_free, OCSP_CRLID_new, OCSP_ONEREQ_free, OCSP_ONEREQ_new, OCSP_REQINFO_free, OCSP_REQINFO_new, OCSP_RESPBYTES_free, OCSP_RESPBYTES_new, OCSP_RESPDATA_free, OCSP_RESPDATA_new, OCSP_RESPID_free, OCSP_RESPID_new, OCSP_RESPONSE_new, OCSP_REVOKEDINFO_free, OCSP_REVOKEDINFO_new, OCSP_SERVICELOC_free, OCSP_SERVICELOC_new, OCSP_SIGNATURE_free, OCSP_SIGNATURE_new, OCSP_SINGLERESP_free, OCSP_SINGLERESP_new, OTHERNAME_free, OTHERNAME_new, PBE2PARAM_free, PBE2PARAM_new, PBEPARAM_free, PBEPARAM_new, PBKDF2PARAM_free, PBKDF2PARAM_new, PKCS12_BAGS_free, PKCS12_BAGS_new, PKCS12_free, PKCS12_MAC_DATA_free, PKCS12_MAC_DATA_new, PKCS12_new, PKCS12_SAFEBAG_free, PKCS12_SAFEBAG_new, PKCS7_DIGEST_free, PKCS7_DIGEST_new, PKCS7_dup, PKCS7_ENC_CONTENT_free, PKCS7_ENC_CONTENT_new, PKCS7_ENCRYPT_free, PKCS7_ENCRYPT_new, PKCS7_ENVELOPE_free, PKCS7_ENVELOPE_new, PKCS7_free, PKCS7_ISSUER_AND_SERIAL_free, PKCS7_ISSUER_AND_SERIAL_new, PKCS7_new, PKCS7_print_ctx, PKCS7_RECIP_INFO_free, PKCS7_RECIP_INFO_new, PKCS7_SIGN_ENVELOPE_free, PKCS7_SIGN_ENVELOPE_new, PKCS7_SIGNED_free, PKCS7_SIGNED_new, PKCS7_SIGNER_INFO_free, PKCS7_SIGNER_INFO_new, PKCS8_PRIV_KEY_INFO_free, PKCS8_PRIV_KEY_INFO_new, PKEY_USAGE_PERIOD_free, PKEY_USAGE_PERIOD_new, POLICY_CONSTRAINTS_free, POLICY_CONSTRAINTS_new, POLICY_MAPPING_free, POLICY_MAPPING_new, POLICYINFO_free, POLICYINFO_new, POLICYQUALINFO_free, POLICYQUALINFO_new, PROXY_CERT_INFO_EXTENSION_free, PROXY_CERT_INFO_EXTENSION_new, PROXY_POLICY_free, PROXY_POLICY_new, RSA_OAEP_PARAMS_free, RSA_OAEP_PARAMS_new, RSA_PSS_PARAMS_free, RSA_PSS_PARAMS_new, RSAPrivateKey_dup, RSAPublicKey_dup, SXNET_free, SXNET_new, SXNETID_free, SXNETID_new, TLS_FEATURE_free, TLS_FEATURE_new, TS_ACCURACY_dup, TS_ACCURACY_free, TS_ACCURACY_new, TS_MSG_IMPRINT_dup, TS_MSG_IMPRINT_free, TS_MSG_IMPRINT_new, TS_REQ_dup, TS_REQ_free, TS_REQ_new, TS_RESP_dup, TS_RESP_free, TS_RESP_new, TS_STATUS_INFO_dup, TS_STATUS_INFO_free, TS_STATUS_INFO_new, TS_TST_INFO_dup, TS_TST_INFO_free, TS_TST_INFO_new, USERNOTICE_free, USERNOTICE_new, X509_ALGOR_free, X509_ALGOR_new, X509_ATTRIBUTE_dup, X509_ATTRIBUTE_free, X509_ATTRIBUTE_new, X509_CERT_AUX_free, X509_CERT_AUX_new, X509_CINF_free, X509_CINF_new, X509_CRL_dup, X509_CRL_free, X509_CRL_INFO_free, X509_CRL_INFO_new, X509_CRL_new, X509_EXTENSION_dup, X509_EXTENSION_free, X509_EXTENSION_new, X509_NAME_dup, X509_NAME_ENTRY_dup, X509_NAME_ENTRY_free, X509_NAME_ENTRY_new, X509_NAME_free, X509_NAME_new, X509_REQ_dup, X509_REQ_free, X509_REQ_INFO_free, X509_REQ_INFO_new, X509_REQ_new, X509_REVOKED_dup, X509_REVOKED_free, X509_REVOKED_new, X509_SIG_free, X509_SIG_new, X509_VAL_free, X509_VAL_new, OCSP_crlID_new, OCSP_url_svcloc_new, SCT_LIST_free(3)
X509_STORE_CTX_new, X509_STORE_CTX_cleanup, X509_STORE_CTX_free, X509_STORE_CTX_get0_chain, X509_STORE_CTX_get0_param, X509_STORE_CTX_get0_untrusted, X509_STORE_CTX_get_num_untrusted, X509_STORE_CTX_init, X509_STORE_CTX_set0_crls, X509_STORE_CTX_set0_param, X509_STORE_CTX_set0_trusted_stack, X509_STORE_CTX_set0_untrusted, X509_STORE_CTX_set0_verified_chain, X509_STORE_CTX_set_cert, X509_STORE_CTX_set_default, X509_STORE_CTX_set_verify, X509_STORE_CTX_verify_fn, X509_STORE_CTX_set_chain, X509_STORE_CTX_trusted_stack(3)
X509_STORE_CTX initialisation
X509_STORE_CTX_new, X509_STORE_CTX_cleanup, X509_STORE_CTX_free, X509_STORE_CTX_get0_param, X509_STORE_CTX_init, X509_STORE_CTX_set0_crls, X509_STORE_CTX_set0_param, X509_STORE_CTX_set_cert, X509_STORE_CTX_set_chain, X509_STORE_CTX_set_default, X509_STORE_CTX_trusted_stack(3)
X509_STORE_CTX initialisation
X509_STORE_CTX_set_verify_cb, X509_STORE_CTX_get_cleanup, X509_STORE_CTX_get_cert_crl, X509_STORE_CTX_get_check_crl, X509_STORE_CTX_get_check_issued, X509_STORE_CTX_get_check_policy, X509_STORE_CTX_get_check_revocation, X509_STORE_CTX_get_get_crl, X509_STORE_CTX_get_get_issuer, X509_STORE_CTX_get_lookup_certs, X509_STORE_CTX_get_lookup_crls, X509_STORE_CTX_get_verify_cb, X509_STORE_CTX_verify_cb(3)
get and set verification callback
X509_STORE_set_verify_cb_func, X509_STORE_set_lookup_crls_cb, X509_STORE_CTX_cert_crl_fn, X509_STORE_CTX_check_crl_fn, X509_STORE_CTX_check_issued_fn, X509_STORE_CTX_check_policy_fn, X509_STORE_CTX_check_revocation_fn, X509_STORE_CTX_get_verify, X509_STORE_get_cert_crl, X509_STORE_get_check_crl, X509_STORE_get_check_issued, X509_STORE_get_check_policy, X509_STORE_get_check_revocation, X509_STORE_get_cleanup, X509_STORE_get_get_crl, X509_STORE_get_get_issuer, X509_STORE_get_lookup_certs, X509_STORE_get_lookup_crls, X509_STORE_get_verify_cb, X509_STORE_set_cert_crl, X509_STORE_set_check_crl, X509_STORE_set_check_issued, X509_STORE_set_check_policy, X509_STORE_set_check_revocation, X509_STORE_set_cleanup, X509_STORE_set_get_crl, X509_STORE_set_get_issuer, X509_STORE_set_lookup_certs, X509_STORE_set_lookup_crls, X509_STORE_set_verify, X509_STORE_set_verify_cb, X509_STORE_set_verify_func, X509_STORE_CTX_cleanup_fnX509_STORE_CTX_get_crl_fn, X509_STORE_CTX_get_issuer_fn, X509_STORE_CTX_lookup_certs_fn, X509_STORE_CTX_lookup_crls_fn, X509_STORE_CTX_cleanup_fn(3)
X509_STORE_CTX_get_crl_fn, X509_STORE_CTX_get_issuer_fn, X509_STORE_CTX_lookup_certs_fn, X509_STORE_CTX_lookup_crls_fn - set verification callback
XAllocColor, XAllocColorCells, XAllocColorPlanes, XAllocNamedColor, XFreeColors(3)
allocate and free colors
xcb_alloc_color_cells, xcb_alloc_color_cells_masks, xcb_alloc_color_cells_masks_end, xcb_alloc_color_cells_masks_length, xcb_alloc_color_cells_pixels, xcb_alloc_color_cells_pixels_end, xcb_alloc_color_cells_pixels_length, xcb_alloc_color_cells_reply, xcb_alloc_color_cells_unchecked(3)
xcb_alloc_color_planes, xcb_alloc_color_planes_pixels, xcb_alloc_color_planes_pixels_end, xcb_alloc_color_planes_pixels_length, xcb_alloc_color_planes_reply, xcb_alloc_color_planes_unchecked(3)
xcb_glx_get_separable_filter, xcb_glx_get_separable_filter_reply, xcb_glx_get_separable_filter_rows_and_cols, xcb_glx_get_separable_filter_rows_and_cols_end, xcb_glx_get_separable_filter_rows_and_cols_length, xcb_glx_get_separable_filter_unchecked(3)
xcb_glx_read_pixels, xcb_glx_read_pixels_data, xcb_glx_read_pixels_data_end, xcb_glx_read_pixels_data_length, xcb_glx_read_pixels_reply, xcb_glx_read_pixels_unchecked(3)
xcb_kill_client, xcb_kill_client_checked(3)
kills a client
xcb_poly_fill_rectangle, xcb_poly_fill_rectangle_checked(3)
Fills rectangles
xcb_render_query_pict_formats, xcb_render_query_pict_formats_formats, xcb_render_query_pict_formats_formats_iterator, xcb_render_query_pict_formats_formats_length, xcb_render_query_pict_formats_reply, xcb_render_query_pict_formats_screens_iterator, xcb_render_query_pict_formats_screens_length, xcb_render_query_pict_formats_subpixels, xcb_render_query_pict_formats_subpixels_end, xcb_render_query_pict_formats_subpixels_length, xcb_render_query_pict_formats_unchecked(3)
xcb_xkb_controls_notify_event_t(3)
xcb_xkb_get_controls, xcb_xkb_get_controls_reply, xcb_xkb_get_controls_unchecked(3)
xcb_xkb_list_components, xcb_xkb_list_components_compat_maps_iterator, xcb_xkb_list_components_compat_maps_length, xcb_xkb_list_components_geometries_iterator, xcb_xkb_list_components_geometries_length, xcb_xkb_list_components_keycodes_iterator, xcb_xkb_list_components_keycodes_length, xcb_xkb_list_components_keymaps_iterator, xcb_xkb_list_components_keymaps_length, xcb_xkb_list_components_reply, xcb_xkb_list_components_symbols_iterator, xcb_xkb_list_components_symbols_length, xcb_xkb_list_components_types_iterator, xcb_xkb_list_components_types_length, xcb_xkb_list_components_unchecked(3)
xcb_xkb_set_controls, xcb_xkb_set_controls_checked(3)
XcmEvents, X(3)
Color Management Event API's - Macros +1c #define XCM_ICC_COLOUR_SERVER_TARGET_PROFILE_IN_X_BASE '_ICC_DEVICE_PROFILE' X Color Management spec atoms. #define XCM_ICC_V0_3_TARGET_PROFILE_IN_X_BASE '_ICC_PROFILE' ICC_PROFILE(xxx) in X spec atoms -1c Typedefs +1c typedef struct XcmeContext_s_ XcmeContext_s context for parsing events -1c Enumerations +1c enum XCME_MSG_e { XCME_MSG_TITLE = 400, XCME_MSG_COPYRIGHT, XCME_MSG_INFO, XCME_MSG_SYSTEM, XCME_MSG_DISPLAY_ERROR, XCME_MSG_DISPLAY_EVENT, XCME_MSG_DISPLAY_STATUS } customisable signals for a observer -1c Functions +1c int XcmMessage (XCME_MSG_e code, const void *context, const char *format,...) default message function int XcmMessageFuncSet (XcmMessage_f message_func) set a message function to customise messages const char * XcmePrintWindowName (Display *display, Window w) return a short window description text void XcmICCprofileGetNameFuncSet (XcmICCprofileGetName_f getName) plugin more informations capabilities for ICC profiles void XcmICCprofileFromMD5FuncSet (XcmICCprofileGetFromMD5_f fromMD5) plugin more informations capabilities for ICC profiles const char * XcmePrintWindowRegions (Display *display, Window w, int always) provide info text about window regions void xcmePrintWindowRegions (Display *display, Window w, int always) send a message about window regions void XcmeSelectInput (XcmeContext_s *c) register windows XcmeContext_s * XcmeContext_New () allocate a event observer context structure XcmeContext_s * XcmeContext_Create (const char *display_name) allocate and initialise a event observer context structure int XcmeContext_Setup2 (XcmeContext_s *c, const char *display_name, int flags) allocate and initialise a event observer context structure int XcmeContext_Setup (XcmeContext_s *c, const char *display_name) allocate and initialise a event observer context structure int XcmeContext_Release (XcmeContext_s **c) clean owned resources int XcmeContext_InLoop (XcmeContext_s *c, XEvent *event) check for colour management events Display * XcmeContext_DisplayGet (XcmeContext_s *c) return the Display int XcmeContext_DisplaySet (XcmeContext_s *c, Display *display) set a custom X11 Display int XcmeContext_WindowSet (XcmeContext_s *c, Window window) set a custom X11 Window -1c
xdr_accepted_reply, xdr_authsys_parms, xdr_callhdr, xdr_callmsg, xdr_opaque_auth, xdr_rejected_reply, xdr_replymsg, rpc_xdr(3)
XDR library routines for remote procedure calls
XGetDeviceControl, XChangeDeviceControl(3)
query and change input device controls
XkbActionCtrls(3)
Returns the ctrls fields of act converted to an unsigned int
XkbAllocControls(3)
Allocates an XkbControlsRec structure in the XkbDescRec
XkbChangeControls(3)
Provides a flexible method for updating the controls in a server to match those in the changed keyboard description
XkbChangeEnabledControls(3)
Manipulates the EnabledControls control
XkbForceBell(3)
Overrides user preference settings for audible bells to ring the bell on the default keyboard
XkbForceDeviceBell(3)
Rings the bell on any keyboard, overriding user preference settings for audible bells
XkbFreeControls(3)
Frees memory used by the ctrls member of an XkbDescRec structure
XkbGetAutoResetControls(3)
Gets the current values of the auto-reset controls
XkbGetControls(3)
Finds the current state of Xkb server controls
XkbGetControlsChanges(3)
Updates a local copy of a keyboard description with the changes previously noted by one or more calls to XkbNoteControlsChanges
XkbGetIndicatorChanges(3)
Updates a local copy of the keyboard description with the actual values of one or more calls to XkbNoteIndicatorChanges
XkbGetKeySyms(3)
Obtain the symbols for a subset of the keys in a keyboard description
XkbGetNameChanges(3)
Update the local copy of the keyboard description with the actual values of the results of one or more calls to XkbNoteNameChanges
XkbGetXlibControls(3)
Determines the current state of the Library Controls
XkbKeyGroupInfo(3)
Returns the number of groups of symbols bound to the key corresponding to keycode
XkbKeyNumGroups(3)
Returns the number of groups of symbols bound to the key corresponding to keycode
XkbKeyTypesForCoreSymbols(3)
Determine the Xkb key types appropriate for the symbols bound to a key in a core keyboard mapping
XkbNoteControlsChanges(3)
Notes the changes in a changes structure when a client receives an XkbControlsNotify event
XkbResizeKeySyms(3)
Change the number of symbols bound to a key
XkbResizeKeyType(3)
Change the number of levels in a key type
XkbSAActionSetCtrls(3)
Sets the ctrls0 through ctrls3 fields of act from ctrls
XkbSelectEventDetails(3)
Selects or deselects for a specific Xkb event and optionally places conditions on when events of that type are reported to your client
XkbSetAutoResetControls(3)
Changes the current values of the AutoReset control attributes
XkbSetControls(3)
Copies changes to the X server based on a modified ctrls structure in a local copy of the keyboard description
XkbSetDebuggingFlags(3)
Change the values of any of the debug controls
XkbSetXlibControls(3)
Changes the state of the Library Controls
XmAddProtocols(3)
A VendorShell function that adds the protocols to the protocol manager and allocates the internal tables
XmAddWMProtocols(3)
A VendorShell convenience interface that adds the protocols to the protocol manager and allocates the internal tables
XmClipboardCancelCopy(3)
A clipboard function that cancels a copy to the clipboard
XML::Atom::Filter(3)
easy creation of command line Atom processing tools
XML::Compile::SOAP::Trace(3)
help displaying trace details.
XML::DOM::PerlSAX(3)
Old name of XML::Handler::BuildDOM
XML::ESISParser(3)
Perl SAX parser using nsgmls
XML::Filter::DetectWS(3)
A PerlSAX filter that detects ignorable whitespace
XML::Grove::Builder(3)
PerlSAX handler for building an XML::Grove
XML::Grove::PerlSAX(3)
an PerlSAX event interface for XML objects
XML::Handler::BuildDOM(3)
PerlSAX handler that creates XML::DOM document structures
XML::Handler::PrintEvents(3)
Prints PerlSAX events (for debugging)
XML::Handler::Sample(3)
a trivial PerlSAX handler
XML::Handler::Subs(3)
a PerlSAX handler base class for calling user-defined subs
XML::Handler::Trees(3)
PerlSAX handlers for building tree structures
XML::Handler::XMLWriter(3)
a PerlSAX handler for writing readable XML
XML::LibXML::Boolean(3)
Boolean true/false values
XML::LibXML::ErrNo(3)
Structured Errors This module is based on xmlerror.h libxml2 C header file. It defines symbolic constants for all libxml2 error codes. Currently libxml2 uses over 480 different error codes. See also XML::LibXML::Error.
XML::Literal(3)
Syntax suppor for XML literals
XML::Parser::PerlSAX(3)
Perl SAX parser using XML::Parser
XML::Pastor::SimpleType(3)
Ancestor of all simple classes generated by XML::Pastor and also the builtin simple classes.
XML::RSS::Headline::UsePerlJournals(3)
XML::RSS::Headline Example Subclass
XML::Smart(3)
A smart, easy and powerful way to access or create XML from fiels, data and URLs.
XML::Toolkit(3)
A suit of XML tools with Antlers.
XML::Toolkit::Builder(3)
A set of tools for Building XML Classes via XML::SAX Streams
XML::Toolkit::Generator(3)
A set of tools for converting Moose Objects into XML
XML::Toolkit::Loader(3)
A set of tools for Loading XML into Moose Objects
XML::XBEL::url(3)
private methods for XBEL URLs.
XML::XPath::Boolean(3)
Boolean true/false values
XML::XPath::PerlSAX(3)
A PerlSAX event generator for my weird node structure
XML::XPathEngine::Boolean(3)
Boolean true/false values
XmListSetHorizPos(3)
A List function that scrolls to the specified position in the list
XmRemoveProtocols(3)
A VendorShell function that removes the protocols from the protocol manager and deallocates the internal tables
XmRemoveWMProtocols(3)
A VendorShell convenience interface that removes the protocols from the protocol manager and deallocates the internal tables
XmRepTypeAddReverse(3)
A representation type manager function that installs the reverse converter for a previously registered representation type
XmRepTypeInstallTearOffModelConverter(3)
A representation type manager function that installs the resource converter for XmNtearOffModel.
XmScaleSetTicks(3)
A Scale function that controls tick marks
XmStringBaseline(3)
A compound string function that returns the number of pixels between the top of the character box and the baseline of the first line of text
XmtAddDeleteCallback, XmtAddSaveYourselfCallback, XmtAddDeleteCallback(), XmtAddSaveYourselfCallback()(3)
register callbacks for session management protocols.
XmtBuildToplevel, XmtBuildToplevel(), XmtBuildQueryToplevel()(3)
create a TopLevelShell widget and all of its descendants.
XmTextScroll(3)
A Text function that scrolls text
XmtGetShell, XmtGetTopLevelShell, XmtGetShell(), XmtGetApplicationShell(), XmtGetTopLevelShell()(3)
return shell ancestors of a widget.
XmtLayoutConvertSizeToPixels, XmtLayoutConvertSizeToPixels()(3)
convert a resolution independent size to pixels.
XmtPatchVisualInheritance, XmtPatchVisualInheritance()(3)
apply a runtime patch to the Shell widget class so that it handles non-default visuals better.
XmtSymbolSetValue, XmtSymbolSetValue(), XmtSymbolGetValue()(3)
set or query the value of a symbol.
XmtVaRegisterSymbols, XmtVaRegisterSymbols(), XmtLookupSymbol()(3)
register a name for application variables, and lookup variables by name.
XpCancelDoc(3, 3Xp)
Cancels a print document.
XpCancelJob(3, 3Xp)
Cancels a single print job.
XpCancelPage(3, 3Xp)
Cancels a print page.
XSetFillStyle, XSetFillRule(3)
GC convenience routines
XSetWMProtocols, XGetWMProtocols(3)
set or read a window's WM_PROTOCOLS property
XtClass, XtCheckSubclass, XtIsApplicationShell, XtIsComposite, XtIsConstraint, XtIsObject, XtIsOverrideShell, XtIsRectObj, XtIsSessionShell, XtIsShell, XtIsSubclass, XtIsTopLevelShell, XtIsTransientShell, XtIsVendorShell, XtIsWidget, XtIsWMShell, XtSuperclass(3)
obtain and verify a widget's class
XtCreateSelectionRequest, XtCancelSelectionRequest, XtSendSelectionRequest(3)
bundle multiple selection conversion requests into a single request using MULTIPLE target
Zenoss::Router(3)
Internal module that does the processing of sending and/or receiving Zenoss API calls
Zenoss::Router::DetailNav(3)
Router to Details navigation for given uid
zgels.f(3)
zgelsd.f(3)
zgelss.f(3)
zgelsx.f(3)
zgelsy.f(3)
zgglse.f(3)
zlals0.f(3)
zlalsa.f(3)
zlalsd.f(3)
cbcrc(4)
Configuration file for Couchbase command line tools
chromebook_platform(4)
support driver for hardware on various Chromebook models
cxgb, if_cxgb(4)
Chelsio T3 10 Gigabit Ethernet adapter driver
cxgbe, cc, cxl, if_cc, if_cxgbe, if_cxl, if_vcc, if_vcxgbe, if_vcxl, vcc, vcxgbe, vcxl(4)
Chelsio T4-, T5-, and T6-based 100Gb, 40Gb, 25Gb, 10Gb, and 1Gb Ethernet adapter driver
cxgbev, ccv, cxlv, if_ccv, if_cxgbev, if_cxlv(4)
Chelsio T4-, T5-, and T6-based 100Gb, 40Gb, 25Gb, 10Gb, and 1Gb Ethernet VF driver
DtDndProtocol(4, special file)
drag and drop matching and transfer protocols
dtrace_ip(4)
a DTrace provider for tracing events related to the IPv4 and IPv6 protocols
hv_utils(4)
Hyper-V Utilities Driver
kue, if_kue(4)
Kawasaki LSI KL5KUSB101B USB Ethernet driver
mac_mls(4)
Multi-Level Security confidentiality policy
mfi, mfi_linux, mfip(4)
LSI MegaRAID SAS driver
MPE_Draw_logic(4)
Sets logical operation for laying down new pixels
MPE_Fill_circle(4)
Fills a circle
MPE_Signals_call_debugger(4)
Process-killing signals invoke the MPE error handler
mpr(4)
LSI Fusion-MPT 3/3.5 IT/IR 12Gb/s Serial Attached SCSI/SATA/PCIe driver
mps(4)
LSI Fusion-MPT 2 IT/IR 6Gb/s Serial Attached SCSI/SATA driver
mpt(4)
LSI Fusion-MPT SCSI/Fibre Channel driver
mrsas(4)
LSI MegaRAID 6Gb/s and 12Gb/s SAS+SATA RAID controller driver
ng_bt3c(4)
Netgraph node type that is also a 3Com Bluetooth PC card driver
ng_h4(4)
Netgraph node type that is also an H4 line discipline
ng_hci(4)
Netgraph node type that is also a Bluetooth Host Controller Interface (HCI) layer
ng_tty(4)
netgraph node type that is also a TTY hook
ng_ubt(4)
Netgraph node type that is also a driver for Bluetooth USB devices
snd_als4000(4)
Avance Logic ALS4000 PCI bridge device driver
sym(4)
NCR/Symbios/LSI Logic 53C8XX PCI SCSI host adapter driver
wfd(4)
ATAPI ?????? ???????? (LS-120 ?????? ????????)
wfd(4)
ATAPI ???????????????? (LS-120 ????????????????)
wsp(4)
Wellspring touchpad driver
beetsconfig(5)
beets configuration file Beets has an extensive configuration system that lets you customize nearly every aspect of its operation. To configure beets, you create a file called config.yaml. The location of the file depend on your platform (type beet config -p to see the path on your system): 0.0 o 2 On Unix-like OSes, write ~/.config/beets/config.yaml. o 2 On Windows, use %APPDATA%\beets\config.yaml. This is usually in a directory like C:\Users\You\AppData\Roaming. o 2 On OS X, you can use either the Unix location or ~/Library/Application Support/beets/config.yaml. 0u You can launch your text editor to create or update your configuration by typing beet config -e. (See the config-cmd command for details.) It is also possible to customize the location of the configuration file and even use multiple layers of configuration. See Configuration Location, below. The config file uses YAML syntax. You can use the full power of YAML, but most configuration options are simple key/value pairs. This means your config file will look like this: 0.0 3.5 option: value another_option: foo bigger_option: key: value foo: bar P 0u 0u In YAML, you will need to use spaces (not tabs!) to indent some lines. If you have questions about more sophisticated syntax, take a look at the YAML documentation. The rest of this page enumerates the dizzying litany of configuration options available in beets. You might also want to see an example. 0.0 o 2 Global Options 2.0 o 2 library o 2 directory o 2 plugins o 2 include o 2 pluginpath o 2 ignore o 2 ignore_hidden o 2 replace o 2 asciify_paths o 2 art_filename o 2 threaded o 2 format_item o 2 format_album o 2 sort_item o 2 sort_album o 2 sort_case_insensitive o 2 original_date o 2 per_disc_numbering o 2 terminal_encoding o 2 clutter o 2 max_filename_length o 2 id3v23 o 2 va_name 0u o 2 UI Options 2.0 o 2 color o 2 colors 0u o 2 Importer Options 2.0 o 2 write o 2 copy o 2 move o 2 link o 2 resume o 2 incremental o 2 quiet_fallback o 2 none_rec_action o 2 timid o 2 log o 2 default_action o 2 languages o 2 detail o 2 group_albums o 2 autotag o 2 duplicate_action 0u o 2 MusicBrainz Options 2.0 o 2 searchlimit 0u o 2 Autotagger Matching Options 2.0 o 2 max_rec o 2 preferred o 2 ignored o 2 required 0u o 2 Path Format Configuration o 2 Configuration Location 2.0 o 2 Environment Variable o 2 Command-Line Option o 2 Default Location 0u o 2 Example 0u
bluetooth.protocols(5)
Bluetooth Protocol Service Multiplexor database
CellServDB(5)
Lists the database server machines in AFS cells
cgioptions.cfg(5)
Command-line parameters for the Xymon CGI tools
deb-symbols(5)
deb-symbols
deb-symbols(5)
Debian's extended shared library information file
deb-symbols(5)
deb-symbols
default.pa(5)
PulseAudio Sound Server Startup Script
dispersion.conf(5)
configuration file for the openstack-swift dispersion tools
dtfilsys(5, file formats)
CDE file system; directory tree structure
euca2ools.ini(5)
configuration for euca2ools
ipmi-config.conf, ipmi-config(5)
IPMI configuration file details
kdc.conf(5)
Kerberos V5 KDC configuration file The kdc.conf file supplements krb5.conf(5) for programs which are typically only used on a KDC, such as the krb5kdc(8) and kadmind(8) daemons and the kdb5_util(8) program. Relations documented here may also be specified in krb5.conf; for the KDC programs mentioned, krb5.conf and kdc.conf will be merged into a single configuration profile. Normally, the kdc.conf file is found in the KDC state directory, /usr/local/var/krb5kdc. You can override the default location by setting the environment variable KRB5_KDC_PROFILE. Please note that you need to restart the KDC daemon for any configuration changes to take effect.
krb.excl(5)
Lists exclusions for mapping kerberos principals to AFS identities
krb5.conf(5)
Kerberos configuration file The krb5.conf file contains Kerberos configuration information, including the locations of KDCs and admin servers for the Kerberos realms of interest, defaults for the current realm and for Kerberos applications, and mappings of hostnames onto Kerberos realms. Normally, you should install your krb5.conf file in the directory /etc. You can override the default location by setting the environment variable KRB5_CONFIG. Multiple colon-separated filenames may be specified in KRB5_CONFIG; all files which are present will be read. Starting in release 1.14, directory names can also be specified in KRB5_CONFIG; all files within the directory whose names consist solely of alphanumeric characters, dashes, or underscores will be read.
logrotate, logrotate.conf(5, 8)
- rotates, compresses, and mails system logs
megarc(5)
Configuration file for megatools
nut.conf(5)
UPS definitions for Network UPS Tools
olsrd.conf(5)
configuration file for olsrd(8)
pkgtools.conf(5)
configuration file for the pkgtools suite
porttools, ~/.porttools(5)
FreeBSD Port Tools configuration file
procmailsc(5)
procmailsc
protocols(5)
??????????????????????????
protocols(5)
protocol name data base
protocols(5)
???????????? ????????????
protocols.cfg(5)
Configuration of TCP network services
pulse-cli-syntax(5)
PulseAudio Command Line Interface Syntax
pulse-client.conf(5)
PulseAudio client configuration file
pulse-daemon.conf(5)
PulseAudio daemon configuration file
sane-artec_eplus48u(5)
SANE backend for the scanner Artec E+ 48U and re-badged models
sane-coolscan(5)
SANE backend for Nikon film-scanners
sane-coolscan2(5)
SANE backend for Nikon Coolscan film scanners
sane-coolscan3(5)
SANE backend for Nikon Coolscan film scanners
sane-pieusb(5)
SANE backend for USB-connected PIE PowerSlide and Reflecta DigitDia/CrystalScan/ProScan slide scanners
shells(5)
shell database
shells(5)
??????????????????
shells(5)
?? ????????????
slapo-valsort(5)
Value Sorting overlay to slapd
srec_fastload(5)
LSI Logic Fast Load file format
srec_wilson(5)
wilson file format
taskdrc(5)
Configuration details for the taskd(1) server
taskrc(5)
Configuration details for the task(1) command
terms(5)
database of blessed terminals for xtermset.
ups.conf(5)
UPS definitions for Network UPS Tools
upsd.conf(5)
Configuration for Network UPS Tools upsd
upsmon.conf(5)
Configuration for Network UPS Tools upsmon
variables(5)
Format of specifying variable names to SNMP tools.
VolserLog(5)
Traces Volume Server operations
vtep, hardware_vtep(5)
hardware_vtep database schema This schema specifies relations that a VTEP can use to integrate physical ports into logical switches maintained by a network virtualization controller such as NSX. Glossary: VTEP VXLAN Tunnel End Point, an entity which originates and/or terminates VXLAN tunnels. HSC Hardware Switch Controller. NVC Network Virtualization Controller, e.g. NSX. VRF Virtual Routing and Forwarding instance.
xpdfrc(5)
configuration file for Xpdf tools (version 3.04)
xymonwebaccess, xymon-webaccess(5)
Web-based access controls in Xymon
yuv4mpeg, YUV4MPEG2(5)
video stream format used by pipe-based MJPEGtools
BadBricks(6)
False bricks, or, why we like Luca
boxed(6)
draws a box full of 3D bouncing balls that explode.
boxfit(6)
fills space with a gradient of growing boxes or circles.
ccurve(6)
self-similar linear fractals.
cgoban(6)
X11 Go Toolset
cual, Cual(6)
Cuyo Animation Language Cual is the main language used to describe the animations in cuyo. Strictly speaking it's the stuff between the << >> brackets in the level description files (xxx.ld). On the other hand this man page aims at being a complete description of how to write levels for cuyo. But it's still under construction. See the file "example.ld" to get an idea of how the rest of the level description works. There's also a bit of example Cual code in "example.ld". And of course, all the existing levels are examples. Note that Cual is probably still very buggy. So if strange things happen and you're sure it's not your fault, tell me (cuyo@karimmi.de).
deluxe(6)
pulsing sequence of stars, circles, and lines.
flame(6)
draw weird cosmic fractals
fluidballs(6)
the physics of bouncing balls.
fun(6)
draw pixels accumulating in clusters
glcells(6)
growing cells graphics hack
glschool(6)
a 3D schooling simulation
glslideshow(6)
slideshow of images using smooth zooming and fades
glsnake(6)
OpenGL enhanced Rubik's Snake cyclewaster.
gtkballs(6, 6x)
A simple logic game
hals_end(6)
Display HAL's last words on the console
hopalong(6)
draw real plane fractals
julia(6)
draws spinning, animating julia-set fractals
lev_comp(6)
NetHack special levels compiler
lev_comp32, lev_comp(6)
NetHack special levels compiler
lev_comp33, lev_comp(6)
NetHack special levels compiler
lev_comp34, lev_comp(6)
NetHack special levels compiler
lev_comp36, lev_comp(6)
NetHack special levels compiler
memscroller(6)
scrolls a dump of its own RAM across the screen
metaballs, MetaBalls(6)
draws 2D metaballs
number(6)
convert Arabic numerals to English
polyhedra(6)
draws the 80 uniform polyhedra and their duals
ptools-mopt, mopt(6)
multiple constant optimizer
ptools-mts, mts(6)
MARS tournament scheduler
pulsar(6)
intersecting planes, alpha blending, fog, and textures.
retroarch-cg2glsl(6)
Shader converter.
runtime_tools(6, 7)
The Runtime tools Application
sballs(6)
draws balls spinning like crazy in GL
shadebobs(6)
oscillating vapor trails.
sierpinski(6)
draws Sierpinski triangle fractals
slspades(6)
SLang NetSpades client
sol, solscores(6)
Solitaire card game.
squiral(6)
square spirals screensaver
timetunnel(6)
Plasma tunnels fade in and out
tornado(6)
Klon des original C64 Spiels.
trackballs, /trackballs/(6)
A marble game for Linux that is similiar to the classic arcade game 'Marble Madness'.
unknownpleasures(6)
an animation of the signal from the pulsar PSR B1919+21.
unnethack_lev_comp, lev_comp(6)
NetHack special levels compiler
xjewel(6)
X windows droping jewels game
xrayswarm(6)
swarms with color trails.
alsactl_init(7)
alsa control management - initialization
arch(7)
Architecture-specific details
binutils(7)
GNU Binary Utilities
bugle-error(7)
detect errors in OpenGL calls
bugle-exe(7)
record a compilable log of OpenGL calls made
bugle-showerror(7)
reports errors in OpenGL calls
bugle-stats_calls(7)
gather call frequency count
bugle-trace(7)
record a log of OpenGL calls made
color(7)
representation of pixels and colors
euca2ools(7)
eucalyptus command line client tools
firewall(7)
simple firewalls under FreeBSD
gammu-smsd-tables(7)
description of tables for database backends of gammu-smsd(1) The backends themselves are described in their sections, this document describes general database structure and required tables. More SMS daemons can share single database. If you do not specify PhoneID in their configuration, all are treated equally and you have no guarantee which one sends outgoing message. If you configure PhoneID and use it when inserting message to the outbox table (gammu-smsd-inject does this), each SMS daemon will have separate outbox queue. See also smsd-multi.
gitcredentials(7)
providing usernames and passwords to Git
graphviz(7)
rich set of graph drawing tools
kdeoptions(7)
Allgemeine Befehlszeilenparameter fur alle Anwendungen, die auf den KDE-Bibliotheken basieren.
kf5options(7)
Allgemeine Befehlszeilenparameter fur alle Anwendungen, die auf KDE Frameworks 5 basieren.
ldint(7)
GNU Linker Internals This file documents the internals of the GNU linker ld . It is a collection of miscellaneous information with little form at this point. Mostly, it is a repository into which you can put information about GNU ld as you discover it (or as you design changes to ld ) . This document is distributed under the terms of the GNU Free Documentation License. A copy of the license is included in the section entitled "GNU Free Documentation License".
megatools(7)
Mega.nz command line tools
mk-configure(7)
lightweight replacement for GNU autotools
monkeysphere(7)
ssh and TLS authentication framework using OpenPGP Web of Trust
mosquitto-tls(7)
Configure SSL/TLS support for Mosquitto
nanomsg(7)
scalability protocols library
ncidtools(7)
NCID tools overview
npm-disputes(7)
Handling Module Name Disputes This document describes the steps that you should take to resolve module name disputes with other npm publishers. It also describes special steps you should take about names you think infringe your trademarks. This document is a clarification of the acceptable behavior outlined in the npm Code of Conduct https://www.npmjs.com/policies/conduct, and nothing in this document should be interpreted to contradict any aspect of the npm Code of Conduct.
ocf_heartbeat_Evmsd(7)
Controls clustered EVMS volume management (deprecated)
ocf_heartbeat_LVM(7)
Controls the availability of an LVM Volume Group
ocf_heartbeat_oralsnr(7)
Manages an Oracle TNS listener
oss_audigyls(7)
- Creative Labs CA106 (AudigyLS/SBLive 24bit) driver.
pilot-link(7)
A suite of tools for communicating with Palm handhelds, such as those made by Palm, Handspring, Handera, TRGPro, Sony or other Palm Compatible Handheld PDA device.
po4a(7)
framework to translate documentation and other materials
po4a-runtime(7)
po4a and runtime gettext translation without Autotools
po4a-runtime(7)
Po4a und Laufzeit-Gettext-??bersetzung ohne Autotools
qt5options(7)
Allgemeine Befehlszeilenparameter fur alle Anwendungen, die auf dem Qt-Toolkit basieren.
qtoptions(7)
Allgemeine Befehlszeilenparameter fur alle Anwendungen, die auf dem Qt-Toolkit basieren.
shell-include(7)
a system for handling include files for shells
smlnj(7)
an implementation of the Standard ML language with supporting tools and libraries.
torrus_install_plugin, install_plugin(7)
Installs the Torrus plugin
al175(8)
Driver for Eltek UPS models with AL175 alarm module
alsaconf(8)
configuration tool for the Advanced Linux Sound Architecture
alsaconf(8)
alsaconf
atslogd(8)
ATSlog gives the convenient interface for viewing and analysing calls of various models PBX.
atslogmaster(8)
ATSlog gives the convenient interface for viewing and analysing bells of various models PBX.
backup_addvolset(8)
Creates a new (empty) volume set
backup_delvolset(8)
Deletes one or more volume sets from the Backup Database
backup_listvolsets(8)
Lists volume set entries from the Backup Database
backup_setexp(8)
Sets the expiration date for existing dump levels.
backup_volsetrestore(8)
Restores all volumes in a volume set
bls(8)
Bareos's 'Volume LS'
bos_addhost(8)
Adds a database server machine to the CellServDB file
bos_install(8)
Installs a new version of a binary file
bos_listhosts(8)
Displays the contents of the CellServDB file
bos_removehost(8)
Removes a database server machine from the CellServDB file
bos_setcellname(8)
Sets the cell's name in ThisCell and CellServDB
bsnmp-jails(8)
an SNMP module provides statistics regarding FreeBSD jails running on the system.
bwping(8)
and bwping6 are tools to measure bandwidth and response times between two hosts using Internet Control Message Protocol (ICMP) echo request/echo reply mechanism. bwping deals with IPv4 networks, while bwping6 - with IPv6 networks.
bwping6, bwping(8)
and bwping6 are tools to measure bandwidth and response times between two hosts using Internet Control Message Protocol (ICMP) echo request/echo reply mechanism. bwping deals with IPv4 networks, while bwping6 - with IPv6 networks.
calendarserver_manage_principals(8)
Calendar Server principal management utility
calendarserver_purge_principals(8)
Calendar Server deprovisioned user clean-up utility
cbsd(8)
FreeBSD jail management tools
ceph-clsinfo(8)
show class object information
chef-client(8)
The man page for the chef-client command line tool. A chef-client is an agent that runs locally on every node that is registered with the Chef server. When a chef-client is run, it will perform all of the steps that are required to bring the node into the expected state, including: 0.0 o 2 Registering and authenticating the node with the Chef server o 2 Building the node object o 2 Synchronizing cookbooks o 2 Compiling the resource collection by loading each of the required cookbooks, including recipes, attributes, and all other dependencies o 2 Taking the appropriate and required actions to configure the node o 2 Looking for exceptions and notifications, handling each as required 0u NOTE: 0.0 3.5 The chef-client executable can be run as a daemon. 0u 0u The chef-client executable is run as a command-line tool. NOTE: 0.0 3.5 A client.rb file is used to specify the configuration details for the chef-client. 0.0 o 2 This file is loaded every time this executable is run o 2 On UNIX- and Linux-based machines, the default location for this file is /etc/chef/client.rb; on Microsoft Windows machines, the default location for this file is C:\chef\client.rb; use the --config option from the command line to change this location o 2 This file is not created by default o 2 When a client.rb file is present in this directory, the settings contained within that file will override the default configuration settings 0u 0u 0u
chef-client(8)
The man page for the chef-client command line tool. A chef-client is an agent that runs locally on every node that is registered with the Chef server. When a chef-client is run, it will perform all of the steps that are required to bring the node into the expected state, including: 0.0 o 2 Registering and authenticating the node with the Chef server o 2 Building the node object o 2 Synchronizing cookbooks o 2 Compiling the resource collection by loading each of the required cookbooks, including recipes, attributes, and all other dependencies o 2 Taking the appropriate and required actions to configure the node o 2 Looking for exceptions and notifications, handling each as required 0u NOTE: 0.0 3.5 The chef-client executable can be run as a daemon. 0u 0u The chef-client executable is run as a command-line tool. NOTE: 0.0 3.5 A client.rb file is used to specify the configuration details for the chef-client. 0.0 o 2 This file is loaded every time this executable is run o 2 On UNIX- and Linux-based machines, the default location for this file is /etc/chef/client.rb; on Microsoft Windows machines, the default location for this file is C:\chef\client.rb; use the --config option from the command line to change this location o 2 This file is not created by default o 2 When a client.rb file is present in this directory, the settings contained within that file will override the default configuration settings 0u 0u 0u
chef-solo(8)
The man page for the chef-solo command line tool. chef-solo is an open source version of the chef-client that allows using cookbooks with nodes without requiring access to a Chef server. chef-solo runs locally and requires that a cookbook (and any of its dependencies) be on the same physical disk as the node. chef-solo is a limited-functionality version of the chef-client and does not support the following: 0.0 o 2 Node data storage o 2 Search indexes o 2 Centralized distribution of cookbooks o 2 A centralized API that interacts with and integrates infrastructure components o 2 Authentication or authorization o 2 Persistent attributes 0u NOTE: 0.0 3.5 chef-solo can be run as a daemon. 0u 0u The chef-solo executable is run as a command-line tool. Options This command has the following syntax: 0.0 3.5 chef-solo OPTION VALUE OPTION VALUE ... P 0u 0u This command has the following options: 0.0 -c CONFIG, --config CONFIG The configuration file to use. -d, --daemonize Use to run the executable as a daemon. This option is only available on machines that run in UNIX or Linux environments. For machines that are running Microsoft Windows that require similar functionality, use the chef-client::service recipe in the chef-client cookbook: http://community.opscode.com/cookbooks/chef-client. This will install a chef-client service under Microsoft Windows using the Windows Service Wrapper. -E ENVIRONMENT_NAME, --environment ENVIRONMENT_NAME The name of the environment. -f, --[no-]fork Use to contain the chef-client run in a secondary process with dedicated RAM. When the chef-client run is complete the RAM will be returned to the master process. This option helps ensure that a chef-client will use a steady amount of RAM over time because the master process will not run recipes. This option will also help prevent memory leaks (such as those that can be introduced by the code contained within a poorly designed cookbook). Use --no-fork to disable running the chef-client in fork node. Default value: --fork. -F FORMAT, --format FORMAT The output format: doc (default) or min. Use doc to print the progress of the chef-client run using full strings that display a summary of updates as they occur. Use min to print the progress of the chef-client run using single characters. A summary of updates is printed at the end of the chef-client run. A dot (.) is printed for events that do not have meaningful status information, such as loading a file or synchronizing a cookbook. For resources, a dot (.) is printed when the resource is up to date, an S is printed when the resource is skipped by not_if or only_if, and a U is printed when the resource is updated. Other formatting options are available when those formatters are configured in the client.rb file using the add_formatter option. --force-formatter Use to show formatter output instead of logger output. --force-logger Use to show logger output instead of formatter output. -g GROUP, --group GROUP The name of the group that owns a process. This is required when starting any executable as a daemon. -h, --help Shows help for the command. -i SECONDS, --interval SECONDS The frequency (in seconds) at which the chef-client runs. -j PATH, --json-attributes PATH The path to a file that contains JSON data. Use this option to override normal attributes set elsewhere. -l LEVEL, --log_level LEVEL The level of logging that will be stored in a log file. -L LOGLOCATION, --logfile c The location in which log file output files will be saved. If this location is set to something other than STDOUT, standard output logging will still be performed (otherwise there would be no output other than to a file). This is recommended when starting any executable as a daemon. --[no-]color Use to view colored output. Default setting: --color. -N NODE_NAME, --node-name NODE_NAME The name of the node. -o RUN_LIST_ITEM, --override-runlist RUN_LIST_ITEM Replace the current run list with the specified items. -r RECIPE_URL, --recipe-url RECIPE_URL The URL location from which a remote cookbook tar.gz will be downloaded. --run-lock-timeout SECONDS The amount of time (in seconds) to wait for a chef-client run to finish. Default value: not set (indefinite). Set to 0 to cause a second chef-client to exit immediately. -s SECONDS, --splay SECONDS A number (in seconds) to add to the interval that is used to determine the frequency of chef-client runs. This number can help prevent server load when there are many clients running at the same time. -u USER, --user USER The user that owns a process. This is required when starting any executable as a daemon. -v, --version The version of the chef-client. -W, --why-run Use to run the executable in why-run mode, which is a type of chef-client run that does everything except modify the system. Use why-run mode to understand why the chef-client makes the decisions that it makes and to learn more about the current and proposed state of the system. 0u Examples 0.0 3.5 $ chef-solo -c ~/solo.rb -j ~/node.json -r http://www.example.com/chef-solo.tar.gz P 0u 0u The tar.gz archived into the file_cache_path, and then extracted to cookbooks_path. 0.0 3.5 $ chef-solo -c ~/solo.rb -j ~/node.json P 0u 0u chef-solo will look in the solo.rb file to determine the directory in which cookbooks are located. 0.0 3.5 $ chef-solo -c ~/solo.rb -j http://www.example.com/node.json -r http://www.example.com/chef-solo.tar.gz P 0u 0u
chef-solo(8)
The man page for the chef-solo command line tool. chef-solo is an open source version of the chef-client that allows using cookbooks with nodes without requiring access to a Chef server. chef-solo runs locally and requires that a cookbook (and any of its dependencies) be on the same physical disk as the node. chef-solo is a limited-functionality version of the chef-client and does not support the following: 0.0 o 2 Node data storage o 2 Search indexes o 2 Centralized distribution of cookbooks o 2 A centralized API that interacts with and integrates infrastructure components o 2 Authentication or authorization o 2 Persistent attributes 0u NOTE: 0.0 3.5 chef-solo can be run as a daemon. 0u 0u The chef-solo executable is run as a command-line tool. Options This command has the following syntax: 0.0 3.5 chef-solo OPTION VALUE OPTION VALUE ... P 0u 0u This command has the following options: 0.0 -c CONFIG, --config CONFIG The configuration file to use. -d, --daemonize Use to run the executable as a daemon. This option is only available on machines that run in UNIX or Linux environments. For machines that are running Microsoft Windows that require similar functionality, use the chef-client::service recipe in the chef-client cookbook: http://community.opscode.com/cookbooks/chef-client. This will install a chef-client service under Microsoft Windows using the Windows Service Wrapper. -E ENVIRONMENT_NAME, --environment ENVIRONMENT_NAME The name of the environment. -f, --[no-]fork Use to contain the chef-client run in a secondary process with dedicated RAM. When the chef-client run is complete the RAM will be returned to the master process. This option helps ensure that a chef-client will use a steady amount of RAM over time because the master process will not run recipes. This option will also help prevent memory leaks (such as those that can be introduced by the code contained within a poorly designed cookbook). Use --no-fork to disable running the chef-client in fork node. Default value: --fork. -F FORMAT, --format FORMAT The output format: doc (default) or min. Use doc to print the progress of the chef-client run using full strings that display a summary of updates as they occur. Use min to print the progress of the chef-client run using single characters. A summary of updates is printed at the end of the chef-client run. A dot (.) is printed for events that do not have meaningful status information, such as loading a file or synchronizing a cookbook. For resources, a dot (.) is printed when the resource is up to date, an S is printed when the resource is skipped by not_if or only_if, and a U is printed when the resource is updated. Other formatting options are available when those formatters are configured in the client.rb file using the add_formatter option. --force-formatter Use to show formatter output instead of logger output. --force-logger Use to show logger output instead of formatter output. -g GROUP, --group GROUP The name of the group that owns a process. This is required when starting any executable as a daemon. -h, --help Shows help for the command. -i SECONDS, --interval SECONDS The frequency (in seconds) at which the chef-client runs. -j PATH, --json-attributes PATH The path to a file that contains JSON data. Use this option to override normal attributes set elsewhere. -l LEVEL, --log_level LEVEL The level of logging that will be stored in a log file. -L LOGLOCATION, --logfile c The location in which log file output files will be saved. If this location is set to something other than STDOUT, standard output logging will still be performed (otherwise there would be no output other than to a file). This is recommended when starting any executable as a daemon. --[no-]color Use to view colored output. Default setting: --color. -N NODE_NAME, --node-name NODE_NAME The name of the node. -o RUN_LIST_ITEM, --override-runlist RUN_LIST_ITEM Replace the current run list with the specified items. -r RECIPE_URL, --recipe-url RECIPE_URL The URL location from which a remote cookbook tar.gz will be downloaded. --run-lock-timeout SECONDS The amount of time (in seconds) to wait for a chef-client run to finish. Default value: not set (indefinite). Set to 0 to cause a second chef-client to exit immediately. -s SECONDS, --splay SECONDS A number (in seconds) to add to the interval that is used to determine the frequency of chef-client runs. This number can help prevent server load when there are many clients running at the same time. -u USER, --user USER The user that owns a process. This is required when starting any executable as a daemon. -v, --version The version of the chef-client. -W, --why-run Use to run the executable in why-run mode, which is a type of chef-client run that does everything except modify the system. Use why-run mode to understand why the chef-client makes the decisions that it makes and to learn more about the current and proposed state of the system. 0u Examples 0.0 3.5 $ chef-solo -c ~/solo.rb -j ~/node.json -r http://www.example.com/chef-solo.tar.gz P 0u 0u The tar.gz archived into the file_cache_path, and then extracted to cookbooks_path. 0.0 3.5 $ chef-solo -c ~/solo.rb -j ~/node.json P 0u 0u chef-solo will look in the solo.rb file to determine the directory in which cookbooks are located. 0.0 3.5 $ chef-solo -c ~/solo.rb -j http://www.example.com/node.json -r http://www.example.com/chef-solo.tar.gz P 0u 0u
ctlstat(8)
CAM Target Layer statistics utility
dahdi_monitor(8)
checks the rx/tx levels of DAHDI channels
davolserver(8)
Initializes the Volume Server component of the dafs process
dbmail-export(8)
export a mailbox from the DBMail mailsystem to mbox format.
dhcdrop(8)
program for searching and suppress false DHCP servers in Ethernet.
everups(8)
Driver for Ever UPS models
filter-monkey(8)
smtpd filter to arbitrary reject mails
foomatic-kitload(8)
installs a data kit into the foomatic database.
fstrace_lslog(8)
Displays information about a log
fstrace_lsset(8)
Reports the status of an event set
fxotune(8)
automatically tune DAHDI FXO channels
getpmac(8)
print process-related MAC labels
greylite(8)
transparent greylisting module for mailservers
hitch, Hitch(8)
high performance TLS proxy
ippool(8)
user interface to the IPFilter pools
jail(8)
manage system jails
jails(8)
lists hostnames of all running jails on the system
jk_lsh(8)
a shell that limits the binaries it will execute
jls(8)
???????? jail ????????????????
jls(8)
list jails
jobcontrol, jobcontrols(8, 8C, 8c)
per-job controls for HylaFAX servers
kcookiejar5(8)
Befehlszeilenschnittstelle zum KDE-HTTP-Cookie-Dienst
lft(8)
display the route packets take to a network host/socket using one of several layer-4 protocols and methods; optionally show heuristic network information in transitu
lircd(8)
LIRC daemon decodes infrared signals and provides them on a Unix domain socket.
lircmd(8)
LIRC mouse daemon translates infrared signals into mouse events
listen1(8)
listen for calls on a network device
loader.4th(8)
loader.conf processing tools
lsmsr(8)
show MSR information for x86 CPUs
lsof(8)
list open files
lspci(8)
list all PCI devices
lsusb(8)
list USB devices
luser(8)
process to control the clueless induhviduals who (mis)use computer systems, peripheral devices and system administrators. Word play on "loser" and "user".
MailScanner, mailscanner(8)
Virus/Spam Scanner for Sendmail, Exim and Postfix
mailsnarf(8)
sniff mail messages in Berkeley mbox format
mailstats(8)
display mail statistics
mailstats(8)
mailstats
mailstats(8)
mailstats
mailstats(8)
display mail statistics
makewhatis(8)
index UNIX manuals
makewhatis(8)
index UNIX manuals
mfiutil(8)
Utility for managing LSI MegaRAID SAS controllers
mgeupsd(8)
- monitor a state of MGE Pulsar UPS connected to RS-232 port.
mpsutil, mprutil(8)
Utility for managing LSI Fusion-MPT 2/3 controllers
mptutil(8)
Utility for managing LSI Fusion-MPT controllers
nepomukservicestub(8)
Embolcall del KDE al voltant dels connectors de servei de Nepomuk.
news2mail(8)
Channel script to gateway news into e-mails
newscacheclean, test(8)
Purge the NewsCache to SpoolSize (newscache.conf parameter).
ntfsls(8)
list directory contents on an NTFS filesystem
ntfsprogs(8)
tools for doing neat things with NTFS
olsrd(8)
Optimized Link State Routing protocol daemon
pathalias, makedb(8)
mail routing tools
pdnsd-ctl(8)
controls pdnsd
pkg-add, pkg add(8)
Registers a package and installs it on the system
puppet-module(8)
Creates, installs and searches for modules on the Puppet Forge.
qjail-howto(8)
Details explaining how to use qjail to build a NON-VIMAGE jail system.
qjail-intro(8)
Introduction to chroot directory tree, jails, and qjail.
qjail-ipv6-testing(8)
Details explaining how to perform testing of ipv6 addresses used in qjail non-vnet and vnet jails.
qjail-vnet-howto(8)
Details explaining how to use qjail to build a VIMAGE vnet jail system.
realsync(8)
realsync
rmextattr, getextattr, lsextattr, setextattr(8)
manipulate extended attributes
rmextattr, getextattr, lsextattr, setextattr(8)
??????????????
rmtsysd(8)
Daemon to execute AFS-specific system calls for remote hosts
sg3_utils(8)
a package of utilities for sending SCSI commands
sg_referrals(8)
send SCSI REPORT REFERRALS command
slstat(8)
?????? ???? IP (SLIP)?? ???? ?????? ????????
slstat(8)
???????????? IP (SLIP) ????????????????????
smbspool_krb5_wrapper(8)
This is a CUPS printing backend which calls smbspool
smp_utils, smp_*(8)
invoke a SAS Serial Management Protocol (SMP) function
sslsvd(8)
SSLv3 TCP/IP service daemon
stlstats(8)
Stallion Technologies ?? ???? ???? ?????? ?????? ???? ?????? ????????
stud(8)
The Scalable TLS Unwrapping Daemon
stunnel(8)
TLS offloading and load-balancing proxy
sudoscript(8)
a system for audited shells with sudo(8) and script(1)
svc(8)
controls services monitored by supervise (8).
titus(8)
totally isolated TLS unwrapping server
tls_prune(8)
Cyrus IMAP documentation Prune expired sessions from the TLS sessions database
tlsmgr(8)
Postfix TLS session cache and PRNG manager
tlsproxy(8)
Postfix TLS proxy
ugidfw(8)
firewall-like access controls for file system objects
update-smart-drivedb(8)
update smartmontools drive database
urlsnarf(8)
sniff HTTP requests in Common Log Format
vfs_acl_tdb(8)
Save NTFS-ACLs in a tdb file
vfs_acl_xattr(8)
Save NTFS-ACLs in Extended Attributes (EAs)
vfs_aio_linux(8)
implement async I/O in Samba vfs using Linux kernel aio calls
vfs_commit(8)
flush dirty data at specified intervals
vfs_gpfs(8)
gpfs specific samba extensions like acls and prealloc
vlserver(8)
Initializes the Volume Location Server
volserver(8)
Initializes the Volume Server component of the fs process
vsys(8)
Make AFS system calls from the command line
webspy(8)
display sniffed URLs in Netscape in real-time
xmotd(8)
message-of-the-day browser for X (and dumb terminals, VT100, etc.)
zkt-ls(8)
list dnskeys
zogftw(8)
Creates redundant backups on encrypted external ZFS pools
zoneminder-zmcamtool.pl, zmcamtool.pl(8)
ZoneMinder tool to import camera controls and presets
zpool(8)
configures ZFS storage pools
BIT_AND, BIT_AND_ATOMIC, BIT_CLR, BIT_CLR_ATOMIC, BIT_CMP, BIT_COPY, BIT_COPY_STORE_REL, BIT_COUNT, BIT_EMPTY, BIT_FFS, BIT_FILL, BIT_ISFULLSET, BIT_ISSET, BIT_NAND, BIT_OR, BIT_OR_ATOMIC, BIT_OVERLAP, BIT_SET, BIT_SET_ATOMIC, BIT_SET_ATOMIC_ACQ, BIT_SETOF, BIT_SUBSET, BIT_ZERO, BITSET_DEFINE, BITSET_FSET, BITSET_T_INITIALIZER, bitset, bitset(9), BIT_AND2, BIT_NAND2, BIT_OR2, BIT_XOR, BIT_XOR2(9)
bitset manipulation macros
CPU_AND, CPU_AND_ATOMIC, CPU_CLR, CPU_CLR_ATOMIC, CPU_CMP, CPU_COPY, CPU_COPY_STORE_REL, CPU_COUNT, CPU_EMPTY, CPU_FFS, CPU_FILL, CPU_ISFULLSET, CPU_ISSET, CPU_NAND, CPU_OR, CPU_OR_ATOMIC, CPU_OVERLAP, CPU_SET, CPU_SET_ATOMIC, CPU_SET_ATOMIC_ACQ, CPU_SETOF, CPU_SUBSET, CPU_ZERO, CPUSET_T_INITIALIZER, CPUSET_FSET, cpuset, cpuset(9)(9)
cpuset manipulation macros
cr_cansee(9)
determine visibility of objects given their user credentials
cr_seeotheruids(9)
determine visibility of objects given their user credentials
ieee80211_regdomain, ieee80211_alloc_countryie, ieee80211_init_channels, ieee80211_sort_channels(9)
802.11 regulatory support
ieee80211_scan, ieee80211_add_scan, ieee80211_bg_scan, ieee80211_cancel_scan, ieee80211_cancel_scan_any, ieee80211_check_scan, ieee80211_check_scan_current, ieee80211_probe_curchan, ieee80211_scan_assoc_fail, ieee80211_scan_done, ieee80211_scan_dump_channels, ieee80211_scan_flush, ieee80211_scan_iterate, ieee80211_scan_next, ieee80211_scan_timeout, ieee80211_scanner_get, ieee80211_scanner_register, ieee80211_scanner_unregister, ieee80211_scanner_unregister_all, ieee80211_start_scan, ieee80211_flush(9)
802.11 scanning support
mbpool, mbp_alloc, mbp_card_free, mbp_count, mbp_create, mbp_destroy, mbp_ext_free, mbp_free, mbp_get, mbp_get_keep, mbp_sync(9)
buffer pools for network interfaces
prison_check(9)
determine if two credentials belong to the same jail
signal, cursig, execsigs, issignal, killproc, pgsigio, postsig, SIG_CONTSIGMASK, SIG_STOPSIGMASK, SIGADDSET, SIGDELSET, sigexit, SIGFILLSET, siginit, SIGISEMPTY, SIGISMEMBER, SIGNOTEMPTY, signotify, SIGPENDING, SIGSETAND, SIGSETEQ, SIGSETNAND, trapsignal, SIGSETCANTMASK, SIGEMPTYSET, SETSETNEQ, SETSETOR, SIGSETNEQ, SIGSETOR, SETEMPTYSET(9)
kernel signal functions
spl, spl0, splbio, splclock, splhigh, splimp, splnet, splsoftclock, splsofttty, splstatclock, spltty, splvm, splx(9)
????????????????????
ucred, crcopy, crdup, cred_update_thread, crfree, crget, crhold, crshared, cru2x, crcopysafe, crsetgroups(9)
functions related to user credentials
vfs_suser(9)
check if credentials have superuser privileges for a mount point
adc(n, nged)
This command controls the angle/distance cursor.
analyze(n, nged)
Displays the rotation and fallback angles, surface area, and plane equation for each face of the ARB specified on the command line. The total surface area, volume, and the length of each edge are also displayed.
anim_hardtrack(n, nged)
make an animation script for the links and/or wheels of a tracked vehicle with rigid axles.
bot_flip(n, nged)
Reverse (i.e. flip) all the facet normals within a BOT primitive.
bot_sync(n, nged)
Synchronizes the normals of all facets within a BOT primitive so they are all in the same direction.
critcl_literals, critcl::literals(n)
CriTcl Utilities: Constant string pools
exists(n, nged)
The exists command evaluates an expression and return 1 if true, zero if false. It serves roughly the same purpose for objects in a BRL-CAD database that the UNIX test command serves for files on a file system, with additional features specific to geometry and minus some of the filesystem specific options of test.
fifo(n)
Create and manipulate u-turn fifo channels
fifo2(n)
Create and manipulate pipe fifo channels
labelvert(n, nged)
Labels the vertices of the indicated objects with their coordinate values in the MGED display window.
ls(n, nged)
The command with no object argument lists the name of every object in the database (in alphabetical order) except for those marked as hidden with the hide command. If the object argument is supplied, only those objects are listed.
manL(xml)
working for Rembrandt --> <effect> <inherits-from>Aircraft/Pond-Racer/Models/Effects/glass/glass</inherits-from> <object-name>vitre</object-name> </effect> <animation> <type>material</type> <object-name>Face</object-name> <object-name>Needle1</object-name> <emission> <factor-prop>/systems/electrical/outputs/instrument-lights</factor-prop> <red> 0.50 </red> <green> 0.25 </green> <blue> 0.25 </blue> </emission> </animation> <animation> <type>rotate</type> <object-name>Needle1</object-name> <property>/engines/engine[0]/mp-osi</property> <interpolation> <entry><ind> 0 </ind><dep> 0 </dep></entry> <entry><ind> 20 </ind><dep> 20 </dep></entry> <entry><ind> 30 </ind><dep> 62 </dep></entry> <entry><ind> 40 </ind><dep> 103 </dep></entry> <entry><ind> 50 </ind><dep> 145 </dep></entry> <entry><ind> 60 </ind><dep> 188 </dep></entry> <entry><ind> 70 </ind><dep> 230 </dep></entry> <entry><ind> 80 </ind><dep> 271 </dep></entry> <entry><ind> 90 </ind><dep> 310 </dep></entry> <entry><ind> 100 </ind><dep> 351 </dep></entry> </interpolation> <axis> <x> -1 </x> <y> 0 </y> <z> 0 </z> </axis> </animation>
manpage(xsl)
xmlns:doc="http://nwalsh.com/xsl/documentation/1.0" xmlns="http://docbook2x.sourceforge.net/xmlns/Man-XML" exclude-result-prefixes="doc" version='1.0' xml:lang="en">
manR(xml)
working for Rembrandt --> <effect> <inherits-from>Aircraft/Pond-Racer/Models/Effects/glass/glass</inherits-from> <object-name>vitre</object-name> </effect> <animation> <type>material</type> <object-name>Face</object-name> <object-name>Needle1</object-name> <emission> <factor-prop>/systems/electrical/outputs/instrument-lights</factor-prop> <red> 0.50 </red> <green> 0.25 </green> <blue> 0.25 </blue> </emission> </animation> <animation> <type>rotate</type> <object-name>Needle1</object-name> <property>/engines/engine[1]/mp-osi</property> <interpolation> <entry><ind> 0 </ind><dep> 0 </dep></entry> <entry><ind> 20 </ind><dep> 20 </dep></entry> <entry><ind> 30 </ind><dep> 62 </dep></entry> <entry><ind> 40 </ind><dep> 103 </dep></entry> <entry><ind> 50 </ind><dep> 145 </dep></entry> <entry><ind> 60 </ind><dep> 188 </dep></entry> <entry><ind> 70 </ind><dep> 230 </dep></entry> <entry><ind> 80 </ind><dep> 271 </dep></entry> <entry><ind> 90 </ind><dep> 310 </dep></entry> <entry><ind> 100 </ind><dep> 351 </dep></entry> </interpolation> <axis> <x> -1 </x> <y> 0 </y> <z> 0 </z> </axis> </animation>
memchan(n)
Create and manipulate memory channels
memchanapi, memchan(n)
C API for creating memory channels
null(n)
Create and manipulate null channels
pcgels, PCGELS(l)
solve overdetermined or underdetermined complex linear systems involving an M-by-N matrix sub( A ) = A(IA:IA+M-1,JA:JA+N-1),
pclahqr, PCLAHQR(l)
i an auxiliary routine used to find the Schur decomposition and or eigenvalues of a matrix already in Hessenberg form from cols ILO to IHI
pclase2, PCLASE2(l)
initialize an M-by-N distributed matrix sub( A ) denoting A(IA:IA+M-1,JA:JA+N-1) to BETA on the diagonal and ALPHA on the offdiagonals
pclaset, PCLASET(l)
initialize an M-by-N distributed matrix sub( A ) denoting A(IA:IA+M-1,JA:JA+N-1) to BETA on the diagonal and ALPHA on the offdiagonals
pdgels, PDGELS(l)
solve overdetermined or underdetermined real linear systems involving an M-by-N matrix sub( A ) = A(IA:IA+M-1,JA:JA+N-1),
pdlahqr, PDLAHQR(l)
i an auxiliary routine used to find the Schur decomposition and or eigenvalues of a matrix already in Hessenberg form from cols ILO to IHI
pdlase2, PDLASE2(l)
initialize an M-by-N distributed matrix sub( A ) denoting A(IA:IA+M-1,JA:JA+N-1) to BETA on the diagonal and ALPHA on the offdiagonals
pdlaset, PDLASET(l)
initialize an M-by-N distributed matrix sub( A ) denoting A(IA:IA+M-1,JA:JA+N-1) to BETA on the diagonal and ALPHA on the offdiagonals
permute(n, nged)
Permutes the vertex labels for the face of an ARB shape that is currently being edited.
psgels, PSGELS(l)
solve overdetermined or underdetermined real linear systems involving an M-by-N matrix sub( A ) = A(IA:IA+M-1,JA:JA+N-1),
pslahqr, PSLAHQR(l)
i an auxiliary routine used to find the Schur decomposition and or eigenvalues of a matrix already in Hessenberg form from cols ILO to IHI
pslase2, PSLASE2(l)
initialize an M-by-N distributed matrix sub( A ) denoting A(IA:IA+M-1,JA:JA+N-1) to BETA on the diagonal and ALPHA on the offdiagonals
pslaset, PSLASET(l)
initialize an M-by-N distributed matrix sub( A ) denoting A(IA:IA+M-1,JA:JA+N-1) to BETA on the diagonal and ALPHA on the offdiagonals
pzgels, PZGELS(l)
solve overdetermined or underdetermined complex linear systems involving an M-by-N matrix sub( A ) = A(IA:IA+M-1,JA:JA+N-1),
pzlahqr, PZLAHQR(l)
i an auxiliary routine used to find the Schur decomposition and or eigenvalues of a matrix already in Hessenberg form from cols ILO to IHI
pzlase2, PZLASE2(l)
initialize an M-by-N distributed matrix sub( A ) denoting A(IA:IA+M-1,JA:JA+N-1) to BETA on the diagonal and ALPHA on the offdiagonals
pzlaset, PZLASET(l)
initialize an M-by-N distributed matrix sub( A ) denoting A(IA:IA+M-1,JA:JA+N-1) to BETA on the diagonal and ALPHA on the offdiagonals
random(n)
Create and manipulate randomizer channels
shell(n, nged)
Separates the specified NMG shape into its constituent shells.
showmats(n, nged)
Lists the transformation matrices encountered along the specified path and also lists the accumulated matrix at the end of the path.
tclgeomap_procs, circle, fillsegment, grid_list, latitude, latlon, longitude, ocean_list(n)
supplementary procedures for tclgeomap.
tdbc_mapSqlState, tdbc::mapSqlState(n)
Map SQLSTATE to error class
tixUtils(n)
Utility commands in Tix.
tor-rcc(n, nged)
Creates an RCC shape that fills in the hole of a specified TOR.
tpool(n)
Part of the Tcl threading extension implementing pools of worker threads.
unstack(n)
Unstacking channels
vdraw(n, nged)
Allows drawing of lines and polygons (optionally with per vertex normals) in the MGED graphics display. It is used to build a named list of drawing commands for MGED, send the list to the MGED display, modify the list, or delete all or part of the list.
voxelize(n, nged)
Takes as input a primitive or a collection of primitives ,old_obj, and creates a region new_obj which is the collection of voxels(RPPs) approximating the old_obj.
zero(n)
Create and manipulate zero channels
man pages | documentation library | Writing UNIX manpages
Privacy PolicyCookie Policymanpages@manpage.me — 2026-5-14