Skip site navigation (1)Skip section navigation (2)

FreeBSD Manual Pages

  
 
  

home | help
blackhole(4)
a sysctl(8) MIB for manipulating behaviour in respect of refused SCTP, TCP, or UDP connection attempts
buf(9)
kernel buffer I/O scheme used in FreeBSD VM system
clock(3)
determine processor time used
crypto_session(9)
state used for symmetric cryptographic services
elftc(3)
support routines used in the Elftoolchain project
fma(3), fmaf(3), fmal(3)
fused multiply-add
moused(8)
pass mouse data to the console driver
nanobsd.sh(8)
utility used to create a FreeBSD system image suitable for embedded applications
pcap_set_datalink(3)
set the link-layer header type to be used by a capture device
pcap_set_tstamp_type(3)
set the time stamp type to be used by a capture device
pmc_name_of_capability(3), pmc_name_of_class(3), pmc_name_of_cputype(3), pmc_name_of_disposition(3), pmc_name_of_event(3), pmc_name_of_mode(3), pmc_name_of_state(3)
human readable names for numeric constants used by pmc(3) and hwpmc(4)
rc.subr(8)
functions used by system shell scripts
rdma_create_event_channel(3)
Open a channel used to report communication events
what(1)
show what versions of object modules were used to construct a file
xo_set_options(3)
change options used by a libxo handle
CRYPTO_secure_malloc_init(3), CRYPTO_secure_malloc_initialized(3), CRYPTO_secure_malloc_done(3), OPENSSL_secure_malloc(3), CRYPTO_secure_malloc(3), OPENSSL_secure_zalloc(3), CRYPTO_secure_zalloc(3), OPENSSL_secure_free(3), CRYPTO_secure_free(3), OPENSSL_secure_clear_free(3), CRYPTO_secure_clear_free(3), OPENSSL_secure_actual_size(3), CRYPTO_secure_allocated(3), CRYPTO_secure_used(3)
secure heap storage
SSL_CTX_set_session_id_context(3), SSL_set_session_id_context(3)
set context within which session can be reused (server side only)
SSL_SESSION_is_resumable(3)
determine whether an SSL_SESSION object can be used for resumption
SSL_get_peer_tmp_key(3), SSL_get_server_tmp_key(3), SSL_get_tmp_key(3)
get information about temporary keys used during a handshake
SSL_session_reused(3)
query whether a reused session was negotiated during handshake
SSL_set_session(3)
set a TLS/SSL session to be used during TLS/SSL connect
ASDatabaseEntry(1x)
to be used in entry of AfterStep database
AnimateTypes(1x)
animation modes used in the Animate module's config
Asttypes(3o)
Auxiliary AST types used by parsetree and typedtree
BSctx_set_method(3)
Set the iterative method to be used
BSctx_set_pre(3)
The preconditioner to be used by the iterative solver
CRYPTO_secure_malloc_init(3), CRYPTO_secure_malloc_initialized(3), CRYPTO_secure_malloc_done(3), OPENSSL_secure_malloc(3), CRYPTO_secure_malloc(3), OPENSSL_secure_zalloc(3), CRYPTO_secure_zalloc(3), OPENSSL_secure_free(3), CRYPTO_secure_free(3), OPENSSL_secure_clear_free(3), CRYPTO_secure_clear_free(3), OPENSSL_secure_actual_size(3), CRYPTO_secure_allocated(3), CRYPTO_secure_used(3)
secure heap storage
CRYPTO_secure_malloc_init(3ossl), CRYPTO_secure_malloc_initialized(3ossl), CRYPTO_secure_malloc_done(3ossl), OPENSSL_secure_malloc(3ossl), CRYPTO_secure_malloc(3ossl), OPENSSL_secure_zalloc(3ossl), CRYPTO_secure_zalloc(3ossl), OPENSSL_secure_free(3ossl), CRYPTO_secure_free(3ossl), OPENSSL_secure_clear_free(3ossl), CRYPTO_secure_clear_free(3ossl), OPENSSL_secure_actual_size(3ossl), CRYPTO_secure_allocated(3ossl), CRYPTO_secure_used(3ossl)
secure heap storage
CURLINFO_EFFECTIVE_METHOD(3)
get the last used HTTP method
CURLINFO_EFFECTIVE_URL(3)
get the last used URL
CURLINFO_HTTP_VERSION(3)
get the http version used in the connection
CURLINFO_LASTSOCKET(3)
get the last socket used
CURLINFO_PROTOCOL(3)
get the protocol used in the connection
CURLINFO_SCHEME(3)
get the URL scheme (sometimes called protocol) used in the connection
CURLOPT_FRESH_CONNECT(3)
force a new connection to be used
CURLOPT_NETRC(3)
request that .netrc is used
ColorScheme(1x)
defines color values for standard set of internal color names, to be used in other configuration files
DIALOG_PLAYER(3)
Stores GUI data internally used by Allegro
DPMSGetTimeouts(3)
retrieves the timeout values used by the X server for DPMS timings
DPMSSetTimeouts(3)
permits applications to set the timeout values used by the X server for DPMS timings
END_OF_FUNCTION(3)
Locks the code used by a timer. Allegro game programming library
Judy1MemUsed(3), Judy1 functions(3)
C library for creating and accessing a dynamic array of bits, using any value of a word as an index
JudyLMemUsed(3), JudyL functions(3)
C library for creating and accessing a dynamic array of words, using any value of a word as an index
LOCK_FUNCTION(3)
Locks the memory of a function used by a timer. Allegro game programming library
LOCK_VARIABLE(3)
Locks the memory of a variable used by a timer. Allegro game programming library
Location(3o)
Source code locations (ranges of positions), used in parsetree
Longident(3o)
Long identifiers, used in parsetree
MENU_PLAYER(3)
Stores GUI data internally used by Allegro
MPE_CaptureFile(4)
Sets the base filename used to capture output from updates
MPE_GetTags(4)
Returns tags that can be used in communication with a communicator
MPE_Log_get_event_number(4)
Get an unused event number
MPE_Log_get_solo_eventID(4)
Get a single event number to be used to define EVENT drawable through MPE_Describe_event()
MPE_Log_get_state_eventIDs(4)
Get a pair of event numbers to be used to define STATE drawable through MPE_Describe_state()
MPIX_Comm_revoke(3)
Prevent a communicator from being used in the future
MPI_Comm_get_info(3)
Returns a new info object containing the hints of the communicator associated with comm. The current setting of all hints actually used by the system related to this communicator is returned in info_used. If no such hints exist, a handle to a newly created info object is returned that contains no key/value pair. The user is responsible for freeing info_used via MPI_INFO_FREE
MPI_File_get_info(3)
Returns the hints for a file that are actually being used by MPI
MPI_Open_port(3)
Establish an address that can be used to establish connections between groups of MPI processes
MyStyle(1x)
defines combination of color, font, style, background to be used together
NAL_BUFFER_new(2), NAL_BUFFER_free(2), NAL_BUFFER_set_size(2), NAL_BUFFER_empty(2), NAL_BUFFER_full(2), NAL_BUFFER_notempty(2), NAL_BUFFER_notfull(2), NAL_BUFFER_used(2), NAL_BUFFER_unused(2), NAL_BUFFER_data(2), NAL_BUFFER_size(2), NAL_BUFFER_write(2), NAL_BUFFER_read(2), NAL_BUFFER_write_ptr(2), NAL_BUFFER_takedata(2), NAL_BUFFER_wrote(2)
libnal buffer functions
RkCloseRoma(3), RkCloseRoma / RkwCloseRoma(3)
close the dictionary used for Romaji-kana conversion
SDLmm_EventHandler(3), SDLmm::EventHandler(3)
The base class used for custom Event handlers
SDLmm_SRect(3), SDLmm::SRect(3)
This enhanced version of SDL_Rect includes a number of handy short-hand constructors. Since the class is derived from the SDL_Rect struct, it can be used in any context where an SDL_Rect is valid
SDLmm_Surface(3), SDLmm::Surface(3)
A graphical surface structure which is used to store graphical data
SPI_is_cursor_plan(3)
return true if a statement prepared by SPI_prepare can be used with SPI_cursor_open
SSL_CTX_set_session_id_context(3), SSL_set_session_id_context(3)
set context within which session can be reused (server side only)
SSL_CTX_set_session_id_context(3ossl), SSL_set_session_id_context(3ossl)
set context within which session can be reused (server side only)
SSL_SESSION_is_resumable(3)
determine whether an SSL_SESSION object can be used for resumption
SSL_SESSION_is_resumable(3ossl)
determine whether an SSL_SESSION object can be used for resumption
SSL_get_peer_tmp_key(3), SSL_get_server_tmp_key(3), SSL_get_tmp_key(3)
get information about temporary keys used during a handshake
SSL_get_peer_tmp_key(3ossl), SSL_get_server_tmp_key(3ossl), SSL_get_tmp_key(3ossl)
get information about temporary keys used during a handshake
SSL_session_reused(3)
query whether a reused session was negotiated during handshake
SSL_session_reused(3ossl)
query whether a reused session was negotiated during handshake
SSL_set_session(3)
set a TLS/SSL session to be used during TLS/SSL connect
SSL_set_session(3ossl)
set a TLS/SSL session to be used during TLS/SSL connect
Tcl_EventuallyFree.tcl85(3), Tcl_Preserve(3), Tcl_Release(3), Tcl_EventuallyFree(3)
avoid freeing storage while it is being used
Tcl_EventuallyFree.tcl86(3), Tcl_Preserve(3), Tcl_Release(3), Tcl_EventuallyFree(3)
avoid freeing storage while it is being used
Tcl_EventuallyFree.tcl87(3), Tcl_Preserve(3), Tcl_Release(3), Tcl_EventuallyFree(3)
avoid freeing storage while it is being used
Traits(5)
Lists the traits used by the Motif Toolkit. "Traits"
V3D(3)
Fixed point vertex structure used by 3d functions. Allegro game programming library
V3D_f(3)
Floating point vertex structure used by 3d functions. Allegro game programming library
XChangeKeyboardDevice(3)
change which device is used as the X keyboard
XkbFreeClientMap(3)
Free memory used by the client map member of an XkbDescRec structure
XkbFreeControls(3)
Frees memory used by the ctrls member of an XkbDescRec structure
XkbFreeIndicatorMaps(3)
Frees memory used by the indicators member of an XkbDescRec structure
XkbFreeServerMap(3)
Free memory used by the server member of an XkbDescRec structure
XmCommandGetChild(3)
A Command function that is used to access a component "XmCommandGetChild" "Command functions" "XmCommandGetChild"
XmDropDownGetChild(3)
A DropDown function that is used to access a component "XmDropDownGetChild" "DropDown functions" "XmDropDownGetChild"
XmFileSelectionBoxGetChild(3)
A FileSelectionBox function used to access a component "XmFileSelectionBoxGetChild" "FileSelectionBox functions" "XmFileSelectionBoxGetChild"
XmFontListEntryFree(3)
A font list function that recovers memory used by a font list entry "XmFontListEntryFree" "font list functions" "XmFontListEntryFree"
XmFontListFree(3)
A font list function that recovers memory used by a font list "XmFontListFree" "font list functions" "XmFontListFree"
XmGetColorCalculation(3)
A function to get the procedure used for default color calculation "XmGetColorCalculation" "Color functions" "XmGetColorCalculation"
XmGetDestination(3)
A function that returns the widget ID of the widget to be used as the current destination for quick paste and certain clipboard operations "XmGetDestination"
XmMessageBoxGetChild(3)
A MessageBox function that is used to access a component "XmMessageBoxGetChild" "MessageBox functions" "XmMessageBoxGetChild"
XmPrintShell(3)
a shell widget class used for printing in Motif
XmSelectionBoxGetChild(3)
A SelectionBox function that is used to access a component "XmSelectionBoxGetChild" "SelectionBox functions" "XmSelectionBoxGetChild"
XmSetColorCalculation(3)
A function to set the procedure used for default color calculation "XmSetColorCalculation" "Color functions" "XmSetColorCalculation"
XmtLayoutBox(3)
the row or column gadget used within the XmtLayout widget
XmtRegisterUnixProcedures(3), XmtRegisterXtProcedures()(3), XmtRegisterXmtProcedures()(3), XmtRegisterUnixProcedures()(3)
register commonly used procedures with the Xmt callback converter
aa_attrs(3)
returns pointer to the text output buffer used by AA-lib
aa_currentfont(3)
returns specification of the fonts used by AA-lib rendering routines
aa_mousedrivers(3)
NULL terminated array of mouse drivers supported by AA-lib
aa_parseoptions(3)
parse the standard command line options used by AA-lib
aa_setfont(3)
set font specification to be used by rendering functions
aa_setsupported(3)
alter the "supported" field of hardware_params structure used by AA-lib
aa_text(3)
returns pointer to the text output buffer used by AA-lib
advdev(1), device drivers(1)
AdvanceMAME Device Drivers This file describes the video, sound, joystick, mouse and keyboard drivers used by the Advance programs
aespasswd(1)
Used to create and manage an AES keyfile
afOpenFile(3)
open an audio file and create a file handle structure used for subsequent calls to the Audio File Library
afp_signature.conf(5)
Configuration file used by afpd(8) to specify server signature
afp_voluuid.conf(5)
Configuration file used by afpd(8) to specify UUID for Time Machine volume
agedu(1)
correlate disk usage with last-access times to identify large and disused data
al_is_event_queue_paused(3)
Allegro 5 API
allegro_404_char(3)
Character used when Allegro cannot find a glyph
allegro_message(3)
Used mainly to show error messages to users. Allegro game programming library
allocrdsrecwin(3)
allocates a structure used to know windows which contains a rectangle. man1/alc_origin.1
allocrdswinrec(3)
allocates a structure used to create a list of tables of rectangles. man1/alc_origin.1
appl_arguments(3), appl_arguments (3)
Retrieve the (arguments) used with the appl- entrypoint
ares_set_servers_csv(3), ares_set_servers_ports_csv(3)
Set list of DNS servers to be used
argc.tcl86(n), argc(n), argv(n), argv0(n), auto_path(n), env(n), errorCode(n), errorInfo(n), tcl_interactive(n), tcl_library(n), tcl_nonwordchars(n), tcl_patchLevel(n), tcl_pkgPath(n), tcl_platform(n), tcl_precision(n), tcl_rcFileName(n), tcl_traceCompile(n), tcl_traceExec(n), tcl_wordchars(n), tcl_version(n)
Variables used by Tcl
argc.tcl87(n), argc(n), argv(n), argv0(n), auto_path(n), env(n), errorCode(n), errorInfo(n), tcl_interactive(n), tcl_library(n), tcl_nonwordchars(n), tcl_patchLevel(n), tcl_pkgPath(n), tcl_platform(n), tcl_precision(n), tcl_rcFileName(n), tcl_traceCompile(n), tcl_traceExec(n), tcl_wordchars(n), tcl_version(n)
Variables used by Tcl
asimagexml(1x)
XML schema to be used for scripting image manipulation by AfterStep and ascompose libAfterImage/asimagexml
build.xml(5)
configuration file used by ant to build projects
ceylon(1)
The top level Ceylon tool is used to execute other Ceylon tools
cgiFreeList(3)
Frees memory used by a list
ck_epoch_recycle(3)
return an epoch record that may be used by caller
clig_Name(n), ::clig::Name(n)
set the program name to be used in the manual page
cual(6), 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)
current_context_usage(3), current_context_usage (3)
Return how many cells the current context has, and how many of those cells that are currently unused
cxLinkModule(3)
Notifies libcomprex that the module is being used
cxUnlinkModule(3)
Notifies libcomprex that the module is no longer being used
dbmail-timsieved(8)
speaks the Manage Sieve draft protocol, used for managing Sieve scripts for a users email account
dbus-update-activation-environment(1)
update environment used for D-Bus session services
delbddnode(3)
deletes an unused bdd node. man1/alc_origin.1
desktop_palette(3)
The palette used by the Atari ST low resolution desktop. Allegro game programming library
destroy_font(3)
Frees the memory being used by a font structure. Allegro game programming library
destroy_scene(3)
Deallocates the memory used by a scene. Allegro game programming library
djvused(1)
Multi-purpose DjVu document editor
dnstable-encoding(5)
key-value encoding format used by dnstable
doxysearch(1), doxysearch.cgi(1)
search engine used for searching in doxygen documentation
dpath(8)
Diablo program to return commonly used paths for use in shell scripts
dte-syntax(5)
Format of syntax highlighting files used by dte(1)
dterc(5)
Command and configuration language used by dte(1)
extmap.conf(5)
Configuration file used by afpd(8) to specify file name extension mappings
faxstate(8c)
control ``modem state'' of a device used by
fbsetroot(1)
a simple background utility used by the fluxbox(1) window manager, originally written for and by the original blackbox(1) window manager
firestring_conf_free(3)
free memory used by a configuration structure
freecolor(1)
Display amount of free and used memory graphically
freehdl-gennodes(1), FreeHDL-GENNODES(1)
Abstract syntax tree generator used by the VHDL compiler/simulator FreeHDL
geometry.tk86(n), geometry(n), tk_library(n), tk_patchLevel(n), tk_strictMotif(n), tk_version(n)
Variables used or set by Tk
git-annex-addunused(1)
add back unused files
git-annex-dropunused(1)
drop unused file content
git-annex-lookupkey(1)
looks up key used for file
git-annex-rekey(1)
change keys used for files
git-annex-unused(1)
look for unused file content
githooks(5)
Hooks used by Git
gkrellkam-list(5)
format of the list description files used by GKrellKam
glDepthFunc(3), "glDepthFunc(3)
specify the value used for depth buffer comparisons
glPolygonOffset(3), "glPolygonOffset(3)
set the scale and units used to calculate depth values
gl_setfont(3)
set the text font to be used
gui_mg_color(3)
The color used for displaying greyed-out dialog objects. Allegro game programming library
gui_mouse_x(3), gui_mouse_y(3), gui_mouse_z(3), gui_mouse_b(3)
Hook functions used by the GUI routines to access the mouse state. Allegro game programming library
gutenfetch_get_active_server(3)
-- Retrieve the currently active project gutenberg server which will be used to satisfy queries and requests
gutenfetch_get_aussie_server(3)
-- Retrieve the currently active australian project gutenberg server which will be used to satisfy queries and requests which reside only within Australia
gutenfetch_set_active_server(3)
-- This function sets the default Gutenberg server used to satisfy requests. Instead of taking a gutenfetch_server_t * to set the server, it takes a NULL-terminated URL such as "ftp://ibiblio.org/pub/docs/books/gutenberg/". The url should contain a protocol supported by CURL a valid hostname and a directory to the base of the gutenberg texts
gutenfetch_set_active_server_full(3)
-- This function sets the default Gutenberg server used to satisfy requests
gutenfetch_version(3)
-- Get a text string which describes the version of libgutenfetch which is currently being used
htpurge(1)
remove unused odocuments from the database (general maintenance script)
hydra_persist(1)
Internal executable used by Hydra
hydra_pmi_proxy(1)
Internal exectuable used by Hydra
im_bsd(8), BSD input module(8)
syslogd(8) input module used to log BSD kernel messages
im_tcp(8), tcp input module(8)
syslogd(8) input module used to receive from tcp connections
itclvars(i4)
variables used by [incr Tcl]
itclvars(itcl)
variables used by [incr Tcl]
itkvars(n)
variables used by [incr Tk]
ldap_parse_sort_control(3)
Decode the information returned from a search operation that used a server-side sort control
ldap_parse_vlv_control(3)
Decode the information returned from a search operation that used a VLV (virtual list view) control
ldns_algorithm(3)
numbers assigned to algorithms used in dns
libsmbclient(7)
An extension library for browsers and that can be used as a generic browsing API
libsolv-constantids(3)
fixed Ids for often used strings
libxml(3)
library used to parse XML files
libxslt(3)
library used to do XSL transformations on XML documents
lightning-newaddr(7)
Command for generating a new address to be used by c-lightning
list_target_tags(3), list_target_tags (3)
retrieve a list of tags used by tagets
llvm-ranlib90(1), llvm-ranlib(1)
generates an archive index # llvm-ranlib - generates an archive index ## SYNOPSIS llvm-ranlib [options] ## DESCRIPTION llvm-ranlib is an alias for the [llvm-ar](llvm-ar.html) tool that generates an index for an archive. It can be used as a replacement for GNU(aqs ranlib tool. Running llvm-ranlib is equivalent to running llvm-ar s. ## SEE ALSO Refer to [llvm-ar](llvm-ar.html) for additional information
lock_bitmap(3)
Locks the memory used by a bitmap. Allegro game programming library
lock_midi(3)
Locks all the memory used by a MIDI file. Allegro game programming library
lock_sample(3)
Locks all the memory used by a sample. Allegro game programming library
lou_trace(1)
A tool to list all the rules that were used for a Braille translation
lumina-desktop(1)
Binary used to run or communicate with the desktop
lumina-fm(1)
is a utility used for browsing and interacting with files on the system
megadf(1)
Show total available, used, or free space in the cloud
mgettydefs(4)
speed and terminal settings used by mgetty
mh-folders(5)
storage format used by nmh message system
midi_resume(3)
Resumes playback of a paused MIDI file. Allegro game programming library
mimedefang-notify(7)
Conventions used by mimedefang-multiplexor(8) to notify an external program of state changes
mimedefang-protocol(7)
Conventions used by mimedefang(8) to communicate with filter programs
modbus_rtu_set_custom_rts(3)
set a function to be used for custom RTS implementation
mousedrv(4x), mouse(4x)
Xorg mouse input driver
nmblookup(1)
NetBIOS over TCP/IP client used to lookup NetBIOS names
ntfswipe(8)
overwrite unused space on an NTFS volume
numberNodeAllBdd(3)
count the number of nodes used in the BDD system
numberNodeBdd(3)
computes the number of nodes used in a BDD
om_peo(8), peo output module(8)
syslogd(8) output module used to protect log files
om_regex(8), msyslog regex output module(8)
syslogd(8) output module used to filter and redirect logs
om_tcp(8), msyslog tcp(8)
output module syslogd(8) output module used to forward messages to remote hosts through TCP
om_udp(8), msyslog udp(8)
output module syslogd(8) output module used to forward messages to remote hosts through UDP
owstats(1)
Command line application used to parse OWAMP data files
page_keyset(3), page_keysetCertificate store operations(3)
Type of certificates store: "(bu" 2 MEMORY In memory based format. Doesnt support storing. "(bu" 2 FILE FILE supports raw DER certicates and PEM certicates. When PEM is used the file can contain may certificates and match private keys. Support storing the certificates. DER format only supports on certificate and no private key. "(bu" 2 PEM-FILE Same as FILE, defaulting to PEM encoded certificates. "(bu" 2 PEM-FILE Same as FILE, defaulting to DER encoded certificates. "(bu" 2 PKCS11 "(bu" 2 PKCS12 "(bu" 2 DIR "(bu" 2 KEYCHAIN Apple Mac OS X KeyChain backed keychain object. See the library functions here: hx509 certificate store functions
page_name(3), page_namePKIX/X.509 Names(3)
There are several names in PKIX/X.509, GeneralName and Name. A Name consists of an ordered list of Relative Distinguished Names (RDN). Each RDN consists of an unordered list of typed strings. The types are defined by OID and have long and short description. For example id-at-commonName (2.5.4.3) have the long name CommonName and short name CN. The string itself can be of several encoding, UTF8, UTF16, Teltex string, etc. The type limit what encoding should be used. GeneralName is a broader nametype that can contains al kind of stuff like Name, IP addresses, partial Name, etc. Name is mapped into a hx509_name object. Parse and string name into a hx509_name object with hx509_parse_name(), make it back into string representation with hx509_name_to_string(). Name string are defined rfc2253, rfc1779 and X.501. See the library functions here: hx509 name functions
page_peer(3), page_peerHx509 crypto selecting functions(3)
Peer info structures are used togeter with hx509_crypto_select() to select the best avaible crypto algorithm to use. See the library functions here: hx509 certificate selecting functions
panda_closetext(3)
a traversal callback used for closing text streams within the PDF
panda_freeobject(3)
free the memory used by a previously created object
panda_processtrans(3)
a traversal callback used for processing transition objects within the PDF
panda_setlinejoin(3)
is used to set the line join style
pcap_get_required_select_timeout(3)
get a timeout to be used when doing select() for a live capture
pcap_set_datalink(3)
set the link-layer header type to be used by a capture device
pcap_set_tstamp_type(3)
set the time stamp type to be used by a capture device
pcre2_jit_free_unused_memory(3), PCRE2(3)
Perl-compatible regular expressions (revised API)
pdnmesh_input(5), pdnmesh input format(5)
used by pdnmesh, a 2D finite element program
pfsinyuv(1)
Read frames from a single .yuv file used by many video codecs
pfsoutyuv(1)
Write frames to .yuv file used by many video codecs
pfstore(1)
Used to create and manage a pass-phrase store
pfw(1)
print focused window
pi-make-microsoft-freecell-board(6), make_pysol_freecell_board.py(6)
Programs to generate boards to be used as input to Freecell Solver
pkg-repository(5), package repository(5)
format and operation of package repositories used by pkg(8)
popup_dialog(3)
do_dialog() used for popup dialogs. Allegro game programming library
poudriere-jail(8)
manage jails used to build ports
powerline-config(1)
Script used to obtain powerline configuration
pppoe.conf(5)
Configuration file used by pppoe-start(8), pppoe-stop(8), pppoe-status(8) and pppoe-connect(8)
pvm_recvf(3)
Redefines the comparison function used to accept messages
qjail-ipv6-testing(8)
Details explaining how to perform testing of ipv6 addresses used in qjail non-vnet and vnet jails
qnx_get_window(3)
Retrieves a handle to the window used by Allegro
qtchooser(1)
a wrapper used to select between Qt development binary versions
r3d_objects(l), Object(l)
types used by the Raster3D package These are the object descriptor types, and the required parameters, recognized by the render program and other components of the Raster3D package
rabbitmq-env.conf(5)
environment variables used by RabbitMQ server
resume_target(3), resume_target (3)
Request that the targetid resumes from a previously paused state
revpath(1)
generate a relative path that can be used to undo a change-directory
rux(1)
used for reading of files in Cyrillic encoding
sacctmgr(1)
Used to view and modify Slurm account information
save_d(3)
AA-lib driver used to save ascii-art image into file in used specified format
sc-config(1)
The sc-config program is used to obtain information about MPQC's compile time environment
sc-libtool(1)
The sc-libtool program is used to link and build MPQC executables and libraries
sc-mkf77sym(1)
The sc-mkf77sym program is used to generate symbols for linking FORTRAN subroutines into MPQC
sc_BFGSUpdate(3), sc::BFGSUpdate(3)
The DFPUpdate class is used to specify a Broyden, Fletcher, Goldfarb, and Shanno hessian update scheme
sc_ClassDesc(3), sc::ClassDesc(3)
This class is used to contain information about classes
sc_Convergence(3), sc::Convergence(3)
The Convergence class is used by the optimizer to determine when an optimization is converged
sc_DFPUpdate(3), sc::DFPUpdate(3)
The DFPUpdate class is used to specify a Davidson, Fletcher, and Powell hessian update scheme
sc_DistShellPair_SharedData(3), sc::DistShellPair::SharedData(3)
This is used to store data that must be shared between all cooperating shell pairs
sc_ExEnv(3), sc::ExEnv(3)
The ExEnv class is used to find out about how the program is being run
sc_ForceLink(3), sc::ForceLink< T(3), A >(3)
This, together with ForceLinkBase, is used to force code for particular classes to be linked into executables
sc_ForceLinkBase(3), sc::ForceLinkBase< A >(3)
This, together with ForceLink, is used to force code for particular classes to be linked into executables
sc_GaussianBasisSet(3), sc::GaussianBasisSet(3)
The GaussianBasisSet class is used describe a basis set composed of atomic gaussian orbitals
sc_HessianUpdate(3), sc::HessianUpdate(3)
The HessianUpdate abstract class is used to specify a hessian update scheme
sc_Identifier(3), sc::Identifier(3)
Identifier's are used to distinguish and order objects
sc_Int1eCints(3), sc::Int1eCints(3)
Int1eCints is used by OneBodyIntCints and OneBodyDerivIntCints to implement IntegralCints
sc_LineOpt(3), sc::LineOpt(3)
The LineOpt abstract class is used to perform one dimensional optimizations
sc_MolecularCoor(3), sc::MolecularCoor(3)
The MolecularCoor abstract class describes the coordinate system used to describe a molecule
sc_MolecularFormula(3), sc::MolecularFormula(3)
The MolecularFormula class is used to calculate the molecular formula of a Molecule
sc_MolecularFrequencies(3), sc::MolecularFrequencies(3)
The MolecularFrequencies class is used to compute the molecular frequencies and thermodynamic information
sc_NCResult(3), sc::NCResult< T >(3)
This is similar to Result, but can be used with non-class types
sc_PowellUpdate(3), sc::PowellUpdate(3)
The PowellUpdate class is used to specify a Powell hessian update
sc_RegionTimer(3), sc::RegionTimer(3)
The RegionTimer class is used to record the time spent in a section of code
sc_SCDimension(3), sc::SCDimension(3)
The SCDimension class is used to determine the size and blocking of matrices
sc_SCElementOp(3), sc::SCElementOp(3)
Objects of class SCElementOp are used to perform operations on the elements of matrices
sc_SCFormIO(3), sc::SCFormIO(3)
This utility class is used to print only on node 0 and to provide attractive indentation of output
sc_SCMatrixBlockIter(3), sc::SCMatrixBlockIter(3)
The SCMatrixBlockIter class is used to described iterates that loop through the elements in a block
sc_SCMatrixSubblockIter(3), sc::SCMatrixSubblockIter(3)
Objects of class SCMatrixSubblockIter are used to iterate through the blocks of a matrix
sc_SOTransform(3), sc::SOTransform(3)
SOTransform maintains a list of AO shells that are be used to compute the SO
sc_SelfConsistentExtrapolation(3), sc::SelfConsistentExtrapolation(3)
The SelfConsistentExtrapolation abstract class is used to iteratively solve equations requiring a self consistent solution, such as,
sc_StdDenFunctional(3), sc::StdDenFunctional(3)
The StdDenFunctional class is used to construct the standard density functionals
sc_SumIntCoor(3), sc::SumIntCoor(3)
SumIntCoor is used to construct linear combinations of internal coordinates
sc_ThreadLock(3), sc::ThreadLock(3)
The ThreadLock abstract class provides mutex locks to be used in conjunction with ThreadGrp's
sc_Units(3), sc::Units(3)
The Units class is used to perform unit converions
sc_canonical_aaaa(3), sc::canonical_aaaa(3)
If the shell loop structure has 8 fold symmetry, then this should be used as the template argument to GPetite4
sc_canonical_aabb(3), sc::canonical_aabb(3)
If the shell loop structure has 2 fold symmetry between the first two indices and a 2 fold symmetry between the last two indices, then this should be used as the template argument to GPetite4
sc_canonical_aabc(3), sc::canonical_aabc(3)
If the shell loop structure has 2 fold symmetry between the first two indices, then this should be used as the template argument to GPetite4
sc_canonical_abcd(3), sc::canonical_abcd(3)
If the shell loop structure has no symmetry, then this should be used as the template argument to GPetite4
scancel(1)
Used to signal jobs or job steps that are under the control of Slurm
scls(1)
The scls program is used to list objects in checkpoint files
scpr(1)
The scpr program is used to print out objects in checkpoint files
set_projection_viewport(3)
Sets the viewport used to scale the output of persp_project(). Allegro game programming library
seticons(1)
sets the icon images used in Window Maker
sic-alias(5)
format of the alias file used by sic(1)
sic-server(5)
format of the server configuration file used by sic(1)
smime_keys(1)
Utility to add S/MIME certificate to the internal database used by mutt
smime_keys(1)
Utility to add S/MIME certificate to the internal database used by neomutt
source-highlight-settings(1), Source-highlight-settings(1)
utility that can be used to write a configuration file for GNU Source-highlight (and its library)
strigger(1)
Used set, get or clear Slurm trigger information
supportChain_listBdd(3)
returns a chained list of nodes that are used in a given BDD
syndaemon(1)
a program that monitors keyboard activity and disables the touchpad when the keyboard is being used
sysinfo(8)
utility used to gather system configuration information
tags(7)
tagged files used for clustering extensions
tclvars.tcl85(n), tclvars(n)
Variables used by Tcl
tkvars.tk85(n), tkvars(n)
Variables used or set by Tk
tpm2_duplicate(1), tpm2_duplicate(1)(1)
Duplicates a loaded object so that it may be used in a different hierarchy
tracker-miner-fs(1)
Used to crawl the file system to mine data
tracker-miner-rss(1)
Used to populate Tracker with RSS feed data
tracker-writeback(1)
Used to write metadata set in Tracker back to physical files
trickled.conf(5)
format of the configuration file used by trickled(8)
tryto(1)
tries to run a command limited by a timeout or number of tries, can be used to run as svlogd(8) processor
ts_calibrate(1)
A test program to calibrate a touch screen used by tslib
twfiles(5)
overview of files used by Tripwire and file backup process
ufdb_top_urls(1)
retrieve the most frequently used URLs from the log files
unicharset(5)
character properties file used by tesseract(1)
vga_claimvideomemory(3)
declare the amount of video memory used
vga_gettextfont(3), vga_puttextfont(3)
get/set the font used in text mode
vga_gettextmoderegs(3), vga_settextmoderegs(3)
get/set the vga state used in text mode
wndb(5), index.noun(5), data.noun(5), index.verb(5), data.verb(5), index.adj(5), data.adj(5), index.adv(5), data.adv(5)
WordNet database files noun.exc, verb.exc. adj.exc adv.exc - morphology exception lists sentidx.vrb, sents.vrb - files used by search code to display sentences illustrating the use of some specific verbs
wngloss(7)
glossary of terms used in WordNet system
xo_set_options(3)
change options used by a libxo handle
xrestop(1)
monitor server resources used by X11 clients
xymoncgimsg.cgi(8)
CGI utility used for proxying Xymon data over HTTP
yuv4mpeg(5), YUV4MPEG2(5)
video stream format used by pipe-based MJPEGtools libmjpegutils yuv4mpeg.h YUV4MPEG YUV4MPEG2
z80-banks(5), description(5)
of file format used by z80-mon for bank layout
z80-file(5), description(5)
of file format used by z80-asm
z80-keyboard(5), description(5)
of keyboard mapping used by IN on port 0
z80-ports(5), description(5)
of port mapping used by z80-mon for IN and OUT
zerofill(1)
clear unused disk space and blank devices
Ace::Graphics::Fk(3)
A dummy feature object used for generating panel key tracks
Algorithm::Evolutionary::Fitness::Any(3)
Fa├žade for any function so that it can be used as fitness
Algorithm::Evolutionary::Op::LinearFreezer(3)
Used by Simulated Annealing algorithms, reduces temperature lineally
Algorithm::Pair::Best2(3)
select pairings (designed for Go tournaments, but can be used for anything)
Alzabo::Debug(3)
Creates constants used to turn on debugging
Alzabo::Exceptions(3)
Creates all exception subclasses used in Alzabo
AnyEvent::MPRPC::CondVar(3), AnyEvent::MPRPC::Lite::CondVar(3)
Condvar object used in AnyEvent::MPRPC::Lite::Server
AnyEvent::Subprocess::Types(3)
"MooseX::Types" used internally
Apache2::Resource(3)
Limit resources used by httpd children
App::DSC::DataTool::Error(3)
Object used to describe an error
Astro::Catalog::IO::UKIRTBS(3)
Old format used by UKIRT Bright Star catalogues
Audio::MPD::Common::Types(3)
types used in the distribution
Audio::MPD::Types(3)
types used in the distribution
B::Asmdata(3)
Autogenerated data about Perl ops, used to generate bytecode
B::Showlex(3)
Show lexical variables used in functions or files
Biber::Config(3)
Configuration items which need to be saved across the lifetime of a Biber object This class contains a static object and static methods to access configuration and state data. There are several classes of data in here which have separate accessors: * Biber options * Biblatex options * State information used by Biber as it processes entries * displaymode date
Biber::Utils(3)
Various utility subs used in Biber
Bio::Graphics::Util(3)
non-object-oriented utilities used in Bio::Graphics modules "($frame,$offset) = frame_and_offset($pos,$strand,$phase)" 4 Item "($frame,$offset) = frame_and_offset($pos,$strand,$phase)" Calculate the reading frame for a given genomic position, strand and phase. The offset is the offset from $pos to the first nucleotide of the reading frame. In a scalar context, returns the frame only
Bio::MAGETAB::Util::Builder(3)
A storage class used to track Bio::MAGETAB object creation
Bio::MAGETAB::Util::DBLoader(3)
A persistent storage class used to track Bio::MAGETAB object creation and insertion into a relational database
Bio::NEXUS::Tools::NexPlotter(3), nexplot.pl(3)
PostScript plot of tree + data table (from NEXUS infile) =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 -f Specify output file (default: STDOUT) 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 postscriptes 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 $
Bio::Phylo::Parsers::Abstract(3)
Superclass for parsers used by Bio::Phylo::IO
Bio::Phylo::Parsers::Adjacency(3)
Parser used by Bio::Phylo::IO, no serviceable parts inside
Bio::Phylo::Parsers::Cdao(3)
Parser used by Bio::Phylo::IO, no serviceable parts inside
Bio::Phylo::Parsers::Dwca(3)
Parser used by Bio::Phylo::IO, no serviceable parts inside
Bio::Phylo::Parsers::Fasta(3)
Parser used by Bio::Phylo::IO, no serviceable parts inside
Bio::Phylo::Parsers::Fastq(3)
Parser used by Bio::Phylo::IO, no serviceable parts inside
Bio::Phylo::Parsers::Figtree(3)
Parser used by Bio::Phylo::IO, no serviceable parts inside
Bio::Phylo::Parsers::Json(3)
Parser used by Bio::Phylo::IO, no serviceable parts inside
Bio::Phylo::Parsers::Newick(3)
Parser used by Bio::Phylo::IO, no serviceable parts inside
Bio::Phylo::Parsers::Nexml(3)
Parser used by Bio::Phylo::IO, no serviceable parts inside
Bio::Phylo::Parsers::Nexus(3)
Parser used by Bio::Phylo::IO, no serviceable parts inside
Bio::Phylo::Parsers::Nhx(3)
Parser used by Bio::Phylo::IO, no serviceable parts inside
Bio::Phylo::Parsers::Phylip(3)
Parser used by Bio::Phylo::IO, no serviceable parts inside
Bio::Phylo::Parsers::Phyloxml(3)
Parser used by Bio::Phylo::IO, no serviceable parts inside
Bio::Phylo::Parsers::Table(3)
Parser used by Bio::Phylo::IO, no serviceable parts inside
Bio::Phylo::Parsers::Taxlist(3)
Parser used by Bio::Phylo::IO, no serviceable parts inside
Bio::Phylo::Parsers::Tnrs(3)
Parser used by Bio::Phylo::IO, no serviceable parts inside
Bio::Phylo::Parsers::Tolweb(3)
Parser used by Bio::Phylo::IO, no serviceable parts inside
Bio::Phylo::Parsers::Ubiocbmeta(3)
Parser used by Bio::Phylo::IO, no serviceable parts inside
Bio::Phylo::Parsers::Ubiometa(3)
Parser used by Bio::Phylo::IO, no serviceable parts inside
Bio::Phylo::Parsers::Ubiosearch(3)
Parser used by Bio::Phylo::IO, no serviceable parts inside
Bio::Phylo::Treedrawer::Abstract(3)
Abstract graphics writer used by treedrawer, no serviceable parts inside
Bio::Phylo::Treedrawer::Canvas(3)
Graphics format writer used by treedrawer, no serviceable parts inside
Bio::Phylo::Treedrawer::Gif(3)
Graphics format writer used by treedrawer, no serviceable parts inside
Bio::Phylo::Treedrawer::Jpeg(3)
Graphics format writer used by treedrawer, no serviceable parts inside
Bio::Phylo::Treedrawer::Pdf(3)
Graphics format writer used by treedrawer, no serviceable parts inside
Bio::Phylo::Treedrawer::Png(3)
Graphics format writer used by treedrawer, no serviceable parts inside
Bio::Phylo::Treedrawer::Processing(3)
Graphics format writer used by treedrawer, no serviceable parts inside
Bio::Phylo::Treedrawer::Svg(3)
Graphics format writer used by treedrawer, no serviceable parts inside
Bio::Phylo::Treedrawer::Swf(3)
Graphics format writer used by treedrawer, no serviceable parts inside
Bio::Phylo::Unparsers::Abstract(3)
Superclass for unparsers used by Bio::Phylo::IO
Bio::Phylo::Unparsers::Adjacency(3)
Serializer used by Bio::Phylo::IO, no serviceable parts inside
Bio::Phylo::Unparsers::Cdao(3)
Serializer used by Bio::Phylo::IO, no serviceable parts inside
Bio::Phylo::Unparsers::Fasta(3)
Serializer used by Bio::Phylo::IO, no serviceable parts inside
Bio::Phylo::Unparsers::Figtree(3)
Serializer used by Bio::Phylo::IO, no serviceable parts inside
Bio::Phylo::Unparsers::Hennig86(3)
Serializer used by Bio::Phylo::IO, no serviceable parts inside
Bio::Phylo::Unparsers::Html(3)
Serializer used by Bio::Phylo::IO, no serviceable parts inside
Bio::Phylo::Unparsers::Json(3)
Serializer used by Bio::Phylo::IO, no serviceable parts inside
Bio::Phylo::Unparsers::Mrp(3)
Serializer used by Bio::Phylo::IO, no serviceable parts inside
Bio::Phylo::Unparsers::Newick(3)
Serializer used by Bio::Phylo::IO, no serviceable parts inside
Bio::Phylo::Unparsers::Nexml(3)
Serializer used by Bio::Phylo::IO, no serviceable parts inside
Bio::Phylo::Unparsers::Nexus(3)
Serializer used by Bio::Phylo::IO, no serviceable parts inside
Bio::Phylo::Unparsers::Nhx(3)
Serializer used by Bio::Phylo::IO, no serviceable parts inside
Bio::Phylo::Unparsers::Nwmsrdf(3)
Serializer used by Bio::Phylo::IO, no serviceable parts inside
Bio::Phylo::Unparsers::Pagel(3)
Serializer used by Bio::Phylo::IO, no serviceable parts inside
Bio::Phylo::Unparsers::Phylip(3)
Serializer used by Bio::Phylo::IO, no serviceable parts inside
Bio::Phylo::Unparsers::Phyloxml(3)
Serializer used by Bio::Phylo::IO, no serviceable parts inside
Bio::Phylo::Unparsers::Rss1(3)
Serializer used by Bio::Phylo::IO, no serviceable parts inside
Bio::Phylo::Unparsers::Taxlist(3)
Serializer used by Bio::Phylo::IO, no serviceable parts inside
Bio::Search::DatabaseI(3)
Interface for a database used in a sequence search
Bio::Tools::Run::GenericParameters(3)
An object for the parameters used to run programs
Bio::Tools::Run::ParametersI(3)
A Base object for the parameters used to run programs
CGI::ArgChecker(3)
An extensible CGI parameter validation module (allowing commonly used checks on parameters to be called more concisely and consistently)
CGI::Simple::Util(3)
Internal utilities used by CGI::Simple module
CGI::Util(3)
Internal utilities used by CGI module
CPAN::SQLite::Util(3)
export some common data structures used by CPAN::SQLite::*
CSS::Sass::Value(3)
Data Types for custom Sass Functions n .SH "Mapping ""Sass_Values"" to perl data structures" .SH "Mapping Sass_Values to perl data structures" Header "Mapping Sass_Values to perl data structures" You can use maps and lists like normal hash or array references. Lists can have two different separators used for stringification. This is detected by checking if the object is derived from CSS::Sass::Value::List::Space. The default is a comma separated list, which you get by instantiating CSS::Sass::Value::List or CSS::Sass::Value::List::Comma. my $null = CSS::Sass::Value->new(undef); # => null my $number = CSS::Sass::Value->new(42.35); # => 42.35 my $string = CSS::Sass::Value->new("foobar"); # => foobar my $map = CSS::Sass::Value->new({ key => "foobar" }); # key: foobar my $list = CSS::Sass::Value->new([ "foo", 42, "bar" ]); # foo, 42, bar my $space = CSS::Sass::Value::List::Space->new("foo", "bar"); # foo bar my $comma = CSS::Sass::Value::List::Comma->new("foo", "bar"); # foo, bar You can also return these native perl types from custom functions. They will automatically be upgraded to real CSS::Sass::Value objects. All types overload the stringify and eq operators (so far)
Catalyst::Manual::Deployment::DevelopmentServer(3), Catalyst::Manual::DevelopmentServer(3)
Development server deployment The development server is a mini web server written in Perl. However, if you supply the "-f" option to the development server, it will load the higher performance Starman server, which can be used as an application server with a lightweight proxy web server at the front
CatalystX::SimpleLogin(3)
Provide a simple Login controller which can be reused
Child::Link::IPC::Pipe(3)
Base class for link objects used by the Child::IPC::Pipe plugin
Child::Link::IPC::Pipe::Parent(3)
Parent object used by the pipe plugin
Child::Link::IPC::Pipe::Proc(3)
Proc object used by the pipe plugin
Child::Link::Proc(3)
Proc object used by Child
Class::DBI::LazyInflate(3)
Defer Inflating Of Columns Until They Are Used
Convert::Color::XTerm(3), "Convert::Color::XTerm"(3)
indexed colors used by XTerm
Crypt::Misc(3)
miscellaneous functions related to (or used by) CryptX
Crypt::OICQ(3)
cryptographic algorithm used by OICQ protocol
DBIx::Class::Manual::Glossary(3)
Clarification of terms used
DBIx::Class::ResultSet(3)
Represents a query used for fetching a set of results
DBIx::Class::Schema::Loader::Optional::Dependencies(3), $class(3)
Optional module dependency specifications (for module authors) EOC #@@ #@@ SYNOPSIS HEADING #@@ push @chunks, <<"EOC"; =head1 SYNOPSIS Somewhere in your build-file (e.g. ExtUtils::MakeMaker's Makefile.PL): ... e$EUMM_ARGS{CONFIGURE_REQUIRES} = { e%{ e$EUMM_ARGS{CONFIGURE_REQUIRES} || {} }, DBIx::Class::Schema::Loader => $distver, }; ... my %DBIC_CONFIG_AND_ORACLE_DEPS = %{ eval { require $class; $class->req_list_for([qw( dbicdump_config rdbms_oracle )]); } || {} }; e$EUMM_ARGS{PREREQ_PM} = { e%DBIC_CONFIG_AND_ORACLE_DEPS, e%{ e$EUMM_ARGS{PREREQ_PM} || {} }, }; ... ExtUtils::MakeMaker::WriteMakefile(e%EUMM_ARGS); Note: The eval protection within the example is due to support for requirements during the configure build phase not being available on a sufficient portion of production installations of Perl. Robust support for such dependency requirements is available in the CPAN installer only since version 1.94_56 first made available for production with perl version 5.12. It is the belief of the current maintainer that support for requirements during the configure build phase will not be sufficiently ubiquitous until the year 2020 at the earliest, hence the extra care demonstrated above. It should also be noted that some 3rd party installers (e.g. cpanminus) do the right thing with configure requirements independent from the versions of perl and CPAN available. EOC #@@ #@@ DESCRIPTION HEADING #@@ push @chunks, <<'EOC'; =head1 DESCRIPTION Some of the less-frequently used features of DBIx::Class::Schema::Loader have external module dependencies on their own. In order not to burden the average user with modules they will never use, these optional dependencies are not included in the base Makefile.PL. Instead an exception with a descriptive message is thrown when a specific feature can't find one or several modules required for its operation. This module is the central holding place for the current list of such dependencies, for DBIx::Class::Schema::Loader core authors, and DBIx::Class::Schema::Loader extension authors alike. Dependencies are organized in groups where each group can list one or more required modules, with an optional minimum version (or 0 for any version). In addition groups prefixed with test_ can specify a set of environment variables, some (or all) of which are marked as required for the group to be considered by req_list_for Each group name (or a combination thereof) can be used in the public methods as described below. EOC #@@ #@@ REQUIREMENT GROUPLIST HEADING #@@ push @chunks, '=head1 CURRENT REQUIREMENT GROUPS'; my $standalone_info; for my $group (sort keys %$dbic_reqs) { my $info = $standalone_info->{$group} ||= $class->_groups_to_reqs($group); next unless ( $info->{modreqs_fully_documented} and ( $info->{augments} or $info->{modreqs} ) ); my $p = $dbic_reqs->{$group}{pod}; push @chunks, ( "=head2 $p->{title}", "=head3 $group", $p->{desc}, =over, ); if ( keys %{ $info->{modreqs}||{} } ) { push @chunks, map { "=item * $_" . ($info->{modreqs}{$_} ? " >= $info->{modreqs}{$_}" : ) } ( sort keys %{ $info->{modreqs} } ) ; } else { push @chunks, =item * No standalone requirements, } push @chunks, =back; for my $ag ( sort keys %{ $info->{augments} || {} } ) { my $ag_info = $standalone_info->{$ag} ||= $class->_groups_to_reqs($ag); my $newreqs = $class->modreq_list_for([ $group, $ag ]); for (keys %$newreqs) { delete $newreqs->{$_} if ( ( defined $info->{modreqs}{$_} and $info->{modreqs}{$_} == $newreqs->{$_} ) or ( defined $ag_info->{modreqs}{$_} and $ag_info->{modreqs}{$_} == $newreqs->{$_} ) ); } if (keys %$newreqs) { push @chunks, ( "Combined with L</$ag> additionally requires:", =over, ( map { "=item * $_" . ($newreqs->{$_} ? " >= $newreqs->{$_}" : ) } ( sort keys %$newreqs ) ), =back, ); } } } #@@ #@@ API DOCUMENTATION HEADING #@@ push @chunks, <<'EOC';
DBIx::SQLite::Simple::Table(3)
superclass only used to handle SQL tables
DNS::LDNS::GC(3)
Garbage collector, used internally by the DNS::LDNS modules
Dancer2::Core::Role::StandardResponses(3)
Role to provide commonly used responses
DateTime::Format::ISO8601::Types(3)
Types used for parameter checking in DateTime
DateTime::Format::Strptime::Types(3)
Types used for parameter checking in DateTime::Format::Strptime
DateTime::Types(3)
Types used for parameter checking in DateTime
Dist::Zilla::Chrome::Term(3)
chrome used for terminal-based interaction
Dist::Zilla::Chrome::Test(3)
the chrome used by Dist::Zilla::Tester
Dist::Zilla::Role::BuildRunner(3)
something used as a delegating agent during 'dzil run'
Dist::Zilla::Role::TestRunner(3)
something used as a delegating agent to 'dzil test'
DocSet::Doc::Common(3), "DocSet::Doc::Common"(3)
Common functions used in "DocSet::Doc" subclasses
DocSet::Util(3), "DocSet::Util"(3)
Commonly used functions
DtMmdbBookCaseFreeInfo(3)
frees space used by bookcase information structure
DtMmdbFreeGraphicInfo(3)
frees memory used by a graphics info structure
DtMmdbFreeHandle(3)
frees memory used by a DtMmdbHandle
DtMmdbFreeHandleList(3)
frees memory used by a DtMmdbHandle array
Encode::CJKConstants(3), Encode::CJKConstants.pm(3)
-- Internally used by Encode::??::ISO_2022_*
Encode::CN::HZ(3)
-- internally used by Encode::CN
Encode::Config(3)
-- internally used by Encode
Encode::JP::H2Z(3)
-- internally used by Encode::JP::2022_JP*
Encode::JP::JIS7(3)
-- internally used by Encode::JP
Encode::KR::2022_KR(3)
-- internally used by Encode::KR
Encode::MIME::Name(3), Encode::MIME::NAME(3)
-- internally used by Encode
ExtUtils::MM_Unix(3)
methods used by ExtUtils::MakeMaker
ExtUtils::ParseXS::Utilities(3)
Subroutines used with ExtUtils::ParseXS
Fennec::Lite(3)
Minimalist Fennec, the commonly used bits
File::Util::Definitions(3)
Global symbols and constants used in most File::Util classes
Firefox::Marionette::Proxy(3)
Represents a Proxy used by Firefox Capabilities using the Marionette protocol
Font::FreeType::BoundingBox(3)
a structure used to hold an outline's bounding box
Font::TTF::Table(3)
Superclass for tables and used for tables we don't have a class for
Form::Sensible::Field::FileSelector(3)
Field used for file selection
GIS::Distance::Constants(3)
Constants used by formula classes
Games::Bingo::Column(3)
a column class used for generating bingo cards
Games::Bingo::Constants(3)
constants used in the many Games::Bingo modules
Gtk2::ComboBox(3)
A widget used to choose from a list of items
Gtk2::Ex::PodViewer(3)
a Gtk2 widget for displaying Plain old Documentation (POD). NB: This module used to be called Gtk2::PodViewer. That module is now a stub that points to this module
Gtk2::ImageView::Tool(3)
Interface for objects capable of being used as tools by Gtk2::ImageView
HTML::DOM::DocumentFragment(3)
A boring class that's rarely used
HTML::Display::Common(3)
routines common to all HTML::Display subclasses n .SS "_|_PACKAGE_|_->new %ARGS" .SS "_|_PACKAGE_|_->new %ARGS" Subsection "__PACKAGE__->new %ARGS" Creates a new object as a blessed hash. The passed arguments are stored within the hash. If you need to do other things in your constructor, remember to call this constructor as well : package HTML::Display::WhizBang; use parent HTML::Display::Common; sub new { my ($class) = shift; my %args = @_; my $self = $class->SUPER::new(%args); # do stuff $self; }; n .SS "$display->display %ARGS" .SS "$display->display %ARGS" Subsection "$display->display %ARGS" This is the routine used to display the HTML to the user. It takes the following parameters : html => SCALAR containing the HTML file => SCALAR containing the filename of the file to be displayed base => optional base url for the HTML, so that relative links still work location (synonymous to base) Basic usage : Subsection "Basic usage :" my $html = "<html><body><h1>Hello world!</h1></body></html>"; my $browser = HTML::Display->new(); $browser->display( html => $html ); Location parameter : Subsection "Location parameter :" If you fetch a page from a remote site but still want to display it to the user, the location parameter comes in very handy : my $html = <html><body><img src="/images/hp0.gif"></body></html>; my $browser = HTML::Display->new(); # This will display part of the Google logo $browser->display( html => $html, base => http://www.google.com );
HTML::FormHandler::BuildPages(3)
used in Wizard
HTML::FormHandler::Field::Repeatable::Instance(3)
used internally by repeatable fields
HTML::FormHandler::Page(3)
used in Wizard
HTML::FormHandler::Page::Simple(3)
used by Wizard
HTML::FormHandler::Pages(3)
used in Wizard
HTML::FormHandler::Test(3)
provides is_html method used in tests
HTML::FormHandler::TraitFor::Types(3)
types used internally in FormHandler
HTML::Lint::HTML4(3)
-- Rules for HTML 4 as used by HTML::Lint
HTML::Mason::MethodMaker(3)
Used to create simple get & get/set methods in other classes
HTML::Mason::Tools(3)
Function library used internally in Mason
HTML::SuperForm::Field::Checkbox(3)
Checkbox field used by HTML::SuperForm
HTML::SuperForm::Field::CheckboxGroup(3)
CheckboxGroup field used by HTML::SuperForm
HTML::SuperForm::Field::Hidden(3)
Hidden field used by HTML::SuperForm
HTML::SuperForm::Field::Password(3)
Password field used by HTML::SuperForm
HTML::SuperForm::Field::Radio(3)
Radio field used by HTML::SuperForm
HTML::SuperForm::Field::RadioGroup(3)
RadioGroup field used by HTML::SuperForm
HTML::SuperForm::Field::Reset(3)
Reset field used by HTML::SuperForm
HTML::SuperForm::Field::Select(3)
Select field used by HTML::SuperForm
HTML::SuperForm::Field::Submit(3)
Submit field used by HTML::SuperForm
HTML::SuperForm::Field::Text(3)
Text field used by HTML::SuperForm
HTML::SuperForm::Field::Textarea(3)
Textarea field used by HTML::SuperForm
HTTP::WebTest::Utils(3)
Miscellaneous subroutines used by HTTP::WebTest
Image::Compare::Comparator(3)
Base class for comparison methods used by Image::Compare
Image::Math::Constrain(3)
Scaling math used in image size constraining (such as thumbnails)
Imager::Expr(3)
implements expression parsing and compilation for the expression evaluation engine used by Imager::transform2()
Imager::Graph::Horizontal(3), Imager::Graph::Horizontal(3)
A super class for line/bar charts n .IP "add_data_series(e@data, $series_name)" 4 .IP "add_data_series(e@data, $series_name)" 4 Item "add_data_series(@data, $series_name)" Add a data series to the graph, of the default type. n .IP "add_bar_data_series(e@data, $series_name)" 4 .IP "add_bar_data_series(e@data, $series_name)" 4 Item "add_bar_data_series(@data, $series_name)" Add a bar data series to the graph. n .IP "add_line_data_series(e@data, $series_name)" 4 .IP "add_line_data_series(e@data, $series_name)" 4 Item "add_line_data_series(@data, $series_name)" Add a line data series to the graph. "set_column_padding($int)" 4 Item "set_column_padding($int)" Sets the number of pixels that should go between columns of data. "set_negative_background($color)" 4 Item "set_negative_background($color)" Sets the background color or fill used below the y axis. "draw()" 4 Item "draw()" Draw the graph "show_vertical_gridlines()" 4 Item "show_vertical_gridlines()" Shows vertical gridlines at the y-tics. Feature: vertical_gridlines "set_vertical_gridline_style(color => ..., style => ...)" 4 Item "set_vertical_gridline_style(color => ..., style => ...)" Set the color and style of the lines drawn for gridlines. Style equivalent: vgrid "show_line_markers()" 4 Item "show_line_markers()" "show_line_markers($value)" 4 Item "show_line_markers($value)" 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 Item "use_automatic_axis()" 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 Item "set_x_tics($count)" Set the number of X tics to use. Their value and position will be determined by the data range
Imager::Test(3)
common functions used in testing Imager
Imager::regmach(3)
documents the register virtual machine used by Imager::transform2()
JMX::Jmx4Perl::Nagios::SingleCheck(3)
A single nagios check This is an package used internally by JMX::Jmx4Perl::Nagios::CheckJmx4Perl. It encapsulates the configuration for single checks, which can be combined to a bulk JMX-Request so only a single server turnaround is used to obtain multiple checks results at once
JQuery::Demo(3)
A module used for the JQuery examples
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::Path::Constants(3)
Constants used in the JSON::Path distribution
Jifty::DBI::Filter::Truncate(3)
Filter used to enforce max_length column trait
Kafka::Internals(3)
Constants and functions used internally
LaTeXML::Global(3), "LaTeXML::Global"(3)
global exports used within LaTeXML, and in Packages
Locale::Msgfmt::Utils(3)
Functions used internally by Locale::Msgfmt
Locale::Msgfmt::mo(3)
class used internally by Locale::Msgfmt
Locale::Msgfmt::po(3)
class used internally by Locale::Msgfmt
Locale::XGettext::Util::Flag(3)
A Flag Specification Used By xgettext
Locale::XGettext::Util::Keyword(3)
A Keyword Used By xgettext
Log::Dispatch::Types(3)
Types used for parameter checking in Log::Dispatch
Log::Dispatch::Vars(3)
Variables used internally by multiple packages
Log::TraceMessages(3)
Perl extension for trace messages used in debugging
MPI_Type_get_contents(3)
Returns information about arguments used in creation of a data type
MPI_Win_get_group(3)
Returns a duplicate of the group of the communicator used to create the window
Mail::Box-Overview(3)
objects used by Mail::Box
Mail::Bulkmail::Object(3)
used to create subclasses for Mail::Bulkmail
Mail::IMAPClient::BodyStructure::Parse(3)
used internally by Mail::IMAPClient::BodyStructure
Mail::IMAPClient::Thread(3)
used internally by Mail::IMAPClient->thread
Mail::LMLM::Object(3)
Warning! This is an internal Mail::LMLM class. It is used as the base class for all LMLM objects
Mail::SpamAssassin::Plugin::Esp(3), Esp(3)
checks ESP abused accounts
Mail::SpamAssassin::Plugin::ReplaceTags(3)
tags for SpamAssassin rules The plugin allows rules to contain regular expression tags to be used in regular expression rules. The tags make it much easier to maintain complicated rules. Warning: This plugin relies on data structures specific to this version of SpamAssassin; it is not guaranteed to work with other versions of SpamAssassin
Marpa::PP::Vocabulary(3)
Standard Parsing Terms as Used within Marpa
Marpa::Parse_Terms(3)
Standard Parsing Terms used in the Marpa Documents
Marpa::XS::Vocabulary(3)
Standard parsing terms as used within Marpa
Math::Expr::Node(3), Math::Expr::Num(3)
A node in the expretion tree, used as superclass only
Math::Symbolic::ExportConstants(3)
Export constants used for Math::Symbolic
MetaCPAN::Client::Request(3)
Object used for making requests to MetaCPAN
ModPerl::BuildMM(3)
-- A "subclass" of ModPerl::MM used for building mod_perl 2.0
Module::CPANTS::Kwalitee::Uses(3)
Checks which modules are used
Module::Dependency::Indexer(3)
creates the databases used by the dependency mapping module
Module::ExtractUse(3)
Find out what modules are used
Module::Used(3)
Find modules loaded by Perl code without running it
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
MooX::Locale::Passthrough(3)
provide API used in translator modules without translating
MooseX::Method::Signatures::Types(3)
(DEPRECATED) Provides common MooseX::Types used by MooseX::Method::Signatures
MooseX::MethodAttributes::Role::Meta::Map(3)
generic role for storing code attributes used by classes and roles with attributes
MooseX::Types::Common(3)
A library of commonly used type constraints
MooseX::Types::Common::Numeric(3)
Commonly used numeric types
MooseX::Types::Common::String(3)
Commonly used string types
Net::Amazon::MechanicalTurk::Command::ListOperations(3)
Lists MechanicalTurk requester operations. Returns a list of method names that may be called against the requester API. This method parses the WSDL used for the MechanicalTurk soap endpoint. This method may fail while attempting to download the WSDL document
Net::Cmd(3)
Network Command class (as used by FTP, SMTP etc)
Net::IPAddress(3)
Functions used to manipulate IP addresses, masks and FQDN's
Net::Packet::Consts(3)
all constants used in Net::Packet framework
Net::Packet::Env(3)
environment object used for frame capture/injection
Net::Packet::Utils(3)
useful subroutines used in Net::Packet
Net::SIP::Util(3)
utility functions used by all of Net::SIP
Net::YAP(3)
Module used as a conduit to communicate with the Yahoo! Application Platform
Net::Z3950::GRS1(3), Net::Z3950::Record::GRS1(3)
Perl package used to encode GRS-1 records
Nmap::Scanner::Hostname(3), Header "Name" Hostname(3)
Holds a host's DNS name and the type of DNS record used to get the name (CNAME or PTR)
Nmap::Scanner::OS::PortUsed(3), PortUsed(3)
Port used for OS identification
Ocsinventory::Agent::Common(3)
give common methods to other modules "addController()" 4 Item "addController()" Add a controller in the inventory. "addUsb()" 4 Item "addUsb()" Add external usb devices in the inventory. "addInput()" 4 Item "addInput()" Add internal inputs as keyboard, mouse in the inventory. "addModem()" 4 Item "addModem()" Add a modem in the inventory. "addDrive()" 4 Item "addDrive()" Add a partition in the inventory. "addStorages()" 4 Item "addStorages()" Add a storage system (hard drive, USB key, SAN volume, etc) in the inventory. "addMemory()" 4 Item "addMemory()" Add a memory module in the inventory. "addPort()" 4 Item "addPort()" Add a port module in the inventory. "addSlot()" 4 Item "addSlot()" Add a slot in the inventory. "addSoftware()" 4 Item "addSoftware()" Register a software in the inventory. "addMonitor()" 4 Item "addMonitor()" Add a monitor (screen) in the inventory. "addVideo()" 4 Item "addVideo()" Add a video card in the inventory. "addSound()" 4 Item "addSound()" Add a sound card in the inventory. "addNetwork()" 4 Item "addNetwork()" Register a network in the inventory. "addRepo()" 4 Item "addRepo()" Register a repository in the inventory. "setHardware()" 4 Item "setHardware()" Save global information regarding the machine. The use of setHardware() to update USERID and PROCESSOR* information is deprecated, please, use addUser() and addCPU() instead. "setBios()" 4 Item "setBios()" Set BIOS information. "addCPU()" 4 Item "addCPU()" Add a CPU in the inventory. "addUser()" 4 Item "addUser()" Add an user in the list of logged user. "addLocalUser()" 4 Item "addLocalUser()" Add local users in the inventory. "addLocalGroup()" 4 Item "addLocalGroup()" Add local groups in the inventory. "addPrinter()" 4 Item "addPrinter()" Add a printer in the inventory. "addVirtualMachine()" 4 Item "addVirtualMachine()" Add a Virtual Machine in the inventory. "addProcess()" 4 Item "addProcess()" Record a running process in the inventory. "addCamera()" 4 Item "addCamera()" Add a camera device in the inventory. Only avalaible for MacOSX "addIpDiscoverEntry()" 4 Item "addIpDiscoverEntry()" IpDiscover is used to identify network interface on the local network. This is done on the ARP level. This function adds a network interface in the inventory. "setAccessLog()" 4 Item "setAccessLog()" What is that for? :) "flushXMLTags()" 4 Item "flushXMLTags()" Clear the content of $common->{xmltags} (to use after adding it in XML) "addBatteries()" 4 Item "addBatteries()" Add a memory module in the inventory
OpenXPKI::Server::API2::Plugin::Cert::DateCondition(3)
Used to assemble an SQL WHERE condition regarding dates that assures the strictest date range is used
OpenXPKI::Server::API2::Types(3)
Collection of Moose types used for API command parameters
OpenXPKI::Server::Workflow::Condition::KeyGenerationMode(3)
Check if the profile allows key generation as specified by the "generate" parameter. Example: can_use_server_key: class: OpenXPKI::Server::Workflow::Condition::KeyGenerationMode param: generate: server _map_profile: $cert_profile Returns true if the key generation setting is either escrow, server or both. The setting is obtained for the given profile (by profile or from the default setting) from the node key.generate. If this node is missing, client is allowed and server is assumed ok if key.alg is not empty. If the profile parameter is not given in the configuration, the context value of cert_profile is used
PDF::API3::Compat::API2::Basic::TTF::Table(3)
Superclass for tables and used for tables we don't have a class for
PDF::Builder::Content::Text(3)
additional specialized text-related formatting methods. Inherits from PDF::Builder::Content Note: If you have used some of these methods in PDF::API2 with a graphics type object (e.g., $page->gfx()->method()), you may have to change to a text type object (e.g., $page->text()->method())
PDF::Builder::Util(3)
utility package for often-used methods across the package
POE::Component::Server::SOAP::Response(3)
Emulates a SimpleHTTP::Response object, used to store SOAP data
POE::Component::Server::SimpleHTTP::Response(3)
Emulates a HTTP::Response object, used for SimpleHTTP
POE::Resource::Clock(3)
internal clock used for ordering the queue
PPIx::EditorTools::Lexer(3)
Simple Lexer used for syntax highlighting
Parse::Token(3), "Parse::Token"(3)
Definition of tokens used by "Parse::Lex"
Parse::Trace(3), "Parse::Trace"(3)
Trace functions used by the lexical analyzers
Parse::YYLex(3), "Parse::YYLex"(3)
Version of Parse::Lex to be used by a byacc parser
Paws::IAM::GetAccessKeyLastUsed(3)
Arguments for method GetAccessKeyLastUsed on Paws::IAM
Perl::Critic::Policy::Bangs::ProhibitBitwiseOperators(3)
Bitwise operators are usually accidentally used instead of logical boolean operators
Perl::Critic::Policy::Compatibility::PerlMinimumVersionAndWhy(3)
explicit Perl version for features used
Perl::Critic::Policy::Compatibility::PodMinimumVersion(3)
check Perl version declared against POD features used
Perl::Critic::Policy::Miscellanea::TextDomainUnused(3)
check for Locale::TextDomain imported but unused
Perl::Critic::Policy::RegularExpressions::ProhibitCaptureWithoutTest(3)
Capture variable used outside conditional
Perl::Critic::Policy::RegularExpressions::ProhibitUnusedCapture(3)
Only use a capturing group if you plan to use the captured value
Perl::Critic::Policy::Subroutines::ProhibitUnusedPrivateSubroutines(3)
Prevent unused private subroutines
Perl::Critic::Policy::ValuesAndExpressions::NotWithCompare(3)
logical not used with compare
Perl::Critic::Policy::ValuesAndExpressions::RequireInterpolationOfMetachars(3)
Warns that you might have used single quotes when you really wanted double-quotes
Perl::Critic::Policy::ValuesAndExpressions::UnexpandedSpecialLiteral(3)
specials like _|_PACKAGE_|_ used literally
Perl::Critic::Policy::Variables::ProhibitReusedNames(3)
Do not reuse a variable name in a lexical scope
Perl::Critic::Policy::Variables::ProhibitUnusedVariables(3)
Don't ask for storage you don't need
Perl::Critic::Policy::Variables::RequireNegativeIndices(3)
Negative array index should be used
PerlPoint::Tags::HTML(3)
PerlPoint tag set used by pp2html
PerlPoint::Tags::LaTeX(3)
PerlPoint tag set used by pp2latex
PerlPoint::Tags::SDF(3)
PerlPoint tag set used by pp2sdf
Pod::MinimumVersion(3)
Perl version for POD directives used
Pod::MinimumVersion::Parser(3)
parser used by Pod::MinimumVersion
Pod::POM::Constants(3)
constants used for Pod::POM
Pod::Readme::Types(3)
Types used by Pod::Readme
PostScript::TextBlock(3)
An object that may be used to construct a block of text in PostScript
RDF::Core::Enumerator::DB_File(3)
Enumerator that can be used with DB_File storage
Reaction::Manual::Glossary(3)
Terms and Definitions used in Reaction
SOAP::Trace(3)
used only to manage and manipulate the runtime tracing of execution within the toolkit
SPOPS::Loopback(3)
Simple SPOPS class used for testing rules and other goodies
SPOPS::Manual::Configuration(3)
Description of variables used in the SPOPS configuration process
Search::Elasticsearch::Cxn::Factory(3)
Used by CxnPools to create new Cxn instances
Search::Elasticsearch::Role::Is_Sync(3)
A role to mark classes which should be used with other sync classes
Search::Xapian::InvalidOperationError(3)
InvalidOperationError indicates the API was used in an invalid way
Selenium::Remote::WDKeys(3)
Representation of keystrokes used by Selenium::Remote::WebDriver
Selenium::Remote::WebElement(3)
Representation of an HTML Element used by Selenium Remote Driver
Shared::Examples::Net::Amazon::S3(3)
used for testing and as example
Shared::Examples::Net::Amazon::S3::API(3)
used for testing and as example
Shared::Examples::Net::Amazon::S3::Client(3)
used for testing and as example
Shared::Examples::Net::Amazon::S3::Fixture(3)
used for testing to provide test fixtures
Shared::Examples::Net::Amazon::S3::Request(3)
used for testing and as example
Specio::TypeChecks(3)
Type checks used internally for Specio classes (it's not self-bootstrapping (yet?))
String::Checker(3)
An extensible string validation module (allowing commonly used checks on strings to be called more concisely and consistently)
String::Multibyte::Big5(3)
internally used by String::Multibyte for Big-5
String::Multibyte::Big5Plus(3)
internally used by String::Multibyte for Big-5 Plus
String::Multibyte::Bytes(3)
internally used by String::Multibyte for bytes encoding scheme
String::Multibyte::EUC(3)
internally used by String::Multibyte for simple EUC encodings
String::Multibyte::EUC_JP(3)
internally used by String::Multibyte for EUC-JP
String::Multibyte::EUC_TW(3)
internally used by String::Multibyte for EUC-TW
String::Multibyte::GB18030(3)
internally used by String::Multibyte for GB18030
String::Multibyte::GBK(3)
internally used by String::Multibyte for GBK
String::Multibyte::Grapheme(3)
internally used by String::Multibyte for Default Grapheme Clusters in Unicode
String::Multibyte::Johab(3)
internally used by String::Multibyte for Johab
String::Multibyte::ShiftJIS(3)
internally used by String::Multibyte for Shift-JIS
String::Multibyte::UHC(3)
internally used by String::Multibyte for UHC
String::Multibyte::UTF16BE(3)
internally used by String::Multibyte for UTF-16BE
String::Multibyte::UTF16LE(3)
internally used by String::Multibyte for UTF-16LE
String::Multibyte::UTF32BE(3)
internally used by String::Multibyte for UTF-32BE
String::Multibyte::UTF32LE(3)
internally used by String::Multibyte for UTF-32LE
String::Multibyte::UTF8(3)
internally used by String::Multibyte for UTF-8
String::Multibyte::Unicode(3)
internally used by String::Multibyte for Unicode (Perl's internal format)
String::Strip(3)
Perl extension for fast, commonly used, string operations
Sys::MemInfo(3)
query the total free and used physical memory
Tangram::Springfield(3)
classes and schema used in the Guided Tour
Template::Declare::TagSet(3)
Base class for tag sets used by Template::Declare::Tags
Template::Iterator(3)
Data iterator used by the FOREACH directive
Template::Magic::HTML(3)
HTML handlers for Template::Magic used in a HTML environment
Test2::API::Instance(3)
Object used by Test2::API under the hood
Test2::API::InterceptResult::Hub(3)
Hub used by InterceptResult
Test2::AsyncSubtest::Hub(3)
Hub used by async subtests
Test2::Formatter::Test2(3)
An alternative to TAP, used by Test2::Harness
Test2::Harness::Event(3)
Subclass of Test2::Event used by Test2::Harness under the hood
Test2::Harness::Runner::Spawn(3)
Minimal job class used for spawning processes
Test2::Hub::Interceptor(3)
Hub used by interceptor to grab results
Test2::Hub::Interceptor::Terminator(3)
Exception class used by Test2::Hub::Interceptor
Test2::Hub::Subtest(3)
Hub used by subtests
Test2::Util(3)
Tools used by Test2 and friends
Test2::Util::Grabber(3)
Object used to temporarily intercept all events
Test::Module::Used(3)
Test required module is really used and vice versa bitween lib/t and META.yml
Test::Selenium::Remote::Role::DoesTesting(3), Selenium::Remote::Role::DoesTesting(3)
Role implementing the common logic used for testing
Text::Diff3::Factory(3)
factory for component used by Text::Diff3 modules
Text::Xslate::Symbol(3)
The symbol representation used by parsers and compilers
Time::tm(3)
internal object used by Time::gmtime and Time::localtime
Tk::DragDrop::Common(3)
private class used by Drag&Drop
Tk::ResizeButton(3)
provides a resizeable button to be used in an HList column header
Tk::tkvars(3)
Variables used or set by Tk
Toader::Render::AutoDoc::Cleanup(3)
This is used for cleaning up the output directory prior to rendering
Toader::Render::Directory::Cleanup(3)
This is used for cleaning up the output directory prior to rendering
Toader::Render::Entry::Cleanup(3)
This is used for cleaning up the output directory prior to rendering
Toader::Render::Page::Cleanup(3)
This is used for cleaning up the output directory prior to rendering
ToolSet(3)
Load your commonly-used modules in a single import
Types::TypeTiny(3)
type constraints used internally by Type::Tiny
URI::ParseSearchString(3)
parse search engine referrer URLs and extract keywords used
VCP::ConfigFileUtils(3)
utilities used to parse or create vcp config files
VCP::Patch(3)
Apply the (almost) unified diffs used in RevML
VCP::Utils(3)
utilities used within VCP's modules
W3C::LogValidator(3)
The W3C Log Validator - Quality-focused Web Server log processing engine Checks quality/validity of most popular content on a Web server
WebDAO::Lexer::text(3)
Class used by lexer
WebDAO::SessionSH(3)
Session class used from shell
WebService::GData::Constants(3)
constants (namespaces,format,services...) used for Google data APIs
WebService::GData::YouTube::Constants(3)
constants used for YouTube service
WordNet::Similarity::FrequencyCounter(3)
Support functions for frequency counting programs used to estimate the information content of concepts
WordNet::vectorFile(3)
Provides access to the word vectors database (used by the vector and vector_pairs WordNet::Similarity measures)
XML::CommonNS(3)
A list of commonly used namespaces
XML::DOM::NodeList(3)
A node list as used by XML::DOM
XML::Pastor::Generator(3)
Module used internally by XML::Pastor for generating Perl code from a schema model
XML::Validate::Base(3)
Abstract base class to be used by XML::Validate modules
ZoneMinder::Database(3)
Perl module containing database functions used in ZM
attr(nged)
Used to create, change, retrieve, or view attributes of database objects
autouse(3)
postpone load of modules until a function is used
bk-features(1), bk features(1)
display features used or known
bo(nged)
Used to create or retrieve binary opaque objects
bot_condense(nged)
Used to eliminate unused vertices from a BOT primitive
bot_vertex_fuse(nged)
Used to eliminate duplicate vertices from a BOT solid
certbot(1)
certbot script documentation 0.0 3.5 C usage: certbot [SUBCOMMAND] [options] [-d DOMAIN] [-d DOMAIN] ... Certbot can obtain and install HTTPS/TLS/SSL certificates. By default, it will attempt to use a webserver both for obtaining and installing the certificate. The most common SUBCOMMANDS and flags are: obtain, install, and renew certificates: (default) run Obtain & install a certificate in your current webserver certonly Obtain or renew a certificate, but do not install it renew Renew all previously obtained certificates that are near expiry enhance Add security enhancements to your existing configuration -d DOMAINS Comma-separated list of domains to obtain a certificate for --apache Use the Apache plugin for authentication & installation --standalone Run a standalone webserver for authentication --nginx Use the Nginx plugin for authentication & installation --webroot Place files in a server(aqs webroot folder for authentication --manual Obtain certificates interactively, or using shell script hooks -n Run non-interactively --test-cert Obtain a test certificate from a staging server --dry-run Test "renew" or "certonly" without saving any certificates to disk manage certificates: certificates Display information about certificates you have from Certbot revoke Revoke a certificate (supply --cert-name or --cert-path) delete Delete a certificate (supply --cert-name) manage your account: register Create an ACME account unregister Deactivate an ACME account update_account Update an ACME account --agree-tos Agree to the ACME server(aqs Subscriber Agreement -m EMAIL Email address for important account notifications optional arguments: -h, --help show this help message and exit -c CONFIG_FILE, --config CONFIG_FILE path to config file (default: /etc/letsencrypt/cli.ini and ~/.config/letsencrypt/cli.ini) -v, --verbose This flag can be used multiple times to incrementally increase the verbosity of output, e.g. -vvv. (default: -2) --max-log-backups MAX_LOG_BACKUPS Specifies the maximum number of backup logs that should be kept by Certbot(aqs built in log rotation. Setting this flag to 0 disables log rotation entirely, causing Certbot to always append to the same log file. (default: 1000) -n, --non-interactive, --noninteractive Run without ever asking for user input. This may require additional command line flags; the client will try to explain which ones are required if it finds one missing (default: False) --force-interactive Force Certbot to be interactive even if it detects it(aqs not being run in a terminal. This flag cannot be used with the renew subcommand. (default: False) -d DOMAIN, --domains DOMAIN, --domain DOMAIN Domain names to apply. For multiple domains you can use multiple -d flags or enter a comma separated list of domains as a parameter. The first domain provided will be the subject CN of the certificate, and all domains will be Subject Alternative Names on the certificate. The first domain will also be used in some software user interfaces and as the file paths for the certificate and related material unless otherwise specified or you already have a certificate with the same name. In the case of a name collision it will append a number like 0001 to the file path name. (default: Ask) --eab-kid EAB_KID Key Identifier for External Account Binding (default: None) --eab-hmac-key EAB_HMAC_KEY HMAC key for External Account Binding (default: None) --cert-name CERTNAME Certificate name to apply. This name is used by Certbot for housekeeping and in file paths; it doesn(aqt affect the content of the certificate itself. To see certificate names, run (aqcertbot certificates(aq. When creating a new certificate, specifies the new certificate(aqs name. (default: the first provided domain or the name of an existing certificate on your system for the same domains) --dry-run Perform a test run of the client, obtaining test (invalid) certificates but not saving them to disk. This can currently only be used with the (aqcertonly(aq and (aqrenew(aq subcommands. Note: Although --dry-run tries to avoid making any persistent changes on a system, it is not completely side-effect free: if used with webserver authenticator plugins like apache and nginx, it makes and then reverts temporary config changes in order to obtain test certificates, and reloads webservers to deploy and then roll back those changes. It also calls --pre-hook and --post-hook commands if they are defined because they may be necessary to accurately simulate renewal. --deploy- hook commands are not called. (default: False) --debug-challenges After setting up challenges, wait for user input before submitting to CA (default: False) --preferred-chain PREFERRED_CHAIN If the CA offers multiple certificate chains, prefer the chain whose topmost certificate was issued from this Subject Common Name. If no match, the default offered chain will be used. (default: None) --preferred-challenges PREF_CHALLS A sorted, comma delimited list of the preferred challenge to use during authorization with the most preferred challenge listed first (Eg, "dns" or "http,dns"). Not all plugins support all challenges. See https://certbot.eff.org/docs/using.html#plugins for details. ACME Challenges are versioned, but if you pick "http" rather than "http-01", Certbot will select the latest version automatically. (default: []) --user-agent USER_AGENT Set a custom user agent string for the client. User agent strings allow the CA to collect high level statistics about success rates by OS, plugin and use case, and to know when to deprecate support for past Python versions and flags. If you wish to hide this information from the Let(aqs Encrypt server, set this to "". (default: CertbotACMEClient/1.15.0 (certbot; OS_NAME OS_VERSION) Authenticator/XXX Installer/YYY (SUBCOMMAND; flags: FLAGS) Py/major.minor.patchlevel). The flags encoded in the user agent are: --duplicate, --force-renew, --allow-subset-of-names, -n, and whether any hooks are set. --user-agent-comment USER_AGENT_COMMENT Add a comment to the default user agent string. May be used when repackaging Certbot or calling it from another tool to allow additional statistical data to be collected. Ignored if --user-agent is set. (Example: Foo-Wrapper/1.0) (default: None) automation: Flags for automating execution & other tweaks --keep-until-expiring, --keep, --reinstall If the requested certificate matches an existing certificate, always keep the existing one until it is due for renewal (for the (aqrun(aq subcommand this means reinstall the existing certificate). (default: Ask) --expand If an existing certificate is a strict subset of the requested names, always expand and replace it with the additional names. (default: Ask) --version show program(aqs version number and exit --force-renewal, --renew-by-default If a certificate already exists for the requested domains, renew it now, regardless of whether it is near expiry. (Often --keep-until-expiring is more appropriate). Also implies --expand. (default: False) --renew-with-new-domains If a certificate already exists for the requested certificate name but does not match the requested domains, renew it now, regardless of whether it is near expiry. (default: False) --reuse-key When renewing, use the same private key as the existing certificate. (default: False) --allow-subset-of-names When performing domain validation, do not consider it a failure if authorizations can not be obtained for a strict subset of the requested domains. This may be useful for allowing renewals for multiple domains to succeed even if some domains no longer point at this system. This option cannot be used with --csr. (default: False) --agree-tos Agree to the ACME Subscriber Agreement (default: Ask) --duplicate Allow making a certificate lineage that duplicates an existing one (both can be renewed in parallel) (default: False) -q, --quiet Silence all output except errors. Useful for automation via cron. Implies --non-interactive. (default: False) security: Security parameters & server settings --rsa-key-size N Size of the RSA key. (default: 2048) --key-type {rsa,ecdsa} Type of generated private key(Only *ONE* per invocation can be provided at this time) (default: rsa) --elliptic-curve N The SECG elliptic curve name to use. Please see RFC 8446 for supported values. (default: secp256r1) --must-staple Adds the OCSP Must Staple extension to the certificate. Autoconfigures OCSP Stapling for supported setups (Apache version >= 2.3.3 ). (default: False) --redirect Automatically redirect all HTTP traffic to HTTPS for the newly authenticated vhost. (default: redirect enabled for install and run, disabled for enhance) --no-redirect Do not automatically redirect all HTTP traffic to HTTPS for the newly authenticated vhost. (default: redirect enabled for install and run, disabled for enhance) --hsts Add the Strict-Transport-Security header to every HTTP response. Forcing browser to always use SSL for the domain. Defends against SSL Stripping. (default: None) --uir Add the "Content-Security-Policy: upgrade-insecure- requests" header to every HTTP response. Forcing the browser to use https:// for every http:// resource. (default: None) --staple-ocsp Enables OCSP Stapling. A valid OCSP response is stapled to the certificate that the server offers during TLS. (default: None) --strict-permissions Require that all configuration files are owned by the current user; only needed if your config is somewhere unsafe like /tmp/ (default: False) --auto-hsts Gradually increasing max-age value for HTTP Strict Transport Security security header (default: False) testing: The following flags are meant for testing and integration purposes only. --test-cert, --staging Use the staging server to obtain or revoke test (invalid) certificates; equivalent to --server https://acme-staging-v02.api.letsencrypt.org/directory (default: False) --debug Show tracebacks in case of errors (default: False) --no-verify-ssl Disable verification of the ACME server(aqs certificate. (default: False) --http-01-port HTTP01_PORT Port used in the http-01 challenge. This only affects the port Certbot listens on. A conforming ACME server will still attempt to connect on port 80. (default: 80) --http-01-address HTTP01_ADDRESS The address the server listens to during http-01 challenge. (default: ) --https-port HTTPS_PORT Port used to serve HTTPS. This affects which port Nginx will listen on after a LE certificate is installed. (default: 443) --break-my-certs Be willing to replace or renew valid certificates with invalid (testing/staging) certificates (default: False) paths: Flags for changing execution paths & servers --cert-path CERT_PATH Path to where certificate is saved (with certonly --csr), installed from, or revoked (default: None) --key-path KEY_PATH Path to private key for certificate installation or revocation (if account key is missing) (default: None) --fullchain-path FULLCHAIN_PATH Accompanying path to a full certificate chain (certificate plus chain). (default: None) --chain-path CHAIN_PATH Accompanying path to a certificate chain. (default: None) --config-dir CONFIG_DIR Configuration directory. (default: /etc/letsencrypt) --work-dir WORK_DIR Working directory. (default: /var/lib/letsencrypt) --logs-dir LOGS_DIR Logs directory. (default: /var/log/letsencrypt) --server SERVER ACME Directory Resource URI. (default: https://acme-v02.api.letsencrypt.org/directory) manage: Various subcommands and flags are available for managing your certificates: certificates List certificates managed by Certbot delete Clean up all files related to a certificate renew Renew all certificates (or one specified with --cert- name) revoke Revoke a certificate specified with --cert-path or --cert-name update_symlinks Recreate symlinks in your /etc/letsencrypt/live/ directory run: Options for obtaining & installing certificates certonly: Options for modifying how a certificate is obtained --csr CSR Path to a Certificate Signing Request (CSR) in DER or PEM format. Currently --csr only works with the (aqcertonly(aq subcommand. (default: None) renew: The (aqrenew(aq subcommand will attempt to renew all certificates (or more precisely, certificate lineages) you have previously obtained if they are close to expiry, and print a summary of the results. By default, (aqrenew(aq will reuse the options used to create obtain or most recently successfully renew each certificate lineage. You can try it with (ga--dry-run(ga first. For more fine-grained control, you can renew individual lineages with the (gacertonly(ga subcommand. Hooks are available to run commands before and after renewal; see https://certbot.eff.org/docs/using.html#renewal for more information on these. --pre-hook PRE_HOOK Command to be run in a shell before obtaining any certificates. Intended primarily for renewal, where it can be used to temporarily shut down a webserver that might conflict with the standalone plugin. This will only be called if a certificate is actually to be obtained/renewed. When renewing several certificates that have identical pre-hooks, only the first will be executed. (default: None) --post-hook POST_HOOK Command to be run in a shell after attempting to obtain/renew certificates. Can be used to deploy renewed certificates, or to restart any servers that were stopped by --pre-hook. This is only run if an attempt was made to obtain/renew a certificate. If multiple renewed certificates have identical post- hooks, only one will be run. (default: None) --deploy-hook DEPLOY_HOOK Command to be run in a shell once for each successfully issued certificate. For this command, the shell variable $RENEWED_LINEAGE will point to the config live subdirectory (for example, "/etc/letsencrypt/live/example.com") containing the new certificates and keys; the shell variable $RENEWED_DOMAINS will contain a space-delimited list of renewed certificate domains (for example, "example.com www.example.com" (default: None) --disable-hook-validation Ordinarily the commands specified for --pre- hook/--post-hook/--deploy-hook will be checked for validity, to see if the programs being run are in the $PATH, so that mistakes can be caught early, even when the hooks aren(aqt being run just yet. The validation is rather simplistic and fails if you use more advanced shell constructs, so you can use this switch to disable it. (default: False) --no-directory-hooks Disable running executables found in Certbot(aqs hook directories during renewal. (default: False) --disable-renew-updates Disable automatic updates to your server configuration that would otherwise be done by the selected installer plugin, and triggered when the user executes "certbot renew", regardless of if the certificate is renewed. This setting does not apply to important TLS configuration updates. (default: False) --no-autorenew Disable auto renewal of certificates. (default: True) certificates: List certificates managed by Certbot delete: Options for deleting a certificate revoke: Options for revocation of certificates --reason {unspecified,keycompromise,affiliationchanged,superseded,cessationofoperation} Specify reason for revoking certificate. (default: unspecified) --delete-after-revoke Delete certificates after revoking them, along with all previous and later versions of those certificates. (default: None) --no-delete-after-revoke Do not delete certificates after revoking them. This option should be used with caution because the (aqrenew(aq subcommand will attempt to renew undeleted revoked certificates. (default: None) register: Options for account registration --register-unsafely-without-email Specifying this flag enables registering an account with no email address. This is strongly discouraged, because you will be unable to receive notice about impending expiration or revocation of your certificates or problems with your Certbot installation that will lead to failure to renew. (default: False) -m EMAIL, --email EMAIL Email used for registration and recovery contact. Use comma to register multiple emails, ex: u1@example.com,u2@example.com. (default: Ask). --eff-email Share your e-mail address with EFF (default: None) --no-eff-email Don(aqt share your e-mail address with EFF (default: None) update_account: Options for account modification unregister: Options for account deactivation. --account ACCOUNT_ID Account ID to use (default: None) install: Options for modifying how a certificate is deployed rollback: Options for rolling back server configuration changes --checkpoints N Revert configuration N number of checkpoints. (default: 1) plugins: Options for the "plugins" subcommand --init Initialize plugins. (default: False) --prepare Initialize and prepare plugins. (default: False) --authenticators Limit to authenticator plugins only. (default: None) --installers Limit to installer plugins only. (default: None) update_symlinks: Recreates certificate and key symlinks in /etc/letsencrypt/live, if you changed them by hand or edited a renewal configuration file enhance: Helps to harden the TLS configuration by adding security enhancements to already existing configuration. plugins: Plugin Selection: Certbot client supports an extensible plugins architecture. See (aqcertbot plugins(aq for a list of all installed plugins and their names. You can force a particular plugin by setting options provided below. Running --help <plugin_name> will list flags specific to that plugin. --configurator CONFIGURATOR Name of the plugin that is both an authenticator and an installer. Should not be used together with --authenticator or --installer. (default: Ask) -a AUTHENTICATOR, --authenticator AUTHENTICATOR Authenticator plugin name. (default: None) -i INSTALLER, --installer INSTALLER Installer plugin name (also used to find domains). (default: None) --apache Obtain and install certificates using Apache (default: False) --nginx Obtain and install certificates using Nginx (default: False) --standalone Obtain certificates using a "standalone" webserver. (default: False) --manual Provide laborious manual instructions for obtaining a certificate (default: False) --webroot Obtain certificates by placing files in a webroot directory. (default: False) --dns-cloudflare Obtain certificates using a DNS TXT record (if you are using Cloudflare for DNS). (default: False) --dns-cloudxns Obtain certificates using a DNS TXT record (if you are using CloudXNS for DNS). (default: False) --dns-digitalocean Obtain certificates using a DNS TXT record (if you are using DigitalOcean for DNS). (default: False) --dns-dnsimple Obtain certificates using a DNS TXT record (if you are using DNSimple for DNS). (default: False) --dns-dnsmadeeasy Obtain certificates using a DNS TXT record (if you are using DNS Made Easy for DNS). (default: False) --dns-gehirn Obtain certificates using a DNS TXT record (if you are using Gehirn Infrastructure Service for DNS). (default: False) --dns-google Obtain certificates using a DNS TXT record (if you are using Google Cloud DNS). (default: False) --dns-linode Obtain certificates using a DNS TXT record (if you are using Linode for DNS). (default: False) --dns-luadns Obtain certificates using a DNS TXT record (if you are using LuaDNS for DNS). (default: False) --dns-nsone Obtain certificates using a DNS TXT record (if you are using NS1 for DNS). (default: False) --dns-ovh Obtain certificates using a DNS TXT record (if you are using OVH for DNS). (default: False) --dns-rfc2136 Obtain certificates using a DNS TXT record (if you are using BIND for DNS). (default: False) --dns-route53 Obtain certificates using a DNS TXT record (if you are using Route53 for DNS). (default: False) --dns-sakuracloud Obtain certificates using a DNS TXT record (if you are using Sakura Cloud for DNS). (default: False) apache: Apache Web Server plugin (Please note that the default values of the Apache plugin options change depending on the operating system Certbot is run on.) --apache-enmod APACHE_ENMOD Path to the Apache (aqa2enmod(aq binary (default: None) --apache-dismod APACHE_DISMOD Path to the Apache (aqa2dismod(aq binary (default: None) --apache-le-vhost-ext APACHE_LE_VHOST_EXT SSL vhost configuration extension (default: -le- ssl.conf) --apache-server-root APACHE_SERVER_ROOT Apache server root directory (default: /etc/apache2) --apache-vhost-root APACHE_VHOST_ROOT Apache server VirtualHost configuration root (default: None) --apache-logs-root APACHE_LOGS_ROOT Apache server logs directory (default: /var/log/apache2) --apache-challenge-location APACHE_CHALLENGE_LOCATION Directory path for challenge configuration (default: /etc/apache2) --apache-handle-modules APACHE_HANDLE_MODULES Let installer handle enabling required modules for you (Only Ubuntu/Debian currently) (default: False) --apache-handle-sites APACHE_HANDLE_SITES Let installer handle enabling sites for you (Only Ubuntu/Debian currently) (default: False) --apache-ctl APACHE_CTL Full path to Apache control script (default: apache2ctl) --apache-bin APACHE_BIN Full path to apache2/httpd binary (default: None) dns-cloudflare: Obtain certificates using a DNS TXT record (if you are using Cloudflare for DNS). --dns-cloudflare-propagation-seconds DNS_CLOUDFLARE_PROPAGATION_SECONDS The number of seconds to wait for DNS to propagate before asking the ACME server to verify the DNS record. (default: 10) --dns-cloudflare-credentials DNS_CLOUDFLARE_CREDENTIALS Cloudflare credentials INI file. (default: None) dns-cloudxns: Obtain certificates using a DNS TXT record (if you are using CloudXNS for DNS). --dns-cloudxns-propagation-seconds DNS_CLOUDXNS_PROPAGATION_SECONDS The number of seconds to wait for DNS to propagate before asking the ACME server to verify the DNS record. (default: 30) --dns-cloudxns-credentials DNS_CLOUDXNS_CREDENTIALS CloudXNS credentials INI file. (default: None) dns-digitalocean: Obtain certificates using a DNS TXT record (if you are using DigitalOcean for DNS). --dns-digitalocean-propagation-seconds DNS_DIGITALOCEAN_PROPAGATION_SECONDS The number of seconds to wait for DNS to propagate before asking the ACME server to verify the DNS record. (default: 10) --dns-digitalocean-credentials DNS_DIGITALOCEAN_CREDENTIALS DigitalOcean credentials INI file. (default: None) dns-dnsimple: Obtain certificates using a DNS TXT record (if you are using DNSimple for DNS). --dns-dnsimple-propagation-seconds DNS_DNSIMPLE_PROPAGATION_SECONDS The number of seconds to wait for DNS to propagate before asking the ACME server to verify the DNS record. (default: 30) --dns-dnsimple-credentials DNS_DNSIMPLE_CREDENTIALS DNSimple credentials INI file. (default: None) dns-dnsmadeeasy: Obtain certificates using a DNS TXT record (if you are using DNS Made Easy for DNS). --dns-dnsmadeeasy-propagation-seconds DNS_DNSMADEEASY_PROPAGATION_SECONDS The number of seconds to wait for DNS to propagate before asking the ACME server to verify the DNS record. (default: 60) --dns-dnsmadeeasy-credentials DNS_DNSMADEEASY_CREDENTIALS DNS Made Easy credentials INI file. (default: None) dns-gehirn: Obtain certificates using a DNS TXT record (if you are using Gehirn Infrastructure Service for DNS). --dns-gehirn-propagation-seconds DNS_GEHIRN_PROPAGATION_SECONDS The number of seconds to wait for DNS to propagate before asking the ACME server to verify the DNS record. (default: 30) --dns-gehirn-credentials DNS_GEHIRN_CREDENTIALS Gehirn Infrastructure Service credentials file. (default: None) dns-google: Obtain certificates using a DNS TXT record (if you are using Google Cloud DNS for DNS). --dns-google-propagation-seconds DNS_GOOGLE_PROPAGATION_SECONDS The number of seconds to wait for DNS to propagate before asking the ACME server to verify the DNS record. (default: 60) --dns-google-credentials DNS_GOOGLE_CREDENTIALS Path to Google Cloud DNS service account JSON file. (See https://developers.google.com/identity/protocols/ OAuth2ServiceAccount#creatinganaccount forinformation about creating a service account and https://cloud.google.com/dns/access- control#permissions_and_roles for information about therequired permissions.) (default: None) dns-linode: Obtain certificates using a DNS TXT record (if you are using Linode for DNS). --dns-linode-propagation-seconds DNS_LINODE_PROPAGATION_SECONDS The number of seconds to wait for DNS to propagate before asking the ACME server to verify the DNS record. (default: 120) --dns-linode-credentials DNS_LINODE_CREDENTIALS Linode credentials INI file. (default: None) dns-luadns: Obtain certificates using a DNS TXT record (if you are using LuaDNS for DNS). --dns-luadns-propagation-seconds DNS_LUADNS_PROPAGATION_SECONDS The number of seconds to wait for DNS to propagate before asking the ACME server to verify the DNS record. (default: 30) --dns-luadns-credentials DNS_LUADNS_CREDENTIALS LuaDNS credentials INI file. (default: None) dns-nsone: Obtain certificates using a DNS TXT record (if you are using NS1 for DNS). --dns-nsone-propagation-seconds DNS_NSONE_PROPAGATION_SECONDS The number of seconds to wait for DNS to propagate before asking the ACME server to verify the DNS record. (default: 30) --dns-nsone-credentials DNS_NSONE_CREDENTIALS NS1 credentials file. (default: None) dns-ovh: Obtain certificates using a DNS TXT record (if you are using OVH for DNS). --dns-ovh-propagation-seconds DNS_OVH_PROPAGATION_SECONDS The number of seconds to wait for DNS to propagate before asking the ACME server to verify the DNS record. (default: 30) --dns-ovh-credentials DNS_OVH_CREDENTIALS OVH credentials INI file. (default: None) dns-rfc2136: Obtain certificates using a DNS TXT record (if you are using BIND for DNS). --dns-rfc2136-propagation-seconds DNS_RFC2136_PROPAGATION_SECONDS The number of seconds to wait for DNS to propagate before asking the ACME server to verify the DNS record. (default: 60) --dns-rfc2136-credentials DNS_RFC2136_CREDENTIALS RFC 2136 credentials INI file. (default: None) dns-route53: Obtain certificates using a DNS TXT record (if you are using AWS Route53 for DNS). --dns-route53-propagation-seconds DNS_ROUTE53_PROPAGATION_SECONDS The number of seconds to wait for DNS to propagate before asking the ACME server to verify the DNS record. (default: 10) dns-sakuracloud: Obtain certificates using a DNS TXT record (if you are using Sakura Cloud for DNS). --dns-sakuracloud-propagation-seconds DNS_SAKURACLOUD_PROPAGATION_SECONDS The number of seconds to wait for DNS to propagate before asking the ACME server to verify the DNS record. (default: 90) --dns-sakuracloud-credentials DNS_SAKURACLOUD_CREDENTIALS Sakura Cloud credentials file. (default: None) manual: Authenticate through manual configuration or custom shell scripts. When using shell scripts, an authenticator script must be provided. The environment variables available to this script depend on the type of challenge. $CERTBOT_DOMAIN will always contain the domain being authenticated. For HTTP-01 and DNS-01, $CERTBOT_VALIDATION is the validation string, and $CERTBOT_TOKEN is the filename of the resource requested when performing an HTTP-01 challenge. An additional cleanup script can also be provided and can use the additional variable $CERTBOT_AUTH_OUTPUT which contains the stdout output from the auth script. For both authenticator and cleanup script, on HTTP-01 and DNS-01 challenges, $CERTBOT_REMAINING_CHALLENGES will be equal to the number of challenges that remain after the current one, and $CERTBOT_ALL_DOMAINS contains a comma-separated list of all domains that are challenged for the current certificate. --manual-auth-hook MANUAL_AUTH_HOOK Path or command to execute for the authentication script (default: None) --manual-cleanup-hook MANUAL_CLEANUP_HOOK Path or command to execute for the cleanup script (default: None) nginx: Nginx Web Server plugin --nginx-server-root NGINX_SERVER_ROOT Nginx server root directory. (default: /etc/nginx or /usr/local/etc/nginx) --nginx-ctl NGINX_CTL Path to the (aqnginx(aq binary, used for (aqconfigtest(aq and retrieving nginx version number. (default: nginx) --nginx-sleep-seconds NGINX_SLEEP_SECONDS Number of seconds to wait for nginx configuration changes to apply when reloading. (default: 1) null: Null Installer standalone: Spin up a temporary webserver webroot: Place files in webroot directory --webroot-path WEBROOT_PATH, -w WEBROOT_PATH public_html / webroot path. This can be specified multiple times to handle different domains; each domain will have the webroot path that preceded it. For instance: (ga-w /var/www/example -d example.com -d www.example.com -w /var/www/thing -d thing.net -d m.thing.net(ga (default: Ask) --webroot-map WEBROOT_MAP JSON dictionary mapping domains to webroot paths; this implies -d for each entry. You may need to escape this from your shell. E.g.: --webroot-map (aq{"eg1.is,m.eg1.is":"/www/eg1/", "eg2.is":"/www/eg2"}(aq This option is merged with, but takes precedence over, -w / -d entries. At present, if you put webroot-map in a config file, it needs to be on a single line, like: webroot-map = {"example.com":"/var/www"}. (default: {}) P
ct_run(1)
Program used for starting Common Test from the OS command line
db.copy(1), db.copy (1)
Copy a table. Either (cqfrom_table(cq (optionally with (cqwhere(cq) can be used or (cqselect(cq option, but not (cqfrom_table(cq and (cqselect(cq at the same time
debugbu(nged)
Allows the user to set or check the debug flags used by libbu
debuglib(nged)
Allows the user to set or check the debug flags used by librt
driver_entry(3)
The driver-entry structure used by Erlang drivers
erl_docgen(6)
The erl_docgen application is used to produce the OTP documentation
erl_tidy(3)
Tidies and pretty-prints Erlang source code, removing unused functions, updating obsolete constructs and function calls, etc
eunit_surefire(3)
Surefire reports for EUnit (Format used by Maven and Atlassian Bamboo for example to integrate test results)
fish-completions(1)
Writing fish completions To specify a completion, use the complete command. complete takes as a parameter the name of the command to specify a completion for. For example, to add a completion for the program myprog, one would start the completion command with complete -c myprog ... To provide a list of possible completions for myprog, use the -a switch. If myprog accepts the arguments start and stop, this can be specified as complete -c myprog -a (aqstart stop(aq. The argument to the -a switch is always a single string. At completion time, it will be tokenized on spaces and tabs, and variable expansion, command substitution and other forms of parameter expansion will take place. fish has a special syntax to support specifying switches accepted by a command. The switches -s, -l and -o are used to specify a short switch (single character, such as -l), a gnu style long switch (such as --color) and an old-style long switch (like -shuffle), respectively. If the command (aqmyprog(aq has an option (aq-o(aq which can also be written as --output, and which can take an additional value of either (aqyes(aq or (aqno(aq, this can be specified by writing: 0.0 3.5 C complete -c myprog -s o -l output -a "yes no" P There are also special switches for specifying that a switch requires an argument, to disable filename completion, to create completions that are only available in some combinations, etc.. For a complete description of the various switches accepted by the complete command, see the documentation for the complete builtin, or write complete --help inside the fish shell. As a more comprehensive example, here(aqs a commented excerpt of the completions for systemd(aqs timedatectl: 0.0 3.5 C # All subcommands that timedatectl knows - this is useful for later. set -l commands status set-time set-timezone list-timezones set-local-rtc set-ntp # Disable file completions for the entire command # because it does not take files anywhere # Note that this can be undone by using "-F". # # File completions also need to be disabled # if you want to have more control over what files are offered # (e.g. just directories, or just files ending in ".mp3"). complete -c timedatectl -f # This line offers the subcommands # -"status", # -"set-timezone", # -"set-time" # -"list-timezones" # if no subcommand has been given so far. # # The (ga-n(ga/(ga--condition(ga option takes script as a string, which it executes. # If it returns true, the completion is offered. # Here the condition is the (ga__fish_seen_subcommands_from(ga helper function. # If returns true if any of the given commands is used on the commandline, # as determined by a simple heuristic. # For more complex uses, you can write your own function. # See e.g. the git completions for an example. # complete -c timedatectl -n "not __fish_seen_subcommand_from $commands" e -a "status set-time set-timezone list-timezones" # If the "set-timezone" subcommand is used, # offer the output of (gatimedatectl list-timezones(ga as completions. # Each line of output is used as a separate candidate, # and anything after a tab is taken as the description. # It(aqs often useful to transform command output with (gastring(ga into that form. complete -c timedatectl -n "__fish_seen_subcommand_from set-timezone" e -a "(timedatectl list-timezones)" # Completion candidates can also be described via (ga-d(ga, # which is useful if the description is constant. # Try to keep these short, because that means the user gets to see more at once. complete -c timedatectl -n "not __fish_seen_subcommand_from $commands" e -a "set-local-rtc" -d "Maintain RTC in local time" # We can also limit options to certain subcommands by using conditions. complete -c timedatectl -n "__fish_seen_subcommand_from set-local-rtc" e -l adjust-system-clock -d (aqSynchronize system clock from the RTC(aq # These are simple options that can be used everywhere. complete -c timedatectl -s h -l help -d (aqPrint a short help text and exit(aq complete -c timedatectl -l version -d (aqPrint a short version string and exit(aq complete -c timedatectl -l no-pager -d (aqDo not pipe output into a pager(aq P For examples of how to write your own complex completions, study the completions in /usr/share/fish/completions. (The exact path depends on your chosen installation prefix and may be slightly different)
fish-doc(1)
fish-shell Documentation This is the documentation for fish, the friendly interactive shell. A shell is a program that helps you operate your computer by starting other programs. fish offers a command-line interface focused on usability and interactive use. Unlike other shells, fish does not follow the POSIX standard, but still uses roughly the same model. Some of the special features of fish are: 0.0 (bu 2 Extensive UI: %Syntax highlighting, %autosuggestions, %tab completion and selection lists that can be navigated and filtered. (bu 2 No configuration needed: fish is designed to be ready to use immediately, without requiring extensive configuration. (bu 2 Easy scripting: New %functions can be added on the fly. The syntax is easy to learn and use. This page gives an overview of fish(aqs features, syntax, and interface. If this is your first time using fish, see the tutorial. If you are already familiar with other shells like bash and want to see the scripting differences, see Fish For Bash Users. This section describes how to install, uninstall, start, and exit the fish shell. It also explains how to make fish the default shell
fish-for-bash-users(1)
A quick fish primer for those coming from bash This is to give you a quick overview if you come from bash (or to a lesser extent other shells like zsh or ksh) and want to know how fish differs. Fish is intentionally not POSIX-compatible and as such some of the things you are used to work differently. Many things are similar - they both fundamentally expand commandlines to execute commands, have pipes, redirections, variables, globs, use command output in various ways. This document is there to quickly show you the differences
folders(5)
Folder Structures Used by npm
g.message(1), g.message (1)
Prints a message, warning, progress info, or fatal error in the GRASS way. This module should be used in scripts for messages served to user
g.proj(1), g.proj (1)
Prints or modifies GRASS projection information files (in various co-ordinate system descriptions). Can also be used to create new GRASS locations
garbage_collect(nged)
Eliminates unused space in a BRL-CAD database file
get(nged)
Used to retrieve parameter values of database objects
graph(nged)
Used to query and manipulate properties of the graph that corresponds to the currently opened .g database
httpd_socket(3)
Communication utility functions to be used by the Erlang web server API programmer
httpd_util(3)
Miscellaneous utility functions to be used when implementing Erlang web server API modules
i.cluster(1), i.cluster (1)
Generates spectral signatures for land cover types in an image using a clustering algorithm. The resulting signature file is used as input for i.maxlik, to generate an unsupervised image classification
igraph(nged)
Used to interact with a graph based visualization of the structure of .g databases
jolokia(1)
Utility for managing Jolokia agents used by jmx4perl
listfonts.pl(1)
Print details of the fonts used in the PDF
mkProbe(1)
script file used to generate a Data Probe or Part 21 file reader executable for an EXPRESS schema
modules-used(1)
List modules used by a set of Perl source files without running them
pixcolors(1)
Count/list color values used in a PIX(5) format image
pixsubst(1)
Change color values used in a PIX(5) format image
pods::SDL::GFX::FPSManager(3), SDL::GFX::FPSManager(3)
data structure used by SDL::GFX::Framerate
rcc-cap(nged)
Used to round the end of a cylinder with an ellipsoid
rcc-tor(nged)
Used to round the edges of the specified RCC by creating a torus based on the parameters of that RCC
regdef(nged)
Sets the default region attributes used by the r and c commands when building a BRL-CAD region
rpp-arch(nged)
Used to round a specified face of an RPP by creating an RCC based on the parameters of the RPP
sca(nged)
Used to apply a scaling factor
solids(nged)
Lists a summary of all the primitive shapes used in regions referenced by the list of objects
spamassassin(1)
extensible email filter used to identify spam
tickit_window_take_focus(3), tickit_window_is_focused(3)
control the input focus
title(nged)
Returns the title string for the current database or, if used with an argument, renames the database
tol(nged)
Used with no arguments, tol lists the current tolerance settings
translate(nged)
Used to precisely control the translation of an object in both primitive edit and matrix edit modes
tstatd(1)
Logs real-time accounting daemon SYNOPSIS tstatd [ options ] plugin [zone1:]wildcard1 .. [zoneN:]wildcardN OPTIONS "-a zone, --agregate-zone=zone" 4 Item "-a zone, --agregate-zone=zone" Agregate data from all anonymous logs (wildcards without explicit zone specified) into zone. Default behavior is to create new zone for each anonymous log from its file name. "-b file, --database-file=file" 4 Item "-b file, --database-file=file" Use file as persistent storage to keep accumulated data across daemon restarts. Default is auto generated from daemon name, specified identity and '.db' suffix. "--basename" 4 Item "--basename" Use only base name (excluding directories and suffix) of anonymous log file for auto-created zones. "-c dir, --change-dir=dir" 4 Item "-c dir, --change-dir=dir" Change current directory to dir before wildcards expanding. "-d, --debug" 4 Item "-d, --debug" Composition of options: --foreground and --log-level=debug. "-f, --foreground" 4 Item "-f, --foreground" Don't detach daemon from control terminal, logging to stderr instead log file or syslog. "--log-facility=name" 4 Item "--log-facility=name" Use name as facility for syslog logging (see syslog (3) for list of available values). Default is 'daemon'. "--log-level=level" 4 Item "--log-level=level" Set minimal logging level to level (see syslog (3) for list of available values). Default is 'notice'. "--log-file=file" 4 Item "--log-file=file" Use logging to file instead of syslog logging (which is default). "-e num, --expand-period=num" 4 Item "-e num, --expand-period=num" Do wildcards re-expanding and checking for new and missed logs every num seconds. Default is '60'. "-h, --help" 4 Item "-h, --help" Print brief help message about available options. "-i string, --identity=string" 4 Item "-i string, --identity=string" Just a string used in title of daemon process, syslog ident (see syslog|(3)), --database-file and --pid-file. Idea behind this options - multiple tstatd instances running simultaneosly. "-l [address:]port, --listen=[address:]port" 4 Item "-l [address:]port, --listen=[address:]port" Specify address and port for TCP listen socket binding. Default is '127.0.0.1:3638'. "--multiple" 4 Item "--multiple" With this option specified same log file could be included into several zones (if log name satisifies several wildcards). Default behavior is to include log file only in first satisified zone. "-n num, --windows-num=num" 4 Item "-n num, --windows-num=num" Set number of sliding-windows to num. Default is '60'. "-o string, --options=string" 4 Item "-o string, --options=string" Comma-separated plugin supported options (like a mount (8) options). "--override-from=file" 4 Item "--override-from=file" Load content of file into plugin package namespace. This is way to easy customize plugin behavior without creating another plugin. "-p file, --pid-file=file" 4 Item "-p file, --pid-file=file" Use file to keep daemon process id. Default is auto generated from daemon name, specified identity and '.pid' suffix. "--parse-error=level" 4 Item "--parse-error=level" Do logging with level (see syslog (3) for available values) about all unparsed log lines. Hint: use 'none' for ignoring such lines. Default is defining by plugin and usually is 'debug'. "-r pattern, --regex=pattern" 4 Item "-r pattern, --regex=pattern" Use pattern instead of plugin default regular expression for matching log lines. "--regex-from=file" 4 Item "--regex-from=file" Load regular expression from file and use instead of plugin default regular expression for matching log lines. "-s num, --store-period=num" 4 Item "-s num, --store-period=num" Store accumulated data in a persistent storage every num seconds. Default is '60'. "--timer=zone:timer:num" 4 Item "--timer=zone:timer:num" Create named timer firing every num seconds for zone. "-u <user>, --user=user" 4 Item "-u <user>, --user=user" Change effective privileges of daemon process to user. "-v, --version" 4 Item "-v, --version" Print version information of tstatd and exit. "-w num, --window-size=<num>" 4 Item "-w num, --window-size=<num>" Set size (duration) of sliding window to num seconds. Default is '10'
v.net.alloc(1), v.net.alloc (1)
Allocates subnets for nearest centers. Center node must be opened (costs >= 0). Costs of center node are used in calculation
v.net.iso(1), v.net.iso (1)
Splits subnets for nearest centers by cost isolines. Splits net to bands between cost isolines (direction from center). Center node must be opened (costs >= 0). Costs of center node are used in calculation
v.net.salesman(1), v.net.salesman (1)
Creates a cycle connecting given nodes (Traveling salesman problem). Note that TSP is NP-hard, heuristic algorithm is used by this module and created cycle may be sub optimal
v.net.steiner(1), v.net.steiner (1)
Creates Steiner tree for the network and given terminals. Note that (cqMinimum Steiner Tree(cq problem is NP-hard and heuristic algorithm is used in this module so the result may be sub optimal
vdraw(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
home | help