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

FreeBSD Manual Pages

  
 
  

home | help
BUF_ISLOCKED(9)
returns the state of the lock linked to the buffer
DEBUG_FP(9), KFAIL_POINT_CODE(9), KFAIL_POINT_CODE_FLAGS(9), KFAIL_POINT_CODE_COND(9), KFAIL_POINT_ERROR(9), KFAIL_POINT_EVAL(9), KFAIL_POINT_DECLARE(9), KFAIL_POINT_DEFINE(9), KFAIL_POINT_GOTO(9), KFAIL_POINT_RETURN(9), KFAIL_POINT_RETURN_VOID(9), KFAIL_POINT_SLEEP_CALLBACKS(9), fail_point(9)
fail points
VFS_ROOT(9)
return the root vnode of a file system
VFS_STATFS(9)
return file system status
VOP_PATHCONF(9)
return POSIX pathconf information
aio_return(2)
retrieve return status of asynchronous I/O operation (REALTIME)
au_to_arg32(3), au_to_arg64(3), au_to_arg(3), au_to_attr64(3), au_to_data(3), au_to_exit(3), au_to_groups(3), au_to_newgroups(3), au_to_in_addr(3), au_to_in_addr_ex(3), au_to_ip(3), au_to_ipc(3), au_to_ipc_perm(3), au_to_iport(3), au_to_opaque(3), au_to_file(3), au_to_text(3), au_to_path(3), au_to_process32(3), au_to_process64(3), au_to_process(3), au_to_process32_ex(3), au_to_process64_ex(3), au_to_process_ex(3), au_to_return32(3), au_to_return64(3), au_to_return(3), au_to_seq(3), au_to_sock_inet32(3), au_to_sock_inet128(3), au_to_sock_inet(3), au_to_socket_ex(3), au_to_subject32(3), au_to_subject64(3), au_to_subject(3), au_to_subject32_ex(3), au_to_subject64_ex(3), au_to_subject_ex(3), au_to_me(3), au_to_exec_args(3), au_to_exec_env(3), au_to_header(3), au_to_header32(3), au_to_header64(3), au_to_header_ex(3), au_to_header32_ex(3), au_to_trailer(3), au_to_zonename(3)
routines for generating BSM audit tokens
basename(1), dirname(1)
return filename or directory portion of pathname
builtin(1), !(1), %(1), .(1), :(1), @(1), [(1), {(1), }(1), alias(1), alloc(1), bg(1), bind(1), bindkey(1), break(1), breaksw(1), builtins(1), case(1), cd(1), chdir(1), command(1), complete(1), continue(1), default(1), dirs(1), do(1), done(1), echo(1), echotc(1), elif(1), else(1), end(1), endif(1), endsw(1), esac(1), eval(1), exec(1), exit(1), export(1), false(1), fc(1), fg(1), filetest(1), fi(1), for(1), foreach(1), getopts(1), glob(1), goto(1), hash(1), hashstat(1), history(1), hup(1), if(1), jobid(1), jobs(1), kill(1), limit(1), local(1), log(1), login(1), logout(1), ls-F(1), nice(1), nohup(1), notify(1), onintr(1), popd(1), printenv(1), printf(1), pushd(1), pwd(1), read(1), readonly(1), rehash(1), repeat(1), return(1), sched(1), set(1), setenv(1), settc(1), setty(1), setvar(1), shift(1), source(1), stop(1), suspend(1), switch(1), telltc(1), test(1), then(1), time(1), times(1), trap(1), true(1), type(1), ulimit(1), umask(1), unalias(1), uncomplete(1), unhash(1), unlimit(1), unset(1), unsetenv(1), until(1), wait(1), where(1), which(1), while(1)
shell built-in commands
devctl_process_running(9)
Returns true when devctl has a consumer process running
device_get_parent(9)
return the device's parent
div(3)
return quotient and remainder from division
dwarf_die_CU_offset(3), dwarf_die_CU_offset_range(3), dwarf_dieoffset(3), dwarf_get_cu_die_offset_given_cu_header_offset(3), dwarf_get_cu_die_offset_given_cu_header_offset_b(3)
return offsets of DWARF debugging information entries
dwarf_find_macro_value_start(3)
return the address of the first byte of a macro value
dwarf_formaddr(3)
return the value of an ADDRESS class attribute
dwarf_formblock(3)
return the value of a BLOCK attribute
dwarf_formexprloc(3)
return information about a location expression
dwarf_formflag(3)
return the value of a BOOLEAN class attribute
dwarf_formsig8(3)
return the 64-bit type signature for a DWARF type
dwarf_formstring(3)
return the value of a STRING class attribute
dwarf_formudata(3), dwarf_formsdata(3)
return the value of a CONSTANT class attribute
dwarf_get_abbrev_children_flag(3)
return a flag indicating the presence of children
dwarf_get_address_size(3)
return the number of bytes needed to represent an address
dwarf_get_relocation_info_count(3)
return the number of relocation arrays
dwarf_get_section_max_offsets(3), dwarf_get_section_max_offsets_b(3)
return the size of DWARF sections
elf32_checksum(3), elf64_checksum(3), gelf_checksum(3)
return the checksum of an ELF object
elf_getident(3)
return the initial bytes of a file
elf_getphdrnum(3)
return the number of program headers in an ELF file
elf_getphnum(3)
return the number of program headers in an ELF file
elf_getshdrnum(3)
return the number of sections in an ELF file
elf_getshnum(3)
return the number of sections in an ELF file
elf_rawfile(3)
return uninterpreted contents of an ELF file
elftc_reloc_type_str(3)
return the type name for an ELF relocation
elftc_timestamp(3)
return the current or environment-provided timestamp
elftc_version(3)
return a project-wide version identifier string
false(1)
return false value
fparseln(3)
return the next logical line from a stream
gelf_fsize(3), elf32_fsize(3), elf64_fsize(3)
return the size of a file type
getlocalbase(3)
return the path to the local software directory
ibv_event_type_str(3)
Return string describing event_type enum value ibv_node_type_str - Return string describing node_type enum value ibv_port_state_str - Return string describing port_state enum value
ibv_get_srq_num(3), ibv_get_srq_num (3)
return srq number associated with the given shared receive queue (SRQ)
id(1)
return user identity
imaxabs(3)
returns absolute value
imaxdiv(3)
returns quotient and remainder
keybound(3)
return definition of keycode
kldfind(2)
returns the fileid of a kld file
kldfirstmod(2)
return first module id from the kld file specified
kldnext(2)
return the fileid of the next kld file
krb5_get_all_client_addrs(3), krb5_get_all_server_addrs(3)
return local addresses
kvm_getswapinfo(3)
return swap summary statistics for the system
labs(3)
return the absolute value of a long integer
ldiv(3)
return quotient and remainder from division
llabs(3)
returns absolute value
lldiv(3)
returns quotient and remainder
modfind(2)
returns the modid of a kernel module
modnext(2)
return the modid of the next kernel module
openpam_get_option(3)
returns the value of a module option
pam_getenvlist(3)
returns a list of all the PAM environment variables
pcap_breakloop(3)
force a pcap_dispatch() or pcap_loop() call to return
pcap_get_tstamp_precision(3)
get the time stamp precision returned in captures
pcap_set_tstamp_precision(3)
set the time stamp precision returned in captures
pmap_is_modified(9), pmap_ts_modified(9)
return information about physical pages
pmap_resident_count(9), pmap_wired_count(9)
return page resident and wiring statistics
pmc_event_names_of_class(3)
return a list of event names supported by a PMC class
pwd(1)
return working directory name
rcmd(3), rresvport(3), iruserok(3), ruserok(3), rcmd_af(3), rresvport_af(3), iruserok_sa(3)
routines for returning a stream to a remote command
rcmdsh(3)
return a stream to a remote command without superuser
rdma_event_str(3)
Returns a string representation of an rdma cm event
rdma_free_devices(3)
Frees the list of devices returned by rdma_get_devices
rdma_get_dst_port(3)
Returns the remote port number of a bound rdma_cm_id
rdma_get_local_addr(3)
Returns the local IP address of a bound rdma_cm_id
rdma_get_peer_addr(3)
Returns the remote IP address of a bound rdma_cm_id
rdma_get_src_port(3)
Returns the local port number of a bound rdma_cm_id
realpath(1)
return resolved physical path
realpath(3)
returns the canonicalized absolute pathname
rexec(3)
return stream to a remote command
sctp_freepaddrs(3), sctp_freeladdrs(3)
release the memory returned from a previous call
sctp_getaddrlen(3)
return the address length of an address family
sctp_getassocid(3)
return an association id for a specified socket address
sctp_getpaddrs(3), sctp_getladdrs(3)
return a list of addresses to the caller
sigreturn(2)
return from signal
thr_self(2)
return thread identifier for the calling thread
timezone(3)
return the timezone abbreviation
true(1)
return true value
tty(1)
return user's terminal name
vfs_getvfs(9)
returns a mount point given its file system identifier
vm_map_max(9), vm_map_min(9), vm_map_pmap(9)
return map properties
vm_page_grab(9)
returns a page from an object
vrefcnt(9)
returns the use count of a vnode
ypwhich(1)
return hostname of NIS server of map master
BIO_s_secmem(3), BIO_s_mem(3), BIO_set_mem_eof_return(3), BIO_get_mem_data(3), BIO_set_mem_buf(3), BIO_get_mem_ptr(3), BIO_new_mem_buf(3)
memory BIO
BN_security_bits(3)
returns bits of security based on given numbers
"glGetBooleanv(3), glGetDoublev(3), glGetFloatv(3), glGetIntegerv(3)
return the value or values of a selected parameter
"glGetLightfv(3), glGetLightiv(3)
return light source parameter values
"glGetMapdv(3), glGetMapfv(3), glGetMapiv(3)
return evaluator parameters
"glGetMaterialfv(3), glGetMaterialiv(3)
return material parameters
"glGetPixelMapfv(3), glGetPixelMapuiv(3), glGetPixelMapusv(3)
return the specified pixel map
"glGetTexEnvfv(3), glGetTexEnviv(3)
return texture environment parameters
"glGetTexGendv(3), glGetTexGenfv(3), glGetTexGeniv(3)
return texture coordinate generation parameters
"glGetTexLevelParameterfv(3), glGetTexLevelParameteriv(3)
return texture parameter values for a specific level of detail
"glGetTexParameterfv(3), glGetTexParameteriv(3)
return texture parameter values
BIO_s_secmem(3), BIO_s_mem(3), BIO_set_mem_eof_return(3), BIO_get_mem_data(3), BIO_set_mem_buf(3), BIO_get_mem_ptr(3), BIO_new_mem_buf(3)
memory BIO
BIO_s_secmem(3ossl), BIO_s_mem(3ossl), BIO_set_mem_eof_return(3ossl), BIO_get_mem_data(3ossl), BIO_set_mem_buf(3ossl), BIO_get_mem_ptr(3ossl), BIO_new_mem_buf(3ossl)
memory BIO
BN_security_bits(3)
returns bits of security based on given numbers
BN_security_bits(3ossl)
returns bits of security based on given numbers
BSglobal_flops(3)
Returns the global number of flops accumulated by BlockSolve
BSglobal_nnz(3)
Returns the global number of nonzeros
BSglobal_num_cliques(3)
Returns the global number of cliques
BSglobal_num_inodes(3)
Returns the global number of i-nodes
BSlocal_flops(3)
Returns the number of flops accumulated by BlockSolve
BSlocal_nnz(3)
Returns the local number of nonzeros
BSlocal_num_cliques(3)
Returns the local number of cliques
BSlocal_num_inodes(3)
Returns the local number of i-nodes
BSnum_colors(3)
Returns the number of colors
Blt_TreeName(3)
Returns the name of the tree data object
Blt_TreeNodeId(3)
Returns the node serial number
CURLINFO_RETRY_AFTER(3)
returns the Retry-After retry delay
DPMSCapable(3)
returns the DPMS capability of the X server
DPMSGetVersion(3)
returns the version of the DPMS extension implemented by the X server
DPMSInfo(3)
returns information about the current DPMS state
EVP_PKEY_todata(3ossl), EVP_PKEY_export(3ossl)
functions to return keys as an array of key parameters
FcAtomicNewFile(3)
return new temporary file name
FcAtomicOrigFile(3)
return original file name
FcCacheCopySet(3)
Returns a copy of the fontset from cache
FcCacheDir(3)
Return directory of cache
FcCacheNumFont(3)
Returns the number of fonts in cache
FcCacheNumSubdir(3)
Return the number of subdirectories in cache
FcCacheSubdir(3)
Return the i'th subdirectory
FcCharSetCoverage(3)
DEPRECATED return coverage for a Unicode page
FcConfigGetCache(3)
DEPRECATED used to return per-user cache filename
FcConfigGetCacheDirs(3)
return the list of directories searched for cache files
FcConfigGetCurrent(3)
Return current configuration
FcConfigHome(3)
return the current home directory
FcFontMatch(3)
Return best font
FcFontSetMatch(3)
Return the best font from a set of font sets
FcFontSort(3)
Return list of matching fonts
FcLangSetHash(3)
return a hash value for a langset
FcPatternGet(3)
Return a value from a pattern
FcPatternGet-Type(3), FcPatternGetInteger(3), FcPatternGetDouble(3), FcPatternGetString(3), FcPatternGetMatrix(3), FcPatternGetCharSet(3), FcPatternGetBool(3), FcPatternGetFTFace(3), FcPatternGetLangSet(3), FcPatternGetRange(3)
Return a typed value from a pattern
FcPatternGetWithBinding(3)
Return a value with binding from a pattern
FcPatternIterGetObject(3)
Returns an object name which the iterator point to
FcPatternIterGetValue(3)
Returns a value which the iterator point to
FcPatternIterValueCount(3)
Returns the number of the values which the iterator point to
FcPatternObjectCount(3)
Returns the number of the object
HPL_ptimer_cputime(3)
Return the CPU time
HPL_ptimer_walltime(3)
Return the elapsed (wall-clock) time
HPL_timer_cputime(3)
Return the CPU time
HPL_timer_walltime(3)
Return the elapsed (wall-clock) time
MPIX_GPU_query_support(3)
Returns the type of GPU supported
MPI_Aint_add(3)
Returns the sum of base and disp
MPI_Aint_diff(3)
Returns the difference between addr1 and addr2
MPI_Cart_shift(3)
Returns the shifted source and destination ranks, given a shift direction and amount
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_Comm_get_name(3)
Return the print name from the communicator
MPI_Comm_get_parent(3)
Return the parent communicator for this process
MPI_Dist_graph_create(3)
MPI_DIST_GRAPH_CREATE returns a handle to a new communicator to which the distributed graph topology information is attached
MPI_Dist_graph_create_adjacent(3)
returns a handle to a new communicator to which the distributed graph topology information is attached
MPI_Error_string(3)
Return a string for a given error code
MPI_File_get_amode(3)
Returns the file access mode
MPI_File_get_atomicity(3)
Returns the atomicity mode
MPI_File_get_byte_offset(3)
Returns the absolute byte position in the file corresponding to "offset" etypes relative to the current view
MPI_File_get_group(3)
Returns the group of processes that opened the file
MPI_File_get_info(3)
Returns the hints for a file that are actually being used by MPI
MPI_File_get_position(3)
Returns the current position of the individual file pointer in etype units relative to the current view
MPI_File_get_position_shared(3)
Returns the current position of the shared file pointer in etype units relative to the current view
MPI_File_get_size(3)
Returns the file size
MPI_File_get_type_extent(3)
Returns the extent of datatype in the file
MPI_File_get_view(3)
Returns the file view
MPI_Get_elements(3)
Returns the number of basic elements in a datatype
MPI_Get_elements_x(3)
Returns the number of basic elements in a datatype
MPI_Get_library_version(3)
Return the version number of MPI library
MPI_Get_version(3)
Return the version number of MPI
MPI_Graph_neighbors(3)
Returns the neighbors of a node associated with a graph topology
MPI_Graph_neighbors_count(3)
Returns the number of neighbors of a node associated with a graph topology
MPI_Grequest_start(3)
Create and return a user-defined request
MPI_Group_rank(3)
Returns the rank of this process in the given group
MPI_Group_size(3)
Returns the size of a group
MPI_Ibarrier(3)
Notifies the process that it has reached the barrier and returns immediately
MPI_Info_dup(3)
Returns a duplicate of the info object
MPI_Info_get_nkeys(3)
Returns the number of currently defined keys in info
MPI_Info_get_nthkey(3)
Returns the nth defined key in info
MPI_Is_thread_main(3)
Returns a flag indicating whether this thread called MPI_Init or MPI_Init_thread
MPI_Pack_external_size(3)
Returns the upper bound on the amount of space needed to pack a message using MPI_Pack_external
MPI_Pack_size(3)
Returns the upper bound on the amount of space needed to pack a message
MPI_Query_thread(3)
Return the level of thread support provided by the MPI library
MPI_Raccumulate(3)
Accumulate data into the target process using remote memory access and return a request handle for the operation
MPI_Rget_accumulate(3)
Perform an atomic, one-sided read-and-accumulate operation and return a request handle for the operation
MPI_Rput(3)
Put data into a memory window on a remote process and return a request handle for the operation
MPI_Type_extent(3)
Returns the extent of a datatype
MPI_Type_lb(3)
Returns the lower-bound of a datatype
MPI_Type_size(3)
Return the number of bytes occupied by entries in the datatype
MPI_Type_size_x(3)
Return the number of bytes occupied by entries in the datatype
MPI_Type_ub(3)
Returns the upper bound of a datatype
MPI_Win_get_info(3)
Returns a new info object containing the hints of the window associated with win
MPI_Wtick(3)
Returns the resolution of MPI_Wtime
MPI_Wtime(3)
Returns an elapsed time on the calling processor
Mat_GetDir(3)
Returns a list of the variable names of a MATLAB MAT file given a MAT file structure
Mat_GetFilename(3)
Returns the filename of a MATLAB MAT file given a MAT file structure
Mat_GetHeader(3)
Returns the header of a MATLAB MAT file given a MAT file structure
Mat_GetVersion(3)
Returns the version of a MATLAB MAT file given a MAT file structure
Munin::Node::Configure::HostEnumeration(3)
Takes a list of hosts, and returns the corresponding IPs in dotted-quad form
PKCS7_get_octet_string(3ossl)
return octet string from a PKCS#7 envelopedData structure
PS_get_buffer(3)
Returns internal memory buffer
PS_get_majorversion(3)
returns the major version number of the PostScript library
PS_get_minorversion(3)
returns the minor version number of the PostScript library
PS_get_opaque(3)
Returns pointer which has been passed to PS_new2()
PS_get_subminorversion(3)
returns the subminor version number of the PostScript library
PS_glyph_list(3)
Returns list of glyph names in font
SDL_CDName(3)
Returns a human-readable, system-dependent identifier for the CD-ROM
SDL_CDNumDrives(3)
Returns the number of CD-ROM drives on the system
SDL_CDStatus(3)
Returns the current status of the given drive
SDL_Delay(3)
Wait a specified number of milliseconds before returning
SDL_GetVideoInfo(3)
returns a pointer to information about the video hardware
SDL_GetVideoSurface(3)
returns a pointer to the current display surface
SDL_ListModes(3)
Returns a pointer to an array of available screen dimensions for the given format and video flags
SDL_PeepEvents(3)
Checks the event queue for messages and optionally returns them
SDL_SemValue(3)
Return the current value of a semaphore
SPI_getargcount(3)
return the number of arguments needed by a statement prepared by SPI_prepare
SPI_getargtypeid(3)
return the data type OID for an argument of a statement prepared by SPI_prepare
SPI_getbinval(3)
return the binary value of the specified column
SPI_getnspname(3)
return the namespace of the specified relation
SPI_getrelname(3)
return the name of the specified relation
SPI_gettype(3)
return the data type name of the specified column
SPI_gettypeid(3)
return the data type OID of the specified column
SPI_getvalue(3)
return the string value of the specified column
SPI_is_cursor_plan(3)
return true if a statement prepared by SPI_prepare can be used with SPI_cursor_open
SPI_result_code_string(3)
return error code as string
SPI_returntuple(3)
prepare to return a tuple as a Datum
TIFFReadRawStrip(3tiff)
return the undecoded contents of a strip of data from an open TIFF file
TIFFReadRawTile(3tiff)
return an undecoded tile of data from an open TIFF file
TIFFScanlineSize(3tiff), TIFFRasterScanlineSize(3tiff)
return the size of various items associated with an open TIFF file
Tcl_AddErrorInfo.tcl85(3), Tcl_GetReturnOptions(3), Tcl_SetReturnOptions(3), Tcl_AddErrorInfo(3), Tcl_AppendObjToErrorInfo(3), Tcl_AddObjErrorInfo(3), Tcl_SetObjErrorCode(3), Tcl_SetErrorCode(3), Tcl_SetErrorCodeVA(3), Tcl_PosixError(3), Tcl_LogCommandInfo(3)
retrieve or record information about errors and other return options
Tcl_AddErrorInfo.tcl86(3), Tcl_GetReturnOptions(3), Tcl_SetReturnOptions(3), Tcl_AddErrorInfo(3), Tcl_AppendObjToErrorInfo(3), Tcl_AddObjErrorInfo(3), Tcl_SetObjErrorCode(3), Tcl_SetErrorCode(3), Tcl_SetErrorCodeVA(3), Tcl_SetErrorLine(3), Tcl_GetErrorLine(3), Tcl_PosixError(3), Tcl_LogCommandInfo(3)
retrieve or record information about errors and other return options
Tcl_AddErrorInfo.tcl87(3), Tcl_GetReturnOptions(3), Tcl_SetReturnOptions(3), Tcl_AddErrorInfo(3), Tcl_AppendObjToErrorInfo(3), Tcl_AddObjErrorInfo(3), Tcl_SetObjErrorCode(3), Tcl_SetErrorCode(3), Tcl_SetErrorCodeVA(3), Tcl_SetErrorLine(3), Tcl_GetErrorLine(3), Tcl_PosixError(3), Tcl_LogCommandInfo(3)
retrieve or record information about errors and other return options
Tcl_FindExecutable.tcl85(3), Tcl_FindExecutable(3), Tcl_GetNameOfExecutable(3)
identify or return the name of the binary file containing the application
Tcl_FindExecutable.tcl86(3), Tcl_FindExecutable(3), Tcl_GetNameOfExecutable(3)
identify or return the name of the binary file containing the application
Tcl_FindExecutable.tcl87(3), Tcl_FindExecutable(3), Tcl_GetNameOfExecutable(3)
identify or return the name of the binary file containing the application
Tcl_GetOpenFile.tcl85(3), Tcl_GetOpenFile(3)
Return a FILE* for a channel registered in the given interpreter (Unix only)
Tcl_GetOpenFile.tcl86(3), Tcl_GetOpenFile(3)
Return a FILE* for a channel registered in the given interpreter (Unix only)
Tcl_GetOpenFile.tcl87(3), Tcl_GetOpenFile(3)
Return a FILE* for a channel registered in the given interpreter (Unix only)
Tk_NameOfImage.tk85(3), Tk_NameOfImage(3)
Return name of image
Tk_NameOfImage.tk86(3), Tk_NameOfImage(3)
Return name of image
Tk_StrictMotif.tk85(3), Tk_StrictMotif(3)
Return value of tk_strictMotif variable
Tk_StrictMotif.tk86(3), Tk_StrictMotif(3)
Return value of tk_strictMotif variable
Tspi_Context_CreateObject(3)
create an empty object and return a handle to that object
WildMidi_GetError(3)
Return the last error message
XInternAtom(3), XInternAtoms(3), XGetAtomName(3), XGetAtomNames(3)
create or return atom names
XcupQueryVersion(3)
Returns TOG-CUP protocol version supported by the X server
XdbeFreeVisualInfo(3)
frees information returned by XdbeGetVisualInfo()
XdbeGetBackBufferAttributes(3)
returns attributes of a DBE buffer
XdbeQueryExtension(3)
returns the version of DBE supported by the server
XkbActionCtrls(3)
Returns the ctrls fields of act converted to an unsigned int
XkbFreeComponentList(3)
Free the structure returned by XkbListComponents
XkbKeyAction(3)
Returns the key action
XkbKeyActionEntry(3)
Returns a pointer to the key action corresponding to group grp and shift level lvl from the two-dimensional table of key actions associated with the key corresponding to keycode
XkbKeyActionsPtr(3)
Returns a pointer to the two-dimensional array of key actions associated with the key corresponding to keycode
XkbKeyGroupInfo(3)
Returns the number of groups of symbols bound to the key corresponding to keycode
XkbKeyNumGroups(3)
Returns the number of groups of symbols bound to the key corresponding to keycode
XkbKeyNumSyms(3)
Returns the total number of keysyms for the key corresponding to keycode
XkbKeySymEntry(3)
Returns the keysym corresponding to shift level shift and group grp from the two-dimensional array of keysyms for the key corresponding to keycode
XkbKeySymsOffset(3)
Returns the offset of the two-dimensional array of keysyms for the key corresponding to keycode
XkbKeySymsPtr(3)
Returns the pointer to the two-dimensional array of keysyms for the key corresponding to keycode
XkbModActionVMods(3)
Returns the vmods1 and vmods2 fields of act converted to the vmods format of an Xkb modifier description
XkbOutOfRangeGroupInfo(3)
Returns only the out-of-range processing information from the group_info field of an XkbSymMapRec structure
XkbOutOfRangeGroupNumber(3)
Returns the out-of-range group number, represented as a group index, from the group_info field of an XkbSymMapRec structure
XkbPtrActionX(3)
Returns the high_XXX and low_XXX fields of act converted to a signed int
XkbPtrActionY(3)
Returns the high_YYY and low_YYY fields of act converted to a signed int
XkbSAGroup(3)
Returns the group_XXX field of act converted to a signed int
XkbSAPtrDfltValue(3)
Returns the valueXXX field of act converted to a signed int
XkbSARedirectVMods(3)
Returns the vmods0 and vmods1 fields of act converted to an unsigned int
XkbSARedirectVModsMask(3)
Returns the vmods_mask0 and vmods_mask1 fields of act converted to an unsigned int
XkbSAScreen(3)
Returns the screenXXX field of act converted to a signed int
XmClipboardInquireCount(3)
A clipboard function that returns the number of data item formats "XmClipboardInquireCount" "clipboard functions" "XmClipboardInquireCount"
XmClipboardInquireFormat(3)
A clipboard function that returns a specified format name "XmClipboardInquireFormat" "clipboard functions" "XmClipboardInquireFormat"
XmClipboardInquireLength(3)
A clipboard function that returns the length of the stored data "XmClipboardInquireLength" "clipboard functions" "XmClipboardInquireLength"
XmClipboardInquirePendingItems(3)
A clipboard function that returns a list of data ID/private ID pairs "XmClipboardInquirePending\%Items" "clipboard functions" "XmClipboardInquirePending\%Items"
XmDropSiteQueryStackingOrder(3)
A Drag and Drop function that returns the parent, a list of children, and the number of children for a specified widget "XmDropSiteQueryStacking\%Order" "Drag and Drop functions" "XmDropSiteQueryStacking\%Order"
XmFontListNextEntry(3)
A font list function that returns the next entry in a font list "XmFontListNextEntry" "font list functions" "XmFontListNextEntry"
XmGetAtomName(3)
A function that returns the string representation for an atom "XmGetAtomName" "atoms"
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"
XmGetFocusWidget(3)
Returns the ID of the widget that has keyboard focus "XmGetFocusWidget" "traversal functions" "XmGetFocusWidget"
XmGetMenuCursor(3)
A function that returns the cursor ID for the current menu cursor "XmGetMenuCursor"
XmGetPixmap(3)
A pixmap caching function that generates a pixmap, stores it in a pixmap cache, and returns the pixmap "XmGetPixmap" "pixmaps"
XmGetPixmapByDepth(3)
A pixmap caching function that generates a pixmap, stores it in a pixmap cache, and returns the pixmap "XmGetPixmapByDepth" "pixmaps"
XmGetPostedFromWidget(3)
A RowColumn function that returns the widget from which a menu was posted "XmGetPostedFromWidget" "RowColumn functions" "XmGetPostedFromWidget"
XmGetTabGroup(3)
Returns the widget ID of a tab group "XmGetTabGroup" "traversal functions" "XmGetTabGroup"
XmGetXmDisplay(3)
A Display function that returns the XmDisplay object ID for a specified display "XmGetXmDisplay" "Display functions" "XmGetXmDisplay"
XmGetXmScreen(3)
A Screen function that returns the XmScreen object ID for a specified screen "XmGetXmScreen"
XmHierarchyGetChildNodes(3)
A List function that returns all instances of an item in the list "XmListGetMatchPos" "List functions" "XmListGetMatchPos"
XmInternAtom(3)
A macro that returns an atom for a given name "XmInternAtom" "atoms"
XmListGetKbdItemPos(3)
A List function that returns the position of the item at the location cursor "XmListGetKbdItemPos" "List functions" "XmListGetKbdItemPos"
XmListGetMatchPos(3)
A List function that returns all instances of an item in the list "XmListGetMatchPos" "List functions" "XmListGetMatchPos"
XmListGetSelectedPos(3)
A List function that returns the position of every selected item in the list "XmListGetSelectedPos" "List functions" "XmListGetSelectedPos"
XmListItemPos(3)
A List function that returns the position of an item in the list "XmListItemPos" "List functions" "XmListItemPos"
XmListPosToBounds(3)
A List function that returns the bounding box of an item at a specified position in a list "XmListPosToBounds" "List functions" "XmListPosToBounds"
XmListYToPos(3)
A List function that returns the position of the item at a specified y-coordinate "XmListYToPos" "List functions" "XmListYToPos"
XmMainWindowSep1(3)
A MainWindow function that returns the widget ID of the first Separator "XmMainWindowSep1" "MainWindow functions" "XmMainWindowSep1"
XmMainWindowSep2(3)
A MainWindow function that returns the widget ID of the second Separator widget "XmMainWindowSep2" "MainWindow functions" "XmMainWindowSep2"
XmMainWindowSep3(3)
A MainWindow function that returns the widget ID of the third Separator widget "XmMainWindowSep3" "MainWindow functions" "XmMainWindowSep3"
XmMapSegmentEncoding(3)
A compound string function that returns the compound text encoding format associated with the specified font list tag "XmMapSegmentEncoding" "compound string functions" "XmMapSegmentEncoding"
XmMultiListGetSelectedRowArray(3)
an MultiList function that returns an array of integers which are selected row numbers. "XmMultiListGetSelectedRowArray" "List functions" "XmMultiListGetSelectedRowArray"
XmMultiListGetSelectedRows(3)
an MultiList function that returns the rows that currently are selected. "XmMultiListGetSelectedRows" "List functions" "XmMultiListGetSelectedRows"
XmNotebookGetPageInfo(3)
A Notebook function that returns page information "XmNotebookGetPageInfo" "Notebook functions" "XmNotebookGetPageInfo"
XmPanedGetPanes(3)
A Paned function that returns the number of panes in the paned widget "XmPanedGetPanes" "Paned functions" "XmPanedGetPanes"
XmRepTypeGetRecord(3)
A representation type manager function that returns information about a representation type "XmRepTypeGetRecord" "representation type manager functions" "XmRepTypeGetRecord"
XmRepTypeGetRegistered(3)
A representation type manager function that returns a copy of the registration list "XmRepTypeGetRegistered" "representation type manager functions" "XmRepTypeGetRegistered"
XmScaleGetValue(3)
A Scale function that returns the current slider position "XmScaleGetValue" "Scale functions" "XmScaleGetValue"
XmScrollBarGetValues(3)
A ScrollBar function that returns the ScrollBar's increment values "XmScrollBarGetValues" "ScrollBar functions" "XmScrollBarGetValues"
XmStringBaseline(3)
A compound string function that returns the number of pixels between the top of the character box and the baseline of the first line of text "XmStringBaseline" "compound string functions" "XmStringBaseline"
XmStringByteStreamLength(3)
A function that returns the size of a string "XmStringByteStreamLength"
XmStringGetNextComponent(3)
A compound string function that returns the type and value of the next component in a compound string "XmStringGetNextComponent" "compound string functions" "XmStringGetNextComponent"
XmStringGetNextTriple(3)
An XmString function that returns the type, length, and value of the next component in the compound string "XmStringGetNextTriple"
XmStringHeight(3)
A compound string function that returns the line height of the given compound string "XmStringHeight" "compound string functions" "XmStringHeight"
XmStringLineCount(3)
A compound string function that returns the number of separators plus one in the provided compound string "XmStringLineCount" "compound string functions" "XmStringLineCount"
XmStringPeekNextComponent(3)
A compound string function that returns the component type of the next component to be fetched "XmStringPeekNextComponent" "compound string functions" "XmStringPeekNextComponent"
XmStringPeekNextTriple(3)
A function that returns the component type of the next component "XmStringPeekNextTriple"
XmStringTableProposeTablist(3)
A convenience function that returns a tab list "XmStringTableProposeTablist"
XmStringWidth(3)
A compound string function that returns the width of the widest line in a compound string "XmStringWidth" "compound string functions" "XmStringWidth"
XmTabGetValues(3)
A convenience function that returns tab values "XmTabGetValues"
XmTabListGetTab(3)
A convenience function that returns a copy of a tab "XmTabListGetTab"
XmTabStackGetSelectedTab(3)
A TabStack function that returns the widget ID of the currently selectedtab "XmTabStackGetSelectedTab" "TabStack functions" "XmTabStackGetSelectedTab"
XmTextGetCenterline(3)
Return the height (length) of a character string when the writing direction is vertical
XmtAskForBoolean(3), XmtAskForBoolean()(3)
ask a yes-or-no question with a dialog box and return the user's response
XmtAskForDouble(3), XmtAskForDouble()(3), XmtAskForInteger()(3)
use a dialog box to prompt for a number and return the user's response
XmtAskForFile(3), XmtAskForFile()(3), XmtAskForFilename()(3)
use a file selection dialog box to prompt the user to select a file and return the user's response
XmtAskForItem(3), XmtAskForItem()(3), XmtAskForItemNumber()(3)
use a dialog box to prompt the user to select an item from a list and return the selected item
XmtAskForString(3), XmtAskForString()(3)
use a dialog box to prompt the user for a string and return the user's response
XmtDialogOkayCallback(3), XmtDialog{Okay(3), Cancel(3), Apply(3), Reset(3), Done}Callback()(3), XmtDialogGetDataAddress()(3), XmtDialogSetReturnValue()(3)
predefined callbacks for use with automatic dialogs and functions for writing custom dialog callbacks
XmtDisplayErrorAndAsk(3), XmtDisplayErrorAndAsk()(3), XmtDisplayWarningAndAsk()(3)
display an error or warning message, ask a yes-or-no question and return the user's response
XmtErrorMsg(3), XmtErrorMsg()(3), XmtWarningMsg()(3)
print an error message and exit or print a warning message and return
XmtGetBitmap(3), XmtGetBitmap()(3), XmtGetPixmap()(3)
find and return the named bitmap or pixmap
XmtGetHomeDir(3), XmtGetHomeDir()(3)
return the user's home directory
XmtGetShell(3), XmtGetShell()(3), XmtGetApplicationShell()(3), XmtGetTopLevelShell()(3)
return shell ancestors of a widget
XtSessionGetToken(3), XtSessionReturnToken(3)
token management for checkpointing
XvGetPortAttribute(3)
return current port attribute value
XvListImageFormats(3)
return list of image formats supported by a video port
XvQueryAdaptors(3)
return adaptor information for a screen
XvQueryEncodings(3)
return list of encodings for an adaptor
XvQueryExtension(3)
return version and release of extension
XvQueryPortAttributes(3)
return list of attributes of a video port
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_getkey(3)
return next keypress event from queue
aa_image(3)
returns pointer to the framebuffer emulated by AA-lib
aa_imgheight(3)
returns height of the emulated image in pixels
aa_imgwidth(3)
returns width of the emulated image in pixels
aa_mmheight(3)
returns height of the output screen in millimeters
aa_mmwidth(3)
returns width of the output screen in millimeters
aa_scrheight(3)
returns height of the output screen in characters
aa_scrwidth(3)
returns width of the output screen in characters
aa_text(3)
returns pointer to the text output buffer used by AA-lib
al_ffblk_get_size(3)
Get size of file returned by al_findfirst/al_findnext. Allegro game programming library
ares_fds(3)
return file descriptors to select on
ares_timeout(3)
return maximum time to wait
au_token(3), au_to_arg32(3), au_to_arg64(3), au_to_arg(3), au_to_attr64(3), au_to_data(3), au_to_exit(3), au_to_groups(3), au_to_newgroups(3), au_to_in_addr(3), au_to_in_addr_ex(3), au_to_ip(3), au_to_ipc(3), au_to_ipc_perm(3), au_to_iport(3), au_to_opaque(3), au_to_file(3), au_to_text(3), au_to_path(3), au_to_process32(3), au_to_process64(3), au_to_process(3), au_to_process32_ex(3), au_to_process64_ex(3), au_to_process_ex(3), au_to_return32(3), au_to_return64(3), au_to_return(3), au_to_seq(3), au_to_sock_inet32(3), au_to_sock_inet128(3), au_to_sock_inet(3), au_to_socket_ex(3), au_to_subject32(3), au_to_subject64(3), au_to_subject(3), au_to_subject32_ex(3), au_to_subject64_ex(3), au_to_subject_ex(3), au_to_me(3), au_to_exec_args(3), au_to_exec_env(3), au_to_header(3), au_to_header32(3), au_to_header64(3), au_to_header_ex(3), au_to_header32_ex(3), au_to_trailer(3), au_to_zonename(3)
routines for generating BSM audit tokens
bitmap_color_depth(3)
Returns the color depth of the specified bitmap. Allegro game programming library
bitmap_mask_color(3)
Returns the mask color of the specified bitmap. Allegro game programming library
calibrate_joystick_name(3)
Returns the next calibration text string. Allegro game programming library
catch.tcl85(n), catch(n)
Evaluate script and trap exceptional returns
catch.tcl86(n), catch(n)
Evaluate script and trap exceptional returns
catch.tcl87(n), catch(n)
Evaluate script and trap exceptional returns
cgiGetCookie(3)
Return a cookie
cgiGetCookies(3)
Returns a list of cookies
cgiGetFile(3)
Return information of a CGI file variable
cgiGetFiles(3)
Returns a list of CGI file variables
cgiGetValue(3)
Return the value of a CGI variable
cgiGetVariables(3)
Returns a list of CGI variables
cgi_filehandle(3), cgi_filehandle (3)
return a file pointer to an uploaded file
ck_array_buffer(3)
return length and pointer to array of reader-visible pointers
ck_array_length(3)
returns the number of pointers committed to an array
ck_bitmap_bits(3)
return number of addressable bits in bitmap
ck_bitmap_buffer(3)
returns pointer to bit array
ck_bitmap_size(3)
returns necessary number of bytes for bitmap
ck_epoch_recycle(3)
return an epoch record that may be used by caller
ck_hs_count(3)
returns number of entries in hash set
ck_ht_count(3)
return count of key-value pairs in hash table
ck_ht_entry_key(3)
return pointer to key as specified in hash table entry
ck_ht_entry_key_direct(3)
return key value as specified in hash table entry
ck_ht_entry_key_length(3)
returns the length of the key specified in the argument
ck_ht_entry_value(3)
return pointer to value as specified in hash table entry
ck_ht_entry_value_direct(3)
return value as specified in hash table entry
ck_rhs_count(3)
returns number of entries in hash set
ck_ring_capacity(3)
returns number of pointer slots in bounded FIFO
ck_ring_enqueue_spmc_size(3)
enqueue pointer into bounded FIFO and return size of buffer
ck_ring_enqueue_spsc_size(3)
enqueue pointer into bounded FIFO and return size of buffer
ck_ring_size(3)
return number of pointers enqueued in bounded FIFO
cmap_iter_next(3)
Return next item in iteration in CMAP
coredns-whoami(7), whoami(7)
returns your resolver's local IP address, port and transport
cpg_iteration_next(3)
Return next item in iteration of CPG
cpg_local_get(3)
Returns the local node id
cpg_membership_get(3)
Returns a list of members of a CPG group
curl_easy_strerror(3)
return string describing error code
curl_getenv(3)
return value for environment name
curl_multi_strerror(3)
return string describing error code
curl_share_strerror(3)
return string describing error code
curl_url(3)
returns a new CURLU handle
curl_url_strerror(3)
return string describing error code
curl_version(3)
returns the libcurl version string
curl_version_info(3)
returns runtime libcurl version info
current.nx(3), nx::current(3)
Return information about the method callstack
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
cxGetArchiveAccessMode(3)
Returns the archive's file access mode
cxGetArchiveFileCount(3)
Returns the total number of files in the archive
cxGetArchiveFileName(3)
Returns the archive's physical filename
cxGetArchiveFileSize(3)
Returns the archive's physical file size
cxGetArchiveModule(3)
Returns the archive's associated module
cxGetArchivePath(3)
Returns the full path to the specified archive
cxGetArchivePhysicalPath(3)
Returns the full physical path to the file
cxGetArchiveRoot(3)
Returns the root directory in the archive
cxGetArchiveSize(3)
Returns the total size of the archive's contents
cxGetArchiveType(3)
Returns the archive type
cxGetBaseName(3)
Returns the base filename for the specified path
cxGetBasePath(3)
Returns the base path for the specified path
cxGetDirArchive(3)
Returns the archive that owns the specified directory
cxGetDirDate(3)
Returns the timestamp of the specified directory
cxGetDirGid(3)
Returns the group ID of the specified directory
cxGetDirMode(3)
Return the mode of the specified directory
cxGetDirName(3)
Returns the base directory name of the specified directory
cxGetDirParent(3)
Returns the specified directory's parent directory
cxGetDirPath(3)
Returns the full path name of the specified directory
cxGetDirPhysicalPath(3)
Returns the full physical path to the directory
cxGetDirUid(3)
Returns the user ID of the specified directory
cxGetDirectory(3)
Returns the subdirectory specified in the path
cxGetFile(3)
Returns the file specified in the path
cxGetFileArchive(3)
Returns the archive that owns the specified file
cxGetFileCompressedSize(3)
Returns the compressed size of the specified file
cxGetFileCount(3)
Returns the number of files in the specified directory
cxGetFileDate(3)
Returns the timestamp of the specified file
cxGetFileGid(3)
Returns the group ID of the specified file
cxGetFileMode(3)
Returns the mode of the specified file
cxGetFileName(3)
Returns the name of the specified file
cxGetFileParent(3)
Returns the specified file's parent directory
cxGetFilePath(3)
Returns the full path to the specified file
cxGetFilePhysicalPath(3)
Returns the full physical path to the file
cxGetFileSize(3)
Returns the uncompressed size of the specified file
cxGetFileUid(3)
Returns the user ID of the specified file
cxGetFirstFile(3)
Returns the first file in the directory
cxGetFirstModule(3)
Returns the first module in the list
cxGetFirstSubDir(3)
Returns the first subdirectory in the directory
cxGetFpAccessMode(3)
Returns the access mode of the specified file pointer
cxGetFsIterFirst(3)
Returns the first item
cxGetFsIterNext(3)
Returns the next item
cxGetFsIterPrev(3)
Returns the previous item
cxGetFsNodeArchive(3)
Returns the archive that owns the specified node
cxGetFsNodeDate(3)
Returns the timestamp of the specified node
cxGetFsNodeGid(3)
Returns the group ID of the specified node
cxGetFsNodeMode(3)
Returns the mode of the specified node
cxGetFsNodeName(3)
Returns the name of the specified node
cxGetFsNodeParent(3)
Returns the specified node's parent directory
cxGetFsNodePath(3)
Returns the full path to the specified node
cxGetFsNodeUid(3)
Returns the user ID of the specified node
cxGetFullFilePath(3)
Returns the full, absolute path for the specified filename
cxGetModule(3)
Returns the specified module
cxGetNextDir(3)
Returns the next directory in a list of directories
cxGetNextFile(3)
Returns the next file in a list of files
cxGetNextFsNode(3)
Returns the next node in a list of nodes
cxGetPreviousDir(3)
Returns the previous directory in a list of directories
cxGetPreviousFile(3)
Returns the previous file in a list of files
cxGetPreviousFsNode(3)
Returns the previous node in a list of nodes
cxGetSubDirCount(3)
Returns the number of subdirectories in the specified directory
cxIsArchiveLocal(3)
Returns whether or not the archive is stored locally
cxIsDirLocal(3)
Returns whether or not the directory is stored locally
cxIsFileLocal(3)
Returns whether or not the file is stored locally
cxIsFsNodeLocal(3)
Returns whether or not the node is stored locally
cxStrError(3)
Returns a string representation of the error
cxTell(3)
Returns the current position in the file
dblink_fetch(3)
returns rows from an open cursor in a remote database
dblink_get_connections(3)
returns the names of all open named dblink connections
dblink_get_pkey(3)
returns the positions and field names of a relations primary key fields
dpath(8)
Diablo program to return commonly used paths for use in shell scripts
dpkg-buildflags(1)
returns build flags to use during package build
eclat-lsaddr(1), eclat-describe-addresses(1)
return information about IP addresses in your account
eclat-lssg(1), eclat-describe-security-groups(1)
return information about security groups
elf_begin(3)
Return descriptor for ELF file
explain(3), libexplain(3)
Explain errno values returned by libc functions require_index { }
explain_ftime_or_die(3)
return date and time and report errors require_index { "return date and time and report errors" }
explain_realpath_or_die(3)
return canonical pathname and report errors require_index { "return the canonicalized absolute pathname and report errors" }
explain_telldir_or_die(3)
current location in directory and report errors require_index { "return current location in directory stream and report errors" }
extend_dmalloc(1)
Analyze return-addresses from dmalloc logfiles
ezmlm-return(1)
handle mailing list bounces
fi_cm(3)
Connection management operations fi_connect / fi_listen / fi_accept / fi_reject / fi_shutdown Manage endpoint connection state. fi_setname / fi_getname / fi_getpeer Set local, or return local or peer endpoint address. fi_join / fi_close / fi_mc_addr Join, leave, or retrieve a multicast address
fi_endpoint(3)
Fabric endpoint operations fi_endpoint / fi_scalable_ep / fi_passive_ep / fi_close Allocate or close an endpoint. fi_ep_bind Associate an endpoint with hardware resources, such as event queues, completion queues, counters, address vectors, or shared transmit/receive contexts. fi_scalable_ep_bind Associate a scalable endpoint with an address vector fi_pep_bind Associate a passive endpoint with an event queue fi_enable Transitions an active endpoint into an enabled state. fi_cancel Cancel a pending asynchronous data transfer fi_ep_alias Create an alias to the endpoint fi_control Control endpoint operation. fi_getopt / fi_setopt Get or set endpoint options. fi_rx_context / fi_tx_context / fi_srx_context / fi_stx_context Open a transmit or receive context. fi_tc_dscp_set / fi_tc_dscp_get Convert between a DSCP value and a network traffic class fi_rx_size_left / fi_tx_size_left (DEPRECATED) Query the lower bound on how many RX/TX operations may be posted without an operation returning -FI_EAGAIN. This functions have been deprecated and will be removed in a future version of the library
fi_join_collective(3)
Operation where a subset of peers join a new collective group. fi_barrier Collective operation that does not complete until all peers have entered the barrier call. fi_broadcast A single sender transmits data to all peers, including itself. fi_alltoall Each peer distributes a slice of its local data to all peers. fi_allreduce Collective operation where all peers broadcast an atomic operation to all other peers. fi_allgather Each peer sends a complete copy of its local data to all peers. fi_reduce_scatter Collective call where data is collected from all peers and merged (reduced). The results of the reduction is distributed back to the peers, with each peer receiving a slice of the results. fi_reduce Collective call where data is collected from all peers to a root peer and merged (reduced). fi_scatter A single sender distributes (scatters) a slice of its local data to all peers. fi_gather All peers send their data to a root peer. fi_query_collective Returns information about which collective operations are supported by a provider, and limitations on the collective
fi_mr(3)
Memory region operations fi_mr_reg / fi_mr_regv / fi_mr_regattr Register local memory buffers for direct fabric access fi_close Deregister registered memory buffers. fi_mr_desc Return a local descriptor associated with a registered memory region fi_mr_key Return the remote key needed to access a registered memory region fi_mr_raw_attr Return raw memory region attributes. fi_mr_map_raw Converts a raw memory region key into a key that is usable for data transfer operations. fi_mr_unmap_key Releases a previously mapped raw memory region key. fi_mr_bind Associate a registered memory region with a completion counter or an endpoint. fi_mr_refresh Updates the memory pages associated with a memory region. fi_mr_enable Enables a memory region for use
file_size_ex(3)
Returns the size of a file in bytes. Allegro game programming library
file_time(3)
Returns the modification time of a file. Allegro game programming library
filter_create_fd(3), filter_create_fd (3)
Create a sub process and return the requested pipes
firedns_free_mxalist(3)
Free a previously returned MX/A list structure
firestring_hextoi(3)
return a numerical value for a 2 digit hex string
fixceil(3)
Returns the smallest integer not less than x. Allegro game programming library
fixfloor(3)
Returns the greatest integer not greater than x. Allegro game programming library
get_clip_rect(3)
Returns the clipping rectangle of a bitmap. Allegro game programming library
get_color_conversion(3)
Returns the current color conversion mode. Allegro game programming library
get_color_depth(3)
Returns the current pixel color depth. Allegro game programming library
get_config_text(3)
Returns a string translated to the current language. Allegro game programming library
get_datafile_property(3)
Returns the property string for the object. Allegro game programming library
get_display_switch_mode(3)
Returns the current display switching mode. Allegro game programming library
get_extension(3)
Returns a pointer to the extension of a filename. Allegro game programming library
get_filename(3)
Returns a pointer to the filename portion of a path. Allegro game programming library
get_filename_encoding(3)
Returns the encoding currently assumed for filenames. Allegro game programming library
get_font_range_begin(3)
Returns the start of a character range in a font. Allegro game programming library
get_font_range_end(3)
Returns the last character of a character range in a font. Allegro game programming library
get_font_ranges(3)
Returns the number of character ranges in a font. Allegro game programming library
get_gfx_mode(3)
Returns the id of the current graphics driver. Allegro game programming library
get_mixer_bits(3)
Returns the mixer bit depth (8 or 16). Allegro game programming library
get_mixer_buffer_length(3)
Returns the number of samples per channel in the mixer buffer. Allegro game programming library
get_mixer_channels(3)
Returns the number of output channels. Allegro game programming library
get_mixer_frequency(3)
Returns the mixer frequency, in Hz. Allegro game programming library
get_mixer_quality(3)
Returns the current mixing quality. Allegro game programming library
get_mixer_voices(3)
Returns the number of voices allocated to the mixer. Allegro game programming library
get_refresh_rate(3)
Returns the current refresh rate. Allegro game programming library
get_sound_input_cap_rate(3)
Returns the maximum sample frequency for recording. Allegro game programming library
getdns_pretty_print_dict(3)
-- return a string representation of a getdns dict
getdns_root_trust_anchor(3)
-- return the getdns list of default root trust anchors
git-annex-semitrust(1)
return repository to default trust level
git-info(1)
Returns information on current repository
glGetClipPlane(3), "glGetClipPlane(3)
return the coefficients of the specified clipping plane
glGetError(3), "glGetError(3)
return error information
glGetPointerv(3), "glGetPointerv(3)
return the address of the specified pointer
glGetPolygonStipple(3), "glGetPolygonStipple(3)
return the polygon stipple pattern
glGetString(3), "glGetString(3)
return a string describing the current GL connection
glGetTexImage(3), "glGetTexImage(3)
return a texture image
glXChooseVisual(3), "glXChooseVisual(3)
return a visual that matches specified attributes
glXGetClientString(3), "glXGetClientString(3)
return a string describing the client
glXGetConfig(3), "glXGetConfig(3)
return information about GLX visuals
glXGetCurrentContext(3), "glXGetCurrentContext(3)
return the current context
glXGetCurrentDrawable(3), "glXGetCurrentDrawable(3)
return the current drawable
glXQueryExtensionsString(3), "glXQueryExtensionsString(3)
return list of supported extensions
glXQueryServerString(3), "glXQueryServerString(3)
return string describing the server
glXQueryVersion(3), "glXQueryVersion(3)
return the version numbers of the GLX extension
gl_get_line(3), new_GetLine(3), del_GetLine(3), gl_customize_completion(3), gl_change_terminal(3), gl_configure_getline(3), gl_load_history(3), gl_save_history(3), gl_group_history(3), gl_show_history(3), gl_watch_fd(3), gl_inactivity_timeout(3), gl_terminal_size(3), gl_set_term_size(3), gl_resize_history(3), gl_limit_history(3), gl_clear_history(3), gl_toggle_history(3), gl_lookup_history(3), gl_state_of_history(3), gl_range_of_history(3), gl_size_of_history(3), gl_echo_mode(3), gl_replace_prompt(3), gl_prompt_style(3), gl_ignore_signal(3), gl_trap_signal(3), gl_last_signal(3), gl_completion_action(3), gl_display_text(3), gl_return_status(3), gl_error_message(3), gl_catch_blocked(3), gl_list_signals(3), gl_bind_keyseq(3), gl_erase_terminal(3), gl_automatic_history(3), gl_append_history(3), gl_query_char(3), gl_read_char(3)
allow the user to compose an input line
gl_getpixel(3)
return the color of a pixel
gl_rgbcolor(3)
return pixel value corresponding to an rgb color
glob.tcl85(n), glob(n)
Return names of files that match patterns
glob.tcl86(n), glob(n)
Return names of files that match patterns
glob.tcl87(n), glob(n)
Return names of files that match patterns
gluGetString(3), "gluGetString(3)
return a string describing the GLU version or GLU extensions
glutBitmapWidth(3)
returns the width of a bitmap character, glutBitmapLength returns the length of a bitmap font string
glutGetModifiers(3)
returns the modifier key state when certain callbacks were generated
glutSetMenu(3)
sets the current menu; glutGetMenu - returns the identifier of the current menu
glutSetWindow(3)
sets the current window; glutGetWindow - returns the identifier of the current window
glutStrokeWidth(3)
returns the width of a stroke character, glutStrokeLength returns the length of a stroke font string
gui_get_screen(3)
Returns the bitmap surface GUI routines draw to. Allegro game programming library
gui_strlen(3)
Returns the length of a string in pixels. Allegro game programming library
gutenfetch_free_servers(3)
-- This function frees a NULL terminated array of gutenfetch_server_t *. This is primarily for cleaning up the returned result from gutenfetch_list_servers(3)
hdf_dump(3), hdf_dump (3)
dump an HDF dataset to stdout Description: Input: Output: Returns:
hdf_dump_format(3), hdf_dump_format (3)
dump an HDF dataset to FILE *fp Description: Input: Output: Returns:
hdf_dump_str(3), hdf_dump_str (3)
dump an HDF dataset to STRING Description: Input: Output: Returns:
hdf_get_attr(3), hdf_get_attr (3)
Description: Input: Output: Returns:
hdf_get_child(3), hdf_get_child (3)
return the first child of the named node
hdf_get_copy(3), hdf_get_copy (3)
Returns a copy of a string in the HDF data set
hdf_get_int_value(3), hdf_get_int_value (3)
Return the integer value of a point in the data set
hdf_get_obj(3), hdf_get_obj (3)
return the HDF data set node at a named location
hdf_get_value(3), hdf_get_value (3)
Return the value of a node in the data set
hdf_get_valuef(3), hdf_get_valuef (3)
Return the value of a node in the data set
hdf_get_valuevf(3), hdf_get_valuevf (3)
Return the value of a node in the data set
hdf_obj_attr(3), hdf_obj_attr (3)
Return the HDF Attributes for a node Description: Input: Output: Returns:
hdf_obj_child(3), hdf_obj_child (3)
Return the first child of a dataset node
hdf_obj_name(3), hdf_obj_name (3)
Return the name of a node
hdf_obj_next(3), hdf_obj_next (3)
Return the next node of a dataset level
hdf_obj_top(3), hdf_obj_top (3)
Return the pointer to the top dataset node
hdf_obj_value(3), hdf_obj_value (3)
Return the value of a node
hdf_remove_tree(3), hdf_remove_tree (3)
delete a subtree of an HDF dataset Description: Input: Output: Returns:
hdf_set_attr(3), hdf_set_attr (3)
Description: Input: Output: Returns:
htstat(1)
returns statistics on the document and word databases, much like the -s option to htdig or htmerge
http_detach(3)
terminates HTTP protocol and returns the underlying socket
idn_result_tostring(3)
return a string corresponding with an error code
image_parent(3), image_parent (3)
Return a reference to the parent object
info.tcl85(n), info(n)
Return information about the state of the Tcl interpreter
info.tcl86(n), info(n)
Return information about the state of the Tcl interpreter
ipaddr_family(3)
returns family of the IP address
ipaddr_len(3)
returns length of the address
ipaddr_port(3)
returns the port part of the address
ipaddr_sockaddr(3)
returns sockaddr structure corresponding to the IP address
is_color_font(3)
Returns TRUE if a font is a color font. Allegro game programming library
is_mono_font(3)
Returns TRUE if a font is a monochrome font. Allegro game programming library
is_relative_filename(3)
Returns TRUE if the filename is relative. Allegro game programming library
is_trans_font(3)
Returns TRUE if a font uses transparency. Allegro game programming library
keyboard_close(3)
return the keyboard to normal operation from raw mode
keyboard_init(3), keyboard_init_return_fd(3)
initialize the keyboard to raw mode
keybound(3x)
return definition of keycode
krb5_get_all_client_addrs(3), krb5_get_all_server_addrs(3)
return local addresses
ksql_exec(3)
execute a standalone statement not returning any values
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_b32_ntop_calculate_size(3), ldns_b32_pton_calculate_size(3), ldns_b64_ntop_calculate_size(3), ldns_b64_pton_calculate_size(3)
return size needed for b32 or b64 encoded or decoded data
ldns_rr_label_count(3)
return ownername label count
ldns_update_zocount(3), ldns_update_prcount(3), ldns_update_upcount(3), ldns_update_adcount(3)
return update packet counters
ldns_version(3)
return library version
libowfat_buffer_peek(3), buffer_peek(3)
return pointer to string in buffer
libowfat_io_canread(3), io_canread(3)
return a file descriptor that can be read from
libowfat_io_canwrite(3), io_canwrite(3)
return a file descriptor that can be written to
libowfat_io_timeouted(3), io_timeouted(3)
return a file descriptor over deadline
libowfat_stralloc_chop(3), stralloc_chop(3)
remove and return last char
libowfat_tai_approx(3), tai_approx(3)
return double-precision approximation
libowfat_taia_approx(3), taia_approx(3)
return double-precision approximation
libssh2_hostkey_hash(3)
return a hash of the remote host's key
libssh2_session_abstract(3)
return a pointer to a session's abstract pointer
libssh2_session_methods(3)
return the currently active algorithms
libssh2_sftp_get_channel(3)
return the channel of sftp
libssh2_sftp_last_error(3)
return the last SFTP-specific error code
libssh2_userauth_authenticated(3)
return authentication status
libssh2_version(3)
return the libssh2 version number
lightning-help(7)
Command to return all information about RPC commands
lightning-listpeers(7)
Command returning data on connected lightning nodes
lrange.tcl85(n), lrange(n)
Return one or more adjacent elements from a list
lrange.tcl86(n), lrange(n)
Return one or more adjacent elements from a list
lrange.tcl87(n), lrange(n)
Return one or more adjacent elements from a list
match_keys(3), match_keys (3)
Return target:value for keys that match the specified pattern
mchartable_lookup(3m17n)
Return the assigned value of a character in a chartable
mchartable_max_char(3m17n)
Return the maximum character whose value is set in a chartabe
mchartable_min_char(3m17n)
Return the minimum character whose value is set in a chartabe
mdatabase_list(3m17n)
Return a data list of the m17n database
mdraw_coordinates_position(3m17n)
Return the character position nearest to the coordinates
mflt_coverage(3m17n)
Return a coverage of a FLT
mflt_get(3m17n)
Return an FLT object that has a specified name
mflt_name(3m17n)
Return the name of an FLT
mfont_selection_priority(3m17n)
Return the font selection priority
mfontset(3m17n)
Return a fontset
mfontset_name(3m17n)
Return the name of a fontset
mframe_get_prop(3m17n)
Return property value of frame
modbus_report_slave_id(3)
returns a description of the controller
modbus_strerror(3)
return the error message
mouse_getcaps(3)
returns the capabilities of the mouse
mouse_init(3), mouse_init_return_fd(3)
specifically initialize a mouse
mplist_key(3m17n)
Return the key of the first property in a property list
mplist_length(3m17n)
Return the length of a property list
mplist_next(3m17n)
Return the next sublist of a property list
mplist_value(3m17n)
Return the value of the first property in a property list
mtext_chr(3m17n)
Return the position of the first occurrence of a character in an M-text
mtext_property_end(3m17n)
Return the end position of a text property
mtext_property_key(3m17n)
Return the key of a text property
mtext_property_mtext(3m17n)
Return the M-text of a text property
mtext_property_start(3m17n)
Return the start position of a text property
mtext_property_value(3m17n)
Return the value of a text property
mtext_rchr(3m17n)
Return the position of the last occurrence of a character in an M-text
mtext_ref_char(3m17n)
Return the character at the specified position in an M-text
net-snmp-config(1)
returns information about installed net-snmp libraries and binaries
object_message(3)
Sends a message to an object and returns the answer. Allegro game programming library
optionPrintVersionAndReturn(3)
Print the program version
optionVersion(3)
return the compiled AutoOpts version number
pack_feof(3)
Returns nonzero as soon as you reach the end of the file. Allegro game programming library
pack_getc(3)
Returns the next character from a stream. Allegro game programming library
page_revoke(3)
Revocation methods There are two revocation method for PKIX/X.509: CRL and OCSP. Revocation is needed if the private key is lost and stolen. Depending on how picky you are, you might want to make revocation for destroyed private keys too (smartcard broken), but that should not be a problem. CRL is a list of certifiates that have expired. OCSP is an online checking method where the requestor sends a list of certificates to the OCSP server to return a signed reply if they are valid or not. Some services sends a OCSP reply as part of the hand-shake to make the revoktion decision simpler/faster for the client
panda_createfont(3)
return a handle to the requested font
panda_nowdate(3)
return the string for now
paperinfo(3), paperwithsize(3), paperfirst(3), paperlast(3), papernext(3), paperprev(3)
return informations about a paper
pbs_default(3)
return the pbs default server name
pcap_breakloop(3)
force a pcap_dispatch() or pcap_loop() call to return
pcap_get_tstamp_precision(3)
get the time stamp precision returned in captures
pcap_set_tstamp_precision(3)
set the time stamp precision returned in captures
pcre-config(1)
program to return PCRE configuration
pcre2-config(1)
program to return PCRE2 configuration
ping_get_error(3)
Return the last error message
prefix_detach(3)
terminates PREFIX protocol and returns the underlying socket
pvm_archcode(3)
Returns the data representation code for a PVM architecture name
pvm_bufinfo(3), pvm_bufinfo()(3)
Returns information about a message buffer
pvm_config(3)
Returns information about the present virtual machine configuration
pvm_getinst(3)
Returns the instance number in a group of a PVM process
pvm_getopt(3)
Returns the value of libpvm options
pvm_getrbuf(3)
Returns the message buffer identifier for the active receive buffer
pvm_getsbuf(3)
Returns the message buffer identifier for the active send buffer
pvm_gettid(3)
Returns the tid of the process identified by a group name and instance number
pvm_gsize(3)
Returns the number of members presently in the named group
pvm_mstat(3)
Returns the status of a host in the virtual machine
pvm_mytid(3)
Returns the tid of the calling process
pvm_parent(3)
Returns the tid of the process that spawned the calling process
pvm_perror(3)
Prints message describing the last error returned by a PVM call
pvm_pstat(3)
Returns the status of the specified PVM process
pvm_siblings(3)
return the number and associated task ids of processes that were started together in a single spawn call
pvm_tasks(3)
Returns information about the tasks running on the virtual machine
pvm_tidtohost(3)
Returns the host of the specified PVM process
pwd.tcl85(n), pwd(n)
Return the absolute path of the current working directory
pwd.tcl86(n), pwd(n)
Return the absolute path of the current working directory
pwd.tcl87(n), pwd(n)
Return the absolute path of the current working directory
qconfirm-return(1)
handles bounces from qconfirm-check(1)
rabbitmq-echopid(8), rabbitmq-echopid.bat(8)
returns the Windows process id of the Erlang runtime running RabbitMQ
readfile(3am)
return the entire contents of a file as a string
readkey(3)
Returns the next character from the keyboard buffer. Allegro game programming library
reload_config_texts(3)
Reloads translated strings returned by get_config_text(). Allegro game programming library
return.tcl85(n), return(n)
Return from a procedure, or set return code of a script
return.tcl86(n), return(n)
Return from a procedure, or set return code of a script
return.tcl87(n), return(n)
Return from a procedure, or set return code of a script
rle_open_f(3)
Open a binary file for input or output with defaults. rle_open_f_noexit - Returns error code instead of exiting
rrdfirst(1)
Return the date of the first data sample in an RRA within an RRD
rrdlast(1)
Return the date of the last data sample in an RRD
rrdlastupdate(1)
Return the most recent update to an RRD
sam_data_getsize(3)
Return size of stored data in bytes
sc_DiagMolecularHessian(3), sc::DiagMolecularHessian(3)
DiagMolecularHessian is an implementation of MolecularHessian that returns a hessian that is a diagonal matrix
shutdown_dialog(3)
Destroys a dialog player returned by init_dialog(). Allegro game programming library
shutdown_menu(3)
Destroys a menu player object returned by init_menu(). Allegro game programming library
slapo-retcode(5)
return code overlay to slapd
strend(3)
return pointer to the terminating '' of a string
strright(3)
return a pointer to the beginning of the rightmost n chars in a string
strsave(l), xstrsave(l)
return a fresh copy of a string
suffix_detach(3)
terminates SUFFIX protocol and returns the underlying socket
systempapername(3), defaultpapername(3), systempapersizefile(3), defaultpapersizefile(3)
return names for managing system paper information
tell.tcl85(n), tell(n)
Return current access position for an open channel
tell.tcl86(n), tell(n)
Return current access position for an open channel
tell.tcl87(n), tell(n)
Return current access position for an open channel
termkey_get_buffer_remaining(3)
returns the free buffer space
termkey_get_keyname(3)
return a string name for a symbolic key
text_height(3)
Returns the height of a font in pixels. Allegro game programming library
text_length(3)
Returns the length of a string in pixels. Allegro game programming library
tls_detach(3)
terminates TLS protocol and returns the underlying socket
tpm2_unseal(1), tpm2_unseal(1)(1)
Returns a data blob in a loaded TPM object. The data blob is returned in clear
tpm_clear(8)
return the TPM to the default state (unowned, disabled, inactive)
unicode_default_chset(3), unicode_locale_chset(3)
return the system character set name
unw_backtrace(3)
-- return backtrace for the calling program
upscli_strerror(3)
return string describing error condition
ureadkey(3)
Returns the next unicode character from the keyboard buffer. Allegro game programming library
ustrerror(3)
Returns a string describing errno. Allegro game programming library
vacation(1)
return I am not here indication
vga_getcurrentchipset(3)
returns the current SVGA chipset
vga_getcurrentmode(3)
returns the current video mode
vga_getdefaultmode(3)
returns the default graphics mode number
vga_getgraphmem(3)
returns the address of the VGA memory
vga_getmodeinfo(3)
returns pointer to mode information structure for a mode
vga_getmodename(3)
return a name for the given video mode
vga_getmodenumber(3)
return a number for the given video mode
vga_getmonitortype(3)
returns the monitor type configured
vga_getmousetype(3)
returns the mouse type configured
vga_getxdim(3), vga_getydim(3), vga_getcolors(3)
return the current screen resolution
vga_hasmode(3)
returns if a video mode is supported
vga_lastmodenumber(3)
returns the last video mode number
vga_runinbackground_version(3)
returns the version of the current background support
vga_white(3)
return the color white in the current screen resolution
viOpenDefaultRM(3visa)
Create and return a handle to the default VISA resource manager
voice_get_frequency(3)
Returns the current pitch of the voice. Allegro game programming library
voice_get_pan(3)
Returns the current pan position. Allegro game programming library
voice_get_position(3)
Returns the current position of a voice. Allegro game programming library
voice_get_volume(3)
Returns the current volume of the voice. Allegro game programming library
winfo.tk85(n), winfo(n)
Return window-related information
winfo.tk86(n), winfo(n)
Return window-related information
ws_detach(3)
terminates WebSocket protocol and returns the underlying socket
xosd_is_onscreen(3)
Returns wether the XOSD window is shown
zmq_atomic_counter_value(3)
return value of atomic counter
zmq_connect_peer(3)
create outgoing connection from socket and return the connection routing id in thread-safe and atomic way
zmq_msg_routing_id(3)
return routing ID for message, if any
Algorithm::Evolutionary::Op::Convergence_Terminator(3), Algorithm::Evolutionary::Op::Convergence_Terminator (3)
Checks for termination of an algorithm, returns true if a certain percentage of the population is the same
Alzabo::Runtime::JoinCursor(3)
Cursor that returns arrays of "Alzabo::Runtime::Row" objects
Alzabo::Runtime::RowCursor(3)
Cursor that returns "Alzabo::Runtime::Row" objects
App::Trace(3)
Embedded debug statements, including call/return tracing
BZ::Client::Exception(3), BZ::Client::Exception(3)
Exception class, which is thrown by BZ::Client in case of errors. BZ::Client does not return error codes or do similar stuff. Instead, it throws instances of BZ::Client::Exception
BZ::Client::Product(3), BZ::Client::Product(3)
Client side representation of a product in Bugzilla This class provides methods for accessing and managing products in Bugzilla. Instances of this class are returned by BZ::Client::Product::get
Bio::DB::LocationI(3)
A RandomAccessI-like abstract interface for retrieving location data from a sequence database and returning Bio::LocationI objects
Bio::DB::ReferenceI(3)
A RandomAccessI-like abstract interface for retrieving Reference data from a sequence database and returning Bio::Annotation::Reference objects
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
Bread::Board::Service::WithClass(3)
role for services returning instances of a given class
CPANPLUS::Backend::RV(3)
return value objects
CPANPLUS::Internals::Source::Memory(3)
In memory implementation n .SS "$cb->_|_memory_retrieve_source(name => $name, [path => $path, uptodate => BOOL, verbose => BOOL])" .SS "$cb->_|_memory_retrieve_source(name => $name, [path => $path, uptodate => BOOL, verbose => BOOL])" Subsection "$cb->__memory_retrieve_source(name => $name, [path => $path, uptodate => BOOL, verbose => BOOL])" This method retrieves a storabled tree identified by $name. It takes the following arguments: "name" 4 Item "name" The internal name for the source file to retrieve. "uptodate" 4 Item "uptodate" A flag indicating whether the file-cache is up-to-date or not. "path" 4 Item "path" The absolute path to the directory holding the source files. "verbose" 4 Item "verbose" A boolean flag indicating whether or not to be verbose. Will get information from the config file by default. Returns a tree on success, false on failure. n .SS "$cb->_|_memory_save_source([verbose => BOOL, path => $path])" .SS "$cb->_|_memory_save_source([verbose => BOOL, path => $path])" Subsection "$cb->__memory_save_source([verbose => BOOL, path => $path])" This method saves all the parsed trees in storabled format if Storable is available. It takes the following arguments: "path" 4 Item "path" The absolute path to the directory holding the source files. "verbose" 4 Item "verbose" A boolean flag indicating whether or not to be verbose. Will get information from the config file by default. Returns true on success, false on failure
CQL::Token(3)
class for token objects returned by CQL::Lexer
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::Component::InstancePerContext(3)
Return a new instance a component on each request
Chooser(3)
A system for choosing a value for something. Takes a string composed of various tests, arguements, and etc and returns a value based on it
Class::ReturnValue(3)
A return-value object that lets you treat it as as a boolean, array or object
Config::INI::Reader::Ordered(3)
.ini-file parser that returns sections in order
Config::Setting::FileProvider(3)
return the contents of files
Contextual::Return(3)
Create context-sensitive return values
Contextual::Return::Failure(3)
Utility module for Contextual::Return
DBI::Const::GetInfoReturn(3)
Data and functions for describing GetInfo results
DBI::Gofer::Execute(3)
Executes Gofer requests and returns Gofer responses
DBIx::Class::CDBICompat::Relationship(3)
Emulate the Class::DBI::Relationship object returned from meta_info()
DBIx::Class::Schema::PopulateMore::Inflator::Date(3)
Returns A DateTime object
DBIx::VersionedDDL::Plugin::DefaultScriptProcessor(3)
default plugin to process version scripts. Plugins are required to provide a method process_script which takes path to version script as an argument and returns a list of SQL statements
Data::Dumper::Concise::Sugar(3)
return Dwarn @return_value
DateTime::Event::Easter(3)
Returns Easter events for DateTime objects
DateTime::Event::Zodiac(3)
Return zodiac for a given date
Devel::Callsite(3)
Get caller return OP address and Perl interpreter context
Devel::GlobalDestruction(3)
Provides function returning the equivalent of "${^GLOBAL_PHASE} eq DESTRUCT" for older perls
Devel::NYTProf::Run(3)
Invoke NYTProf on a piece of code and return the profile
Devel::REPL::Plugin::Colors(3)
Add color to return values, warnings, and errors
Device::RAID::Poller(3)
Basic RAID status poller, returning RAID disk devices, types, and status
Device::USB::DevConfig(3)
Access the device configuration returned by libusb
Device::USB::DevEndpoint(3)
Access a device endpoint returned by libusb
Device::USB::DevInterface(3)
Access a device interface returned by libusb
DtDtsIsTrue(3)
return a Boolean value associated with a string
DtHelpReturnSelectedWidgetId(3)
select a widget or gadget
DtSearchRetrieve(3)
Return clear text of documents from DtSearch databases
Every(3)
return true every N cycles or S seconds
FFI::Platypus::API(3)
Platypus arguments and return value API for custom types
File::Dir::Dumper::Scanner(3)
scans a directory and returns a stream of Perl hash-refs
File::HomeDir::PathClass(3)
File::HomeDir returning Path::Class objects
File::ShareDir::PathClass(3)
File::ShareDir returning Path::Class objects
File::Temp(3)
return name and handle of a temporary file safely
Future::IO(3), "Future::IO"(3)
Future-returning IO methods
Future::Mutex(3), "Future::Mutex"(3)
mutual exclusion lock around code that returns Futures
Future::Phrasebook(3), "Future::Phrasebook"(3)
coding examples for "Future" and "Future::Utils" This documentation-only module provides a phrasebook-like approach to giving examples on how to use Future and Future::Utils to structure Future-driven asynchronous or concurrent logic. As with any inter-dialect phrasebook it is structured into pairs of examples; each given first in a traditional call/return Perl style, and second in a style using Futures. In each case, the generic function or functions in the example are named in "ALL_CAPITALS()" to make them stand out. In the examples showing use of Futures, any function that is expected to return a "Future" instance is named with a leading "F_" prefix. Each example is also constructed so as to yield an overall future in a variable called "$f", which represents the entire operation
GeoIP2::Record::MaxMind(3)
Contains data for the maxmind record returned from a web service query
GraphQL::AsyncIterator(3)
iterator objects that return promise to next result
Hash::Diff(3)
Return difference between two hashes as a hash
IO::Prompter(3)
Prompt for input, read it, clean it, return it
IOC::Service::Prototype(3)
An IOC Service object which returns a prototype instance
IOC::Service::Prototype::ConstructorInjection(3)
An IOC Service object which returns a prototype instance
IOC::Service::Prototype::SetterInjection(3)
An IOC Service object which returns a prototype instance
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
Iterator::DBI(3)
An iterator for returning DBI query results
JSON::DWIW::Boolean(3)
Return a true or false value when evaluated in boolean context -- to be used with JSON::DWIW->encode() to explicitly specify a boolean value.`
JSON::RPC::Common::Marshal::HTTP(3)
Convert HTTP::Request and HTTP::Response to/from JSON::RPC::Common calls and returns
JSON::RPC::Common::Procedure::Return(3)
JSON-RPC procedure return class
JSON::RPC::Common::Procedure::Return::Error(3)
Base class for JSON-RPC errors
JSON::RPC::Common::Procedure::Return::Version_1_0(3)
JSON-RPC 1.0 error class
JSON::RPC::Common::Procedure::Return::Version_1_0::Error(3)
JSON-RPC 1.0 error class
JSON::RPC::Common::Procedure::Return::Version_1_1(3)
JSON-RPC 1.1 Procedure Return
JSON::RPC::Common::Procedure::Return::Version_1_1::Error(3)
JSON-RPC 1.1 error class
JSON::RPC::Common::Procedure::Return::Version_2_0(3)
JSON-RPC 2.0 Procedure Return
JSON::RPC::Common::Procedure::Return::Version_2_0::Error(3)
JSON-RPC 2.0 error class
Jifty::Handler(3)
Methods related to the finding and returning content
Long::Jump(3)
Mechanism for returning to a specific point from a deeply nested stack
MPIX_Query_cuda_support(3)
Returns 1 if there is CUDA aware support and 0 if there is not
MPI_Add_error_class(3)
Creates a new error class and returns its value
MPI_Cart_shift(3), MPI_Cart_shift (3)
Returns the shifted source and destination ranks, given a shift direction and amount
MPI_Comm_get_name(3)
Returns the name that was most recently associated with a communicator
MPI_Comm_get_parent(3)
Returns the parent intercommunicator of current spawned process
MPI_Comm_group(3), MPI_Comm_group (3)
Returns the group associated with a communicator
MPI_Comm_size(3), MPI_Comm_size (3)
Returns the size of the group associated with a communicator
MPI_Dist_graph_neighbors(3), MPI_Dist_graph_neighbors (3)
Returns the neighbors of the calling process in a distributed graph topology
MPI_Dist_graph_neighbors_count(3), MPI_Dist_graph_neighbors_count (3)
Returns the number of in and out edges for the calling processes in a distributed graph topology and a flag indicating whether the distributed graph is weighted
MPI_Error_string(3), MPI_Error_string (3)
Returns a string for a given error code
MPI_Fetch_and_op(3)
Combines the contents of the origin buffer with that of a target buffer and returns the target buffer value
MPI_File_get_amode(3)
Returns access mode associated with an open file
MPI_File_get_atomicity(3)
Returns current consistency semantics for data-access operations
MPI_File_get_group(3)
Returns a duplicate of the process group of a file
MPI_File_get_info(3)
Returns a new info object containing values for current hints associated with a file
MPI_File_get_position(3)
Returns the current position of the individual file pointer
MPI_File_get_position_shared(3)
Returns the current position of the shared file pointer
MPI_File_get_size(3)
Returns the current size of the file
MPI_File_get_type_extent(3)
Returns the extent of the data type in a file
MPI_File_get_view(3)
Returns the process's view of data in the file
MPI_Get_accumulate(3), MPI_Rget_accumulate(3)
Combines the contents of the origin buffer with that of a target buffer and returns the target buffer value
MPI_Get_elements(3), MPI_Get_elements_x(3)
Returns the number of basic elements in a data type
MPI_Get_library_version(3)
Returns a string of the current Open MPI version
MPI_Get_version(3)
Returns the version of the standard corresponding to the current implementation
MPI_Graph_neighbors(3), MPI_Graph_neighbors (3)
Returns the neighbors of a node associated with a graph topology
MPI_Graph_neighbors_count(3), MPI_Graph_neighbors_count (3)
Returns the number of neighbors of a node associated with a graph topology
MPI_Grequest_start(3), MPI_Grequest_start (3)
Starts a generalized request and returns a handle to it in request
MPI_Group_rank(3)
Returns the rank of the calling process in the given group
MPI_Group_size(3)
Returns the size of a group
MPI_Info_get_nthkey(3)
Returns the nth defined key in info
MPI_Pack_size(3)
Returns the upper bound on the amount of space needed to pack a message
MPI_Query_thread(3)
Returns the current level of thread support
MPI_Sizeof(3)
Returns the size, in bytes, of the given type
MPI_Status_set_elements(3), MPI_Status_set_elements_x(3)
Modifies opaque part of status to allow MPI_Get_elements to return count
MPI_Type_create_f90_complex(3)
Returns a bounded MPI complex datatype
MPI_Type_create_f90_integer(3)
Returns a bounded MPI integer datatype
MPI_Type_create_f90_real(3)
Returns a bounded MPI real datatype
MPI_Type_create_resized(3)
Returns a new data type with new extent and upper and lower bounds
MPI_Type_extent(3)
Returns the extent of a data type, the difference between the upper and lower bounds of the data type -- use of this routine is deprecated
MPI_Type_get_attr(3)
Returns the attribute associated with a data type
MPI_Type_get_contents(3)
Returns information about arguments used in creation of a data type
MPI_Type_get_envelope(3)
Returns information about input arguments associated with a data type
MPI_Type_get_extent(3), MPI_Type_get_extent_x(3)
Returns the lower bound and extent of a data type
MPI_Type_get_true_extent(3), MPI_Type_get_true_extent_x(3)
Returns the true lower bound and extent of a data type's corresponding typemap, ignoring MPI_UB and MPI_LB markers
MPI_Type_lb(3)
Returns the lower bound of a data type -- use of this routine is deprecated
MPI_Type_match_size(3)
Returns an MPI datatype of a given type and size
MPI_Type_size(3), MPI_Type_size_x(3)
Returns the number of bytes occupied by entries in a data type
MPI_Type_ub(3)
Returns the upper bound of a datatype -- use of this routine is deprecated
MPI_Win_allocate(3)
One-sided MPI call that allocates memory and returns a window object for RMA operations
MPI_Win_allocate_shared(3)
One-sided MPI call that allocates shared memory and returns a window object for RMA operations
MPI_Win_create(3)
One-sided MPI call that returns a window object for RMA operations
MPI_Win_create_dynamic(3)
One-sided MPI call that returns a window object for RMA operations
MPI_Win_free(3)
Frees the window object and returns a null handle
MPI_Win_get_group(3)
Returns a duplicate of the group of the communicator used to create the window
MPI_Wtick(3)
Returns the resolution of MPI_Wtime
MPI_Wtime(3)
Returns an elapsed time on the calling processor
Mail::Verp(3)
encodes and decodes Variable Envelope Return Paths (VERP) addresses
Mason::CodeCache(3)
Result returned from Mason request
Mason::Result(3)
Result returned from Mason request
MojoMojo::Controller::JSON(3)
Various functions that return JSON data
Monitoring::Plugin::ExitResult(3)
Helper class for returning both output and return codes when testing
MooseX::Attribute::Chained(3)
Attribute that returns the instance to allow for chaining
MooseX::Attribute::ChainedClone(3)
Attribute that returns a cloned instance
Nagios::Plugin::ExitResult(3)
Helper class for returning both output and return codes when testing
Net::Amazon::MechanicalTurk::Command::GetHITTypeURL(3)
Returns a URL for viewing a HITType. Returns a URL for viewing a HITType on the MechanicalTurk worker website
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::Amazon::MechanicalTurk::Command::ParseAssignmentAnswer(3)
Parses the answer from a completed assignment. Returns an object of type Net::Amazon::MechanicalTurk::QuestionFormAnswers for an assignment object
Net::DBus::Binding::Message::MethodReturn(3)
a message encoding a method return
Net::GPSD3::Return::DEVICE(3)
Net::GPSD3 Return DEVICE Object
Net::GPSD3::Return::DEVICES(3)
Net::GPSD3 Return DEVICES Object
Net::GPSD3::Return::ERROR(3)
Net::GPSD3 Return ERROR Object
Net::GPSD3::Return::GST(3)
Net::GPSD3 Return GST Object
Net::GPSD3::Return::POLL(3)
Net::GPSD3 Return POLL Object
Net::GPSD3::Return::SKY(3)
Net::GPSD3 Return SKY Object
Net::GPSD3::Return::SUBFRAME(3)
Net::GPSD3 Return SUBFRAME Object
Net::GPSD3::Return::Satellite(3)
Net::GPSD3 Return Satellite Object
Net::GPSD3::Return::TPV(3)
Net::GPSD3 Return TPV Object
Net::GPSD3::Return::Unknown(3)
Net::GPSD3 Return Base Class
Net::GPSD3::Return::Unknown::Timestamp(3)
Net::GPSD3 Return Base Class with Timestamp
Net::GPSD3::Return::VERSION(3)
Net::GPSD3 Return VERSION Object
Net::GPSD3::Return::WATCH(3)
Net::GPSD3 Return WATCH Object
Net::LDAP::Search(3)
Object returned by Net::LDAP search method
Net::Twitter::Role::InflateObjects(3)
Inflate Twitter API return values to Moose objects
Net::Whois::Object(3)
Object encapsulating RPSL data returned by Whois queries
POE::Filter::XML::NS(3)
Provides constants that return appropriate namespace strings
POE::Request::Return(3)
encapsulates final replies to POE::Request messages
PPIx::EditorTools::ReturnObject(3)
Simple object to return values from PPIx::EditorTools
Paws::Snowball::CreateReturnShippingLabel(3)
Arguments for method CreateReturnShippingLabel on Paws::Snowball
Paws::Snowball::DescribeReturnShippingLabel(3)
Arguments for method DescribeReturnShippingLabel on Paws::Snowball
Perl::Critic::Policy::ErrorHandling::RequireCheckingReturnValueOfEval(3)
You can't depend upon the value of "$@"/"$EVAL_ERROR" to tell whether an "eval" failed
Perl::Critic::Policy::InputOutput::RequireCheckedSyscalls(3)
Return value of flagged function ignored
Perl::Critic::Policy::Subroutines::ProhibitExplicitReturnUndef(3)
Return failure with bare "return" instead of "return undef"
Perl::Critic::Policy::Subroutines::ProhibitReturnSort(3)
Behavior of "sort" is not defined if called in scalar context
Perl::Critic::Policy::Subroutines::RequireFinalReturn(3)
End every path through a subroutine with an explicit "return" statement
Perl::Metrics::Lite::FileFinder(3)
find perl files in paths n .SS "find_files( @directories_and_files )" .SS "find_files( @directories_and_files )" Subsection "find_files( @directories_and_files )" Uses list_perl_files to find all the readable Perl files and returns a reference to a (possibly empty) list of paths
PerlX::Maybe(3)
return a pair only if they are both defined
Pod::WSDL::Return(3)
Represents the WSDL pod for the return value of a method (internal use only)
Regexp::Common::Email::Address(3)
Returns a pattern for Email Addresses
Regexp::Common::URI::fax(3)
-- Returns a pattern for fax URIs
Regexp::Common::URI::file(3)
-- Returns a pattern for file URIs
Regexp::Common::URI::ftp(3)
-- Returns a pattern for FTP URIs
Regexp::Common::URI::gopher(3)
-- Returns a pattern for gopher URIs
Regexp::Common::URI::http(3)
-- Returns a pattern for HTTP URIs
Regexp::Common::URI::news(3)
-- Returns a pattern for file URIs
Regexp::Common::URI::pop(3)
-- Returns a pattern for POP URIs
Regexp::Common::URI::prospero(3)
-- Returns a pattern for prospero URIs
Regexp::Common::URI::tel(3)
-- Returns a pattern for telephone URIs
Regexp::Common::URI::telnet(3)
-- Returns a pattern for telnet URIs
Regexp::Common::URI::tv(3)
-- Returns a pattern for tv URIs
Regexp::Common::URI::wais(3)
-- Returns a pattern for WAIS URIs
Return::MultiLevel(3)
return across multiple call levels
Return::Type(3)
specify a return type for a function (optionally with coercion)
Return::Value(3)
(deprecated) polymorphic return values
SPOPS::Iterator(3)
Class to cycle through results and return SPOPS objects
Schedule::Load::Hold(3)
Return hold/wait information
Schedule::Load::Hosts(3)
Return host loading information across a network
Schedule::Load::Hosts::Host(3)
Return information about a host
Schedule::Load::Hosts::Proc(3)
Return process information
Sisimai::Rhost(3)
Detect the bounce reason returned from certain remote hosts
Sisimai::Rhost::Cox(3)
Detect the bounce reason returned from Cox
Sisimai::Rhost::ExchangeOnline(3)
Detect the bounce reason returned from on-premises Exchange 2013 and Office 365
Sisimai::Rhost::FrancePTT(3)
Detect the bounce reason returned from Orange and La Poste
Sisimai::Rhost::GoDaddy(3)
Detect the bounce reason returned from GoDaddy
Sisimai::Rhost::GoogleApps(3)
Detect the bounce reason returned from Google Apps
Sisimai::Rhost::IUA(3)
Detect the bounce reason returned from https://www.i.ua/
Sisimai::Rhost::KDDI(3)
Detect the bounce reason returned from au (KDDI)
Sisimai::Rhost::Spectrum(3)
Detect the bounce reason returned from Spectrum
Sisimai::Rhost::TencentQQ(3)
Detect the bounce reason returned from Tencent QQ
Spreadsheet::ParseODS::Workbook(3)
a workbook n .SS """->filename""" .SS "->filename" Subsection "->filename" print $workbook->filename; The name of the file if applicable. n .SS """->table_styles""" .SS "->table_styles" Subsection "->table_styles" The styles that identify whether a table is hidden, and other styles n .SS """->get_print_areas()""" .SS "->get_print_areas()" Subsection "->get_print_areas()" my $print_areas = $workbook->get_print_areas(); # [[ [$start_row, $start_col, $end_row, $end_col], ... ]] The ->get_print_areas() method returns the print areas of each sheet as an arrayref of arrayrefs. If a sheet has no print area, undef is returned for its print area. n .SS """->get_active_sheet()""" .SS "->get_active_sheet()" Subsection "->get_active_sheet()" my $sheet = $workbook->get_active_sheet(); if( !$sheet ) { # If there is no defined active worksheet, take the first: ($sheet) = $workbook->worksheets(); }; Returns the active worksheet, or if there is no such sheet, returns undef. n .SS """->worksheets()""" .SS "->worksheets()" Subsection "->worksheets()" my @sheets = $workbook->worksheets; Returns the list of worksheets as Spreadsheet::ParseODS::Worksheet objects. n .SS """->worksheet($name)""" .SS "->worksheet($name)" Subsection "->worksheet($name)" my $sheet1 = $workbook->worksheet(Sheet 1); Returns the worksheet with the given name, or if no such worksheet exists, returns undef
Spreadsheet::ParseODS::Worksheet(3)
a sheet in a workbook n .SS """get_print_areas()""" .SS "get_print_areas()" Subsection "get_print_areas()" my $print_areas = $worksheet->get_print_areas(); # [ [$start_row, $start_col, $end_row, $end_col], ... ] The ->get_print_areas() method returns the print areas of the sheet as an arrayref. Returns undef if there are no print areas
Sys::Filesystem::Aix(3)
Return AIX filesystem information to Sys::Filesystem
Sys::Filesystem::Cygwin(3)
Return Cygwin filesystem information to Sys::Filesystem
Sys::Filesystem::Darwin(3)
Return Darwin (Mac OS X) filesystem information to Sys::Filesystem
Sys::Filesystem::Dummy(3)
Returns nothing to Sys::Filesystem
Sys::Filesystem::Freebsd(3)
Return Freebsd filesystem information to Sys::Filesystem
Sys::Filesystem::Hpux(3)
Return HP-UX filesystem information to Sys::Filesystem
Sys::Filesystem::Linux(3)
Return Linux filesystem information to Sys::Filesystem
Sys::Filesystem::Mswin32(3)
Return Win32 filesystem information to Sys::Filesystem
Sys::Filesystem::Netbsd(3)
Return NetBSD filesystem information to Sys::Filesystem
Sys::Filesystem::Solaris(3)
Return Solaris filesystem information to Sys::Filesystem
Sys::Filesystem::Unix(3)
Return generic Unix filesystem information to Sys::Filesystem
Sys::Sig(3)
Sys::Sig -- return signal constants for this host
SyslogScan::WhereIs(3), SyslogScan::WhereIs::guess(3)
-- return full path of syslog file where mail messages are logged
Term::RawInput(3)
A simple drop-in replacement for <STDIN> in scripts with the additional ability to capture and return the non-standard keys like 'End', 'Escape' [ESC], 'Insert', etc
Ubic::Ping(3)
http server which returns service status by it's name or port
Ubic::Result(3)
common return value for many ubic interfaces
WWW::Search::Result(3)
class for results returned from WWW::Search
WWW::SearchResult(3)
class for results returned from WWW::Search
XML::Directory(3)
returns a content of directory as XML
XML::Grove::IDs(3)
return an index of `id' attributes in a grove
XML::Grove::Path(3)
return the object at a path
XML::Stream(3)
Creates an XML Stream connection and parses return data
ansilove_error(3)
Return an error string
bp_taxid4species(1)
simple script which returns the NCBI Taxonomic id for a requested species
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 show_account Display account details --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: 0) --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. When used in combination with the (ga-v(ga option, the challenge URLs or FQDNs and their expected return values are shown. (default: False) --preferred-chain PREFERRED_CHAIN Set the preferred certificate 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: []) --issuance-timeout ISSUANCE_TIMEOUT This option specifies how long (in seconds) Certbot will wait for the server to issue a certificate. (default: 90) --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.30.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) --no-reuse-key When renewing, do not use the same private key as the existing certificate. Not reusing private keys is the default behavior of Certbot. This option may be used to unset --reuse-key on an existing certificate. (default: False) --new-key When renewing or replacing a certificate, generate a new private key, even if --reuse-key is set on the existing certificate. Combining --new-key and --reuse- key will result in the private key being replaced and then reused in future renewals. (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. The root certificates trusted by Certbot can be overriden by setting the REQUESTS_CA_BUNDLE environment variable. (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 any certificates previously obtained if they are close to expiry, and print a summary of the results. By default, (aqrenew(aq will reuse the plugins and options used to obtain or most recently renew each certificate. You can test whether future renewals will succeed with (ga--dry-run(ga. Individual certificates can be renewed with the (ga--cert-name(ga option. 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: False) 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. show_account: Options useful for the "show_account" subcommand: 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: 120) --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
csa_read_calendar_attributes(3)
read and return the calendar attributes values for a calendar
csa_read_entry_attributes(3)
read and return the calendar entry attribute values for a specified calendar entry
dirname(1)
return directory portion of file name rst2man-indent-level 0 1 rstReportMargin \$1
error(9p)
return an error
exists(nged)
The exists command evaluates an expression and return 1 if true, zero if false. It serves roughly the same purpose for objects in a BRL-CAD database that the UNIX test command serves for files on a file system, with additional features specific to geometry and minus some of the filesystem specific options of test
expand(nged)
Performs matching of the shell globbing pattern with the names of all the objects in the database. It returns all those that successfully match
false(1)
return an unsuccessful result
fdown(3), fdown()(3)
returns a logical unit number
fdup(3), fdup()(3)
returns new file identical to the given file
filepos(3), filepos()(3)
returns the logical position in a file
filesize(3), filesize()(3)
returns size of file
getcallerpc(3)
fetch return PC of current function
help(nged)
Returns a list of available MGED commands along with a one-line usage message for each. If a command is supplied as an argument, the one-line usage message for that command is returned
helpdevel(nged)
Returns a list of available developer commands along with a one-line usage message for each. If a command is supplied as an argument, the one-line usage message for that command is returned
helplib(nged)
Returns a list of available library commands along with a one-line usage message for each. If a command is supplied as an argument, the one-line usage message for that command is returned
kitty.conf(5)
kitty.conf Documentation kitty is highly customizable, everything from keyboard shortcuts, to rendering frames-per-second. See below for an overview of all customization possibilities. You can open the config file within kitty by pressing %ctrl+shift+f2 (⌘+, on macOS). A kitty.conf with commented default configurations and descriptions will be created if the file does not exist. You can reload the config file within kitty by pressing %ctrl+shift+f5 (⌃+⌘+, on macOS) or sending kitty the SIGUSR1 signal. You can also display the current configuration by pressing %ctrl+shift+f6 (⌥+⌘+, on macOS). kitty looks for a config file in the OS config directories (usually ~/.config/kitty/kitty.conf) but you can pass a specific path via the %kitty --config option or use the %KITTY_CONFIG_DIRECTORY environment variable. See %kitty --config for full details. Comments can be added to the config file as lines starting with the # character. This works only if the # character is the first character in the line. You can include secondary config files via the include directive. If you use a relative path for include, it is resolved with respect to the location of the current config file. Note that environment variables are expanded, so ${USER}.conf becomes name.conf if USER=name. Also, you can use globinclude to include files matching a shell glob pattern and envinclude to include configuration from environment variables. For example: 0.0 3.5 C include other.conf # Include *.conf files from all subdirs of kitty.d inside the kitty config dir globinclude kitty.d/**/*.conf # Include the *contents* of all env vars starting with KITTY_CONF_ envinclude KITTY_CONF_* P NOTE: 0.0 3.5 Syntax highlighting for kitty.conf in vim is available via %vim-kitty. kitty has very powerful font management. You can configure individual font faces and even specify special fonts for particular characters. 0.0 font_family, bold_font, italic_font, bold_italic_font 0.0 3.5 C font_family monospace bold_font auto italic_font auto bold_italic_font auto P You can specify different fonts for the bold/italic/bold-italic variants. To get a full list of supported fonts use the kitty +list-fonts command. By default they are derived automatically, by the OSes font system. When %bold_font or %bold_italic_font is set to auto on macOS, the priority of bold fonts is semi-bold, bold, heavy. Setting them manually is useful for font families that have many weight variants like Book, Medium, Thick, etc. For example: 0.0 3.5 C font_family Operator Mono Book bold_font Operator Mono Medium italic_font Operator Mono Book Italic bold_italic_font Operator Mono Medium Italic P 0.0 font_size 0.0 3.5 C font_size 11.0 P Font size (in pts) 0.0 force_ltr 0.0 3.5 C force_ltr no P kitty does not support BIDI (bidirectional text), however, for RTL scripts, words are automatically displayed in RTL. That is to say, in an RTL script, the words (dqHELLO WORLD(dq display in kitty as (dqWORLD HELLO(dq, and if you try to select a substring of an RTL-shaped string, you will get the character that would be there had the the string been LTR. For example, assuming the Hebrew word ירושלים, selecting the character that on the screen appears to be ם actually writes into the selection buffer the character י. kitty(aqs default behavior is useful in conjunction with a filter to reverse the word order, however, if you wish to manipulate RTL glyphs, it can be very challenging to work with, so this option is provided to turn it off. Furthermore, this option can be used with the command line program %GNU FriBidi to get BIDI support, because it will force kitty to always treat the text as LTR, which FriBidi expects for terminals. 0.0 symbol_map 0.0 3.5 C symbol_map U+E0A0-U+E0A3,U+E0C0-U+E0C7 PowerlineSymbols P Map the specified Unicode codepoints to a particular font. Useful if you need special rendering for some symbols, such as for Powerline. Avoids the need for patched fonts. Each Unicode code point is specified in the form U+<code point in hexadecimal>. You can specify multiple code points, separated by commas and ranges separated by hyphens. This option can be specified multiple times. The syntax is: 0.0 3.5 C symbol_map codepoints Font Family Name P 0.0 narrow_symbols 0.0 3.5 C narrow_symbols U+E0A0-U+E0A3,U+E0C0-U+E0C7 1 P Usually, for Private Use Unicode characters and some symbol/dingbat characters, if the character is followed by one or more spaces, kitty will use those extra cells to render the character larger, if the character in the font has a wide aspect ratio. Using this option you can force kitty to restrict the specified code points to render in the specified number of cells (defaulting to one cell). This option can be specified multiple times. The syntax is: 0.0 3.5 C narrow_symbols codepoints [optionally the number of cells] P 0.0 disable_ligatures 0.0 3.5 C disable_ligatures never P Choose how you want to handle multi-character ligatures. The default is to always render them. You can tell kitty to not render them when the cursor is over them by using cursor to make editing easier, or have kitty never render them at all by using always, if you don(aqt like them. The ligature strategy can be set per-window either using the kitty remote control facility or by defining shortcuts for it in kitty.conf, for example: 0.0 3.5 C map alt+1 disable_ligatures_in active always map alt+2 disable_ligatures_in all never map alt+3 disable_ligatures_in tab cursor P Note that this refers to programming ligatures, typically implemented using the calt OpenType feature. For disabling general ligatures, use the %font_features option. 0.0 font_features 0.0 3.5 C font_features none P Choose exactly which OpenType features to enable or disable. This is useful as some fonts might have features worthwhile in a terminal. For example, Fira Code includes a discretionary feature, zero, which in that font changes the appearance of the zero (0), to make it more easily distinguishable from Ø. Fira Code also includes other discretionary features known as Stylistic Sets which have the tags ss01 through ss20. For the exact syntax to use for individual features, see the %HarfBuzz documentation. Note that this code is indexed by PostScript name, and not the font family. This allows you to define very precise feature settings; e.g. you can disable a feature in the italic font but not in the regular font. On Linux, font features are first read from the FontConfig database and then this option is applied, so they can be configured in a single, central place. To get the PostScript name for a font, use kitty +list-fonts --psnames: 0.0 3.5 C $ kitty +list-fonts --psnames | grep Fira Fira Code Fira Code Bold (FiraCode-Bold) Fira Code Light (FiraCode-Light) Fira Code Medium (FiraCode-Medium) Fira Code Regular (FiraCode-Regular) Fira Code Retina (FiraCode-Retina) P The part in brackets is the PostScript name. Enable alternate zero and oldstyle numerals: 0.0 3.5 C font_features FiraCode-Retina +zero +onum P Enable only alternate zero in the bold font: 0.0 3.5 C font_features FiraCode-Bold +zero P Disable the normal ligatures, but keep the calt feature which (in this font) breaks up monotony: 0.0 3.5 C font_features TT2020StyleB-Regular -liga +calt P In conjunction with %force_ltr, you may want to disable Arabic shaping entirely, and only look at their isolated forms if they show up in a document. You can do this with e.g.: 0.0 3.5 C font_features UnifontMedium +isol -medi -fina -init P 0.0 modify_font 0.0 3.5 C modify_font P Modify font characteristics such as the position or thickness of the underline and strikethrough. The modifications can have the suffix px for pixels or % for percentage of original value. No suffix means use pts. For example: 0.0 3.5 C modify_font underline_position -2 modify_font underline_thickness 150% modify_font strikethrough_position 2px P Additionally, you can modify the size of the cell in which each font glyph is rendered and the baseline at which the glyph is placed in the cell. For example: 0.0 3.5 C modify_font cell_width 80% modify_font cell_height -2px modify_font baseline 3 P Note that modifying the baseline will automatically adjust the underline and strikethrough positions by the same amount. Increasing the baseline raises glyphs inside the cell and decreasing it lowers them. Decreasing the cell size might cause rendering artifacts, so use with care. 0.0 box_drawing_scale 0.0 3.5 C box_drawing_scale 0.001, 1, 1.5, 2 P The sizes of the lines used for the box drawing Unicode characters. These values are in pts. They will be scaled by the monitor DPI to arrive at a pixel value. There must be four values corresponding to thin, normal, thick, and very thick lines. 0.0 cursor 0.0 3.5 C cursor #cccccc P Default cursor color. If set to the special value none the cursor will be rendered with a (dqreverse video(dq effect. It(aqs color will be the color of the text in the cell it is over and the text will be rendered with the background color of the cell. Note that if the program running in the terminal sets a cursor color, this takes precedence. Also, the cursor colors are modified if the cell background and foreground colors have very low contrast. 0.0 cursor_text_color 0.0 3.5 C cursor_text_color #111111 P The color of text under the cursor. If you want it rendered with the background color of the cell underneath instead, use the special keyword: background. Note that if %cursor is set to none then this option is ignored. 0.0 cursor_shape 0.0 3.5 C cursor_shape block P The cursor shape can be one of block, beam, underline. Note that when reloading the config this will be changed only if the cursor shape has not been set by the program running in the terminal. This sets the default cursor shape, applications running in the terminal can override it. In particular, %shell integration in kitty sets the cursor shape to beam at shell prompts. You can avoid this by setting %shell_integration to no-cursor. 0.0 cursor_beam_thickness 0.0 3.5 C cursor_beam_thickness 1.5 P The thickness of the beam cursor (in pts). 0.0 cursor_underline_thickness 0.0 3.5 C cursor_underline_thickness 2.0 P The thickness of the underline cursor (in pts). 0.0 cursor_blink_interval 0.0 3.5 C cursor_blink_interval -1 P The interval to blink the cursor (in seconds). Set to zero to disable blinking. Negative values mean use system default. Note that the minimum interval will be limited to %repaint_delay. 0.0 cursor_stop_blinking_after 0.0 3.5 C cursor_stop_blinking_after 15.0 P Stop blinking cursor after the specified number of seconds of keyboard inactivity. Set to zero to never stop blinking. 0.0 scrollback_lines 0.0 3.5 C scrollback_lines 2000 P Number of lines of history to keep in memory for scrolling back. Memory is allocated on demand. Negative numbers are (effectively) infinite scrollback. Note that using very large scrollback is not recommended as it can slow down performance of the terminal and also use large amounts of RAM. Instead, consider using %scrollback_pager_history_size. Note that on config reload if this is changed it will only affect newly created windows, not existing ones. 0.0 scrollback_pager 0.0 3.5 C scrollback_pager less --chop-long-lines --RAW-CONTROL-CHARS +INPUT_LINE_NUMBER P Program with which to view scrollback in a new window. The scrollback buffer is passed as STDIN to this program. If you change it, make sure the program you use can handle ANSI escape sequences for colors and text formatting. INPUT_LINE_NUMBER in the command line above will be replaced by an integer representing which line should be at the top of the screen. Similarly CURSOR_LINE and CURSOR_COLUMN will be replaced by the current cursor position or set to 0 if there is no cursor, for example, when showing the last command output. 0.0 scrollback_pager_history_size 0.0 3.5 C scrollback_pager_history_size 0 P Separate scrollback history size (in MB), used only for browsing the scrollback buffer with pager. This separate buffer is not available for interactive scrolling but will be piped to the pager program when viewing scrollback buffer in a separate window. The current implementation stores the data in UTF-8, so approximatively 10000 lines per megabyte at 100 chars per line, for pure ASCII, unformatted text. A value of zero or less disables this feature. The maximum allowed size is 4GB. Note that on config reload if this is changed it will only affect newly created windows, not existing ones. 0.0 scrollback_fill_enlarged_window 0.0 3.5 C scrollback_fill_enlarged_window no P Fill new space with lines from the scrollback buffer after enlarging a window. 0.0 wheel_scroll_multiplier 0.0 3.5 C wheel_scroll_multiplier 5.0 P Multiplier for the number of lines scrolled by the mouse wheel. Note that this is only used for low precision scrolling devices, not for high precision scrolling devices on platforms such as macOS and Wayland. Use negative numbers to change scroll direction. See also %wheel_scroll_min_lines. 0.0 wheel_scroll_min_lines 0.0 3.5 C wheel_scroll_min_lines 1 P The minimum number of lines scrolled by the mouse wheel. The %scroll multiplier only takes effect after it reaches this number. Note that this is only used for low precision scrolling devices like wheel mice that scroll by very small amounts when using the wheel. With a negative number, the minimum number of lines will always be added. 0.0 touch_scroll_multiplier 0.0 3.5 C touch_scroll_multiplier 1.0 P Multiplier for the number of lines scrolled by a touchpad. Note that this is only used for high precision scrolling devices on platforms such as macOS and Wayland. Use negative numbers to change scroll direction. 0.0 mouse_hide_wait 0.0 3.5 C mouse_hide_wait 3.0 P Hide mouse cursor after the specified number of seconds of the mouse not being used. Set to zero to disable mouse cursor hiding. Set to a negative value to hide the mouse cursor immediately when typing text. Disabled by default on macOS as getting it to work robustly with the ever-changing sea of bugs that is Cocoa is too much effort. 0.0 url_color, url_style 0.0 3.5 C url_color #0087bd url_style curly P The color and style for highlighting URLs on mouse-over. %url_style can be one of: none, straight, double, curly, dotted, dashed. 0.0 open_url_with 0.0 3.5 C open_url_with default P The program to open clicked URLs. The special value default with first look for any URL handlers defined via the %Scripting the mouse click facility and if non are found, it will use the Operating System(aqs default URL handler (open on macOS and xdg-open on Linux). 0.0 url_prefixes 0.0 3.5 C url_prefixes file ftp ftps gemini git gopher http https irc ircs kitty mailto news sftp ssh P The set of URL prefixes to look for when detecting a URL under the mouse cursor. 0.0 detect_urls 0.0 3.5 C detect_urls yes P Detect URLs under the mouse. Detected URLs are highlighted with an underline and the mouse cursor becomes a hand over them. Even if this option is disabled, URLs are still clickable. 0.0 url_excluded_characters 0.0 3.5 C url_excluded_characters P Additional characters to be disallowed from URLs, when detecting URLs under the mouse cursor. By default, all characters that are legal in URLs are allowed. 0.0 copy_on_select 0.0 3.5 C copy_on_select no P Copy to clipboard or a private buffer on select. With this set to clipboard, selecting text with the mouse will cause the text to be copied to clipboard. Useful on platforms such as macOS that do not have the concept of primary selection. You can instead specify a name such as a1 to copy to a private kitty buffer. Map a shortcut with the paste_from_buffer action to paste from this private buffer. For example: 0.0 3.5 C copy_on_select a1 map shift+cmd+v paste_from_buffer a1 P Note that copying to the clipboard is a security risk, as all programs, including websites open in your browser can read the contents of the system clipboard. 0.0 paste_actions 0.0 3.5 C paste_actions quote-urls-at-prompt P A comma separated list of actions to take when pasting text into the terminal. The supported paste actions are: 0.0 quote-urls-at-prompt: If the text being pasted is a URL and the cursor is at a shell prompt, automatically quote the URL (needs %shell_integration). confirm: Confirm the paste if bracketed paste mode is not active or there is more a large amount of text being pasted. filter: Run the filter_paste() function from the file paste-actions.py in the kitty config directory on the pasted text. The text returned by the function will be actually pasted. 0.0 strip_trailing_spaces 0.0 3.5 C strip_trailing_spaces never P Remove spaces at the end of lines when copying to clipboard. A value of smart will do it when using normal selections, but not rectangle selections. A value of always will always do it. 0.0 select_by_word_characters 0.0 3.5 C select_by_word_characters @-./_~?&=%+# P Characters considered part of a word when double clicking. In addition to these characters any character that is marked as an alphanumeric character in the Unicode database will be matched. 0.0 select_by_word_characters_forward 0.0 3.5 C select_by_word_characters_forward P Characters considered part of a word when extending the selection forward on double clicking. In addition to these characters any character that is marked as an alphanumeric character in the Unicode database will be matched. If empty (default) %select_by_word_characters will be used for both directions. 0.0 click_interval 0.0 3.5 C click_interval -1.0 P The interval between successive clicks to detect double/triple clicks (in seconds). Negative numbers will use the system default instead, if available, or fallback to 0.5. 0.0 focus_follows_mouse 0.0 3.5 C focus_follows_mouse no P Set the active window to the window under the mouse when moving the mouse around. 0.0 pointer_shape_when_grabbed 0.0 3.5 C pointer_shape_when_grabbed arrow P The shape of the mouse pointer when the program running in the terminal grabs the mouse. Valid values are: arrow, beam and hand. 0.0 default_pointer_shape 0.0 3.5 C default_pointer_shape beam P The default shape of the mouse pointer. Valid values are: arrow, beam and hand. 0.0 pointer_shape_when_dragging 0.0 3.5 C pointer_shape_when_dragging beam P The default shape of the mouse pointer when dragging across text. Valid values are: arrow, beam and hand
logname(1)
return the user's login name rst2man-indent-level 0 1 rstReportMargin \$1
lwp-dump(1)
See what headers and content is returned for a URL
mispipe(1)
pipe two commands, returning the exit status of the first
return(1)
return from a function or dot script rst2man-indent-level 0 1 rstReportMargin \$1
return(1)
stop the current inner function
sccs-unedit(1)
"Undo" the last edit or `get -e', return to previous condition
serialver(1)
return the serialVersionUID for one or more classes in a form suitable for copying into an evolving class
status(nged)
Without a subcommand, the status command returns the following information: current state, view size of the current display manager, the conversion factor from local model units to the base units (mm) stored in the database, and the view matrices of the current display manager
strlen(3), strlen()(3)
returns string length
tickit_ctl_name(3)
return the name of a toplevel instance control
tickit_penattr_name(3)
return the name of a pen attribute
tickit_penattr_type(3)
return the type of a pen attribute
tickit_rect_bottom(3), tickit_rect_right(3)
return the bottom right corner of a rectangle
tickit_renderbuffer_get_size(3)
return the size of a render buffer
tickit_term_get_drivername(3)
returns the terminal driver name
tickit_term_get_termtype(3)
returns the terminal type
tickit_termctl_name(3)
return the name of a terminal control
tickit_windowctl_name(3)
return the name of a window control
title(nged)
Returns the title string for the current database or, if used with an argument, renames the database
true(1)
return a successful result
true(3)
automatically return a true value when a file is required
tslib_version(3)
simply return tslib's version string
tt_X_session(3)
return the session associated with an X window system display
tt_default_file(3)
return the current default file
tt_error_int(3)
return an integer error object that encodes the code
tt_error_pointer(3)
return a pointer to an error object that encodes the code
tt_fd(3)
return a file descriptor
tt_initial_session(3)
return the initial session identifier
tt_int_error(3)
return the status of an error object
tt_message_abstainer(3)
return offer's nth abstaining procid
tt_message_abstainers_count(3)
return a count of the offer's abstaining procids
tt_message_accepter(3)
return offer's nth accepting procid
tt_message_accepters_count(3), tt_message_accepter_count(3)
return a count of the offer's accepting procids
tt_message_arg_mode(3)
return the mode of a message argument
tt_message_arg_val(3)
return a pointer to the value of a message argument
tt_message_args_count(3)
return the number of arguments in the message
tt_message_context_slotname(3)
return the name of a message's nth context
tt_message_contexts_count(3)
return the number of contexts in a message
tt_message_pattern(3)
return the pattern matched by a message
tt_message_rejecter(3)
return offer's nth rejecting procid
tt_message_rejecters_count(3)
return a count of the offer's rejecting procids
tt_objid_objkey(3)
return the unique key of an objid
tt_open(3)
return the process identifier for the calling process
tt_otype_base(3)
return the base otype of an otype
tt_otype_derived(3)
return the ith otype derived from the given otype
tt_otype_deriveds_count(3)
return the number of otypes derived from an otype
tt_otype_hsig_arg_mode(3)
return the mode of an argument of a request signature of an otype
tt_otype_hsig_arg_type(3)
return the data type of an argument of a request signature of an otype
tt_otype_hsig_args_count(3)
return the number of arguments of a request signature of an otype
tt_otype_hsig_count(3)
return the number of request signatures for an otype
tt_otype_hsig_op(3)
return the operation name of a request signature of an otype
tt_otype_opnum_callback_add(3)
return a callback if two opnums are equal
tt_otype_osig_arg_mode(3)
return the mode of an argument of a notice signature of an otype
tt_otype_osig_arg_type(3)
return the data type of an argument of a notice signature of an otype
tt_otype_osig_args_count(3)
returns the number of arguments of a notice signature of an otype
tt_otype_osig_count(3)
return the number of notice signatures for an otype
tt_otype_osig_op(3)
return the op name of a notice signature of an otype
tt_pattern_category(3)
return the category value of a pattern
tt_pattern_user(3)
return the value in a user data cell for a pattern object
tt_pointer_error(3)
return the status of a pointer
tt_ptype_opnum_callback_add(3)
return a callback if two opnums are equal
tt_session_prop(3)
return the ith value of a session property
tt_session_prop_count(3)
return the number of values stored under a property of a session
tt_session_propname(3)
returns an element of the list of property names for a session
tt_session_propnames_count(3)
return the number of property names for the session
tt_spec_prop_count(3)
return the number of values listed in this spec property
tt_spec_propname(3)
return an element of the property name list for an object spec
tt_spec_propnames_count(3)
return the number of property names for an object
tt_spec_type(3)
return the name of the object type
units(nged)
With no arguments, will return the current type of units that MGED is using
vhier(1)
Return all files in a verilog hierarchy using Verilog::Netlist
whoseip(1)
return information about IP address
zip_compression_method_supported(3)
return if a compression method is supported
zip_encryption_method_supported(3)
return if an encryption method is supported
zip_error_system_type(3)
return type of system error
zip_error_to_data(3)
convert zip_error to return value suitable for ZIP_SOURCE_ERROR
zip_libzip_version(3)
return run-time version of library
home | help