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

FreeBSD Manual Pages


home | help
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
bus_alloc_resource(9), bus_alloc_resource_any(9), bus_alloc_resource_anywhere(9)
allocate resources from a parent bus
Intel EtherExpress PRO/100 Ethernet device driver
USB Apple iPhone/iPad tethered Ethernet driver
impersonate a user when there exist a srvtab, keyfile or KeyFile
The principal handing functions. A Kerberos principal is a email address looking string that contains to parts separeted by a @. The later part is the kerbero realm the principal belongs to and the former is a list of 0 or more components. For example lha@SU.SE host/ host/admin@H5L.ORG See the library functions here: Heimdal Kerberos 5 principal functions
locate programs
defines placement policy for certain type of windows, based on desk, window attributes, window size, etc. Useful for xinerama configurations, where windows should not be placed in between screens
Log an event in a specified MPI_Comm. (on the calling thread where the event takes place)
log the receive event of a message within a specified MPI_Comm (on the calling thread where receive event takes place)
Log the send event of a message within a specified MPI_Comm (on the calling thread where the send event takes place)
log the receive event of a message within MPI_COMM_WORLD. (on the calling thread where send event takes place)
Log the send event of a message within MPI_COMM_WORLD. (on the calling thread where send event takes place)
XXX description here
XXX description here
XXX description here
XXX description here
XXX description here
XXX description here
XXX description here
XXX description here
XXX description here
XXX description here
XXX description here
XXX description here
XXX description here
XXX description here
XXX description here
XXX description here
XXX description here
In this function, each process i gathers data items from each process j if an edge (j,i) exists in the topology graph, and each process i sends the same data items to all processes j where an edge (i,j) exists. The send buffer is sent to each neighboring process and the l-th block in the receive buffer is received from the l-th neighbor
In this function, each process i receives data items from each process j if an edge (j,i) exists in the topology graph or Cartesian topology. Similarly, each process i sends data items to all processes j where an edge (i,j) exists. This call is more general than MPI_NEIGHBOR_ALLGATHER in that different data items can be sent to each neighbor. The k-th block in send buffer is sent to the k-th neighboring process and the l-th block in the receive buffer is received from the l-th neighbor
XXX description here
XXX description here
XXX description here
XXX description here
XXX description here
XXX description here
XXX description here
XXX description here
XXX description here
XXX description here
XXX description here
XXX description here
XXX description here
XXX description here
XXX description here
XXX description here
XXX description here
XXX description here
XXX description here
XXX description here
XXX description here
XXX description here
XXX description here
XXX description here
XXX description here
XXX description here
XXX description here
XXX description here
In this function, each process i gathers data items from each process j if an edge (j,i) exists in the topology graph, and each process i sends the same data items to all processes j where an edge (i,j) exists. The send buffer is sent to each neighboring process and the l-th block in the receive buffer is received from the l-th neighbor
In this function, each process i receives data items from each process j if an edge (j,i) exists in the topology graph or Cartesian topology. Similarly, each process i sends data items to all processes j where an edge (i,j) exists. This call is more general than MPI_NEIGHBOR_ALLGATHER in that different data items can be sent to each neighbor. The k-th block in send buffer is sent to the k-th neighboring process and the l-th block in the receive buffer is received from the l-th neighbor
Agar-Math sphere structure
resets the msgstr for situations where it's just a copy of msgid
SDLmm_SRect(3), SDLmm::SRect(3)
This enhanced version of SDL_Rect includes a number of handy short-hand constructors. Since the class is derived from the SDL_Rect struct, it can be used in any context where an SDL_Rect is valid
SDLmm_todo(3), todo(3)
Todo List "Class SDLmm::SRect " 1c Extend the class with useful utility functions in regards to rectangles like intersections. "Class SDLmm::Surface " 1c Implement a better constructor scheme, where the first argument is a dummy class which specified what to do. This would allow a construct where a surface can be loaded from an image file without first having to create an unitialized object. "Class SDLmm::VideoInfo " 1c Build a status function allowing for easier access to the flags. This can be done using a bitfield which would allow for checking for multiple features at once
Tcl_CancelIdleCall.tcl85(3), Tcl_DoWhenIdle(3), Tcl_CancelIdleCall(3)
invoke a procedure when there are no pending events
Tcl_CancelIdleCall.tcl86(3), Tcl_DoWhenIdle(3), Tcl_CancelIdleCall(3)
invoke a procedure when there are no pending events
Tcl_CancelIdleCall.tcl87(3), Tcl_DoWhenIdle(3), Tcl_CancelIdleCall(3)
invoke a procedure when there are no pending events
decrement reference counts for resources
Identify where a list of stars is on the sky
particle spheres
Redirect the browser somewhere else
historically compatible Heretic engine
determine impedance of a coaxial structure, where the inner may be offset from the centre if necessary
historically compatible Heretic engine
voronoi divisions of a sphere
cual(6), Cual(6)
Cuyo Animation Language Cual is the main language used to describe the animations in cuyo. Strictly speaking it's the stuff between the << >> brackets in the level description files (xxx.ld). On the other hand this man page aims at being a complete description of how to write levels for cuyo. But it's still under construction. See the file "example.ld" to get an idea of how the rest of the level description works. There's also a bit of example Cual code in "example.ld". And of course, all the existing levels are examples. Note that Cual is probably still very buggy. So if strange things happen and you're sure it's not your fault, tell me (
shoot 'em up game where accurate shooting matters
network statistics gatherer
check if there is a usable OpenCL environment for darktable to use
decode DTS Coherent Acoustics audio streams
tethered camera control & capture
extract DTS Coherent Acoustics audio from a MPEG stream
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
<put a short description here>
<put a short description here>
<put a short description here>
animates a mesh geodesic sphere
gears on the surface of a sphere
geography(3), REarth(3), SetREarth(3), BadAngle(3), AngleIsOK(3), AngleIsBad(3), AngleFmDeg(3), AngleToDeg(3), AngleFmRad(3), AngleToRad(3), ISin(3), ICos(3), GeoPtSetDeg(3), GeoPtSetRad(3), GeoPtGetDeg(3), GeoPtGetRad(3), GeoPtIsSomewhere(3), GeoPtIsNowhere(3), GeoPtNowhere(3), MapPtIsSomewhere(3), MapPtIsNowhere(3), MapPtNowhere(3), ScaleMapPt(3), GeoStep(3), GeoDistance(3), GeoQuickDistance(3), Azimuth(3), GCircleX(3), DomainLat(3), DomainLon(3), GwchLon(3), DomainLonPt(3), GwchLonPt(3), LonCmp(3), LatCmp(3), AngleCmp(3), LonBtwn(3), LonBtwn1(3), Rotation(3), NewRotation(3), SetRotation(3), GetRotation(3), DeleteRotation(3), Rotate(3), GeoTime_CalSet(3), GeoTime_JulSet(3), GeoTime_CalToJul(3), GeoTime_JulToCal(3), GeoTime_Incr(3), GeoTime_Cmp(3), GeoTime_Diff(3)
basic geographic calculations and comparisons
read records of where key is present
change records of where key is present
lists repositories that have file content
gluSphere(3), "gluSphere(3)
draw a sphere
glutSolidSphere(3), glutWireSphere(3)
render a solid or wireframe sphere respectively
Heidelberger table macros for GNU roff nr groff_hdtbl_C n[.C] Some simple formatting macros. Note that we use '.ig' here and not a comment to make 'mandb' 2.4.1 (and probably more recent versions also) happy; otherwise the '.char' lines and the stuff which follows is included in the 'whatis' database. . [lB] F[n[.fam]][ [rB] F[n[.fam]]] [or] F[n[.fam]]||| [ell] F[n[.fam]].|.|. [oq] F[n[.fam]][oq] [cq] F[n[.fam]][cq] F CR {
print info gathered from a GStreamer log file
Crispy Heretic configuration file
Restores databases or specific shards to an InfluxDB OSS instance from the specified PATH. Complete documentation for the -portable restore method described here, and the deprecated legacy restore format, is located here:
an ipp everywhere printer application for cups
Tells if there are keypresses waiting in the input buffer. Allegro game programming library
impersonate a user when there exist a keyfile or KeyFile
Expanding kpsewhich to separately iterate over each texmf tree listed in $TEXMF
krb5_principal_intro(3), krb5_principal_introThe principal handing functions.(3)
A Kerberos principal is a email address looking string that contains two parts separated by . The second part is the kerberos realm the principal belongs to and the first is a list of 0 or more components. For example lha@SU.SE host/ host/admin@H5L.ORG See the library functions here: Heimdal Kerberos 5 principal functions
makecol15_dither(3), makecol16_dither(3)
Calculates a dithered 15 or 16-bit RGB value. Allegro game programming library
resize an image, blur, crop, despeckle, dither, draw on, flip, join, re-sample, and much more. Mogrify overwrites the original image file, whereas, convert(1) writes to a different image file
Monkeysphere client user interface
ssh and TLS authentication framework using OpenPGP Web of Trust
Monkeysphere authentication admin tool
Monkeysphere host key administration tool
Find the range where the value of a text property is the same
Determine where Usenet articles are sent
Global variable saying how many joysticks there are. Allegro game programming library
Manages a WebSphere Application Server instance
Manages a WebSphere Application Server 6 instance
OOC file finder
page_ca(3), page_caHx509 CA functions(3)
See the library functions here: hx509 CA functions
page_cert(3), page_certThe basic certificate(3)
The basic hx509 cerificate object in hx509 is hx509_cert. The hx509_cert object is representing one X509/PKIX certificate and associated attributes; like private key, friendly name, etc. A hx509_cert object is usully found via the keyset interfaces (Certificate store operations), but its also possible to create a certificate directly from a parsed object with hx509_cert_init() and hx509_cert_init_data(). See the library functions here: hx509 certificate functions
page_cms(3), page_cmsCMS/PKCS7 message functions.(3)
CMS is defined in RFC 3369 and is an continuation of the RSA Labs standard PKCS7. The basic messages in CMS is "(bu" 2 SignedData Data signed with private key (RSA, DSA, ECDSA) or secret (symmetric) key "(bu" 2 EnvelopedData Data encrypted with private key (RSA) "(bu" 2 EncryptedData Data encrypted with secret (symmetric) key. "(bu" 2 ContentInfo Wrapper structure including type and data. See the library functions here: hx509 CMS/pkcs7 functions
page_env(3), page_envHx509 environment functions(3)
See the library functions here: hx509 environment functions
page_error(3), page_errorHx509 error reporting functions(3)
See the library functions here: hx509 error functions
page_keyset(3), page_keysetCertificate store operations(3)
Type of certificates store: "(bu" 2 MEMORY In memory based format. Doesnt support storing. "(bu" 2 FILE FILE supports raw DER certicates and PEM certicates. When PEM is used the file can contain may certificates and match private keys. Support storing the certificates. DER format only supports on certificate and no private key. "(bu" 2 PEM-FILE Same as FILE, defaulting to PEM encoded certificates. "(bu" 2 PEM-FILE Same as FILE, defaulting to DER encoded certificates. "(bu" 2 PKCS11 "(bu" 2 PKCS12 "(bu" 2 DIR "(bu" 2 KEYCHAIN Apple Mac OS X KeyChain backed keychain object. See the library functions here: hx509 certificate store functions
page_lock(3), page_lockLocking and unlocking certificates and encrypted data.(3)
See the library functions here: hx509 lock functions
page_name(3), page_namePKIX/X.509 Names(3)
There are several names in PKIX/X.509, GeneralName and Name. A Name consists of an ordered list of Relative Distinguished Names (RDN). Each RDN consists of an unordered list of typed strings. The types are defined by OID and have long and short description. For example id-at-commonName ( have the long name CommonName and short name CN. The string itself can be of several encoding, UTF8, UTF16, Teltex string, etc. The type limit what encoding should be used. GeneralName is a broader nametype that can contains al kind of stuff like Name, IP addresses, partial Name, etc. Name is mapped into a hx509_name object. Parse and string name into a hx509_name object with hx509_parse_name(), make it back into string representation with hx509_name_to_string(). Name string are defined rfc2253, rfc1779 and X.501. See the library functions here: hx509 name functions
page_peer(3), page_peerHx509 crypto selecting functions(3)
Peer info structures are used togeter with hx509_crypto_select() to select the best avaible crypto algorithm to use. See the library functions here: hx509 certificate selecting functions
page_print(3), page_printHx509 printing functions(3)
See the library functions here: hx509 printing functions
page_revoke(3), page_revokeRevocation methods(3)
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
Quickly find packages where trees of files got installed
generate strips to glue onto a sphere synopsis
REGister Globaly Access Everywhere is a package which helps in common DevOps tasks
sc_ProcThreadGrp(3), sc::ProcThreadGrp(3)
The ProcThreadGrp class privides a concrete thread group appropriate for an environment where there is only one thread
sc_PthreadThreadGrp(3), sc::PthreadThreadGrp(3)
The PthreadThreadGrp class privides a concrete thread group appropriate for an environment where pthreads is available
sc_R12IntsAcc(3), sc::R12IntsAcc(3)
R12IntsAcc accumulates transformed (MO) integrals stored as (ijxy) where i, j, x, and, y lie in spaces I, J, X, and Y, respectively
sc_SCException(3), sc::SCException(3)
This is a std::exception specialization that records information about where an exception took place
sc_VDWShape(3), sc::VDWShape(3)
The VDWShape class describes the surface of a molecule as the union of atom centered spheres, each the van der Waals radius of the atom
display traceroute paths where the path has changed
Gets the directory where the current script lives
Pigeonhole(aqs Sieve mailbox filter tool WARNING: This tool is still experimental. Read this manual carefully, and backup any important mail before using this tool. Also note that some of the features documented here are not actually implemented yet; this is clearly indicated where applicable
3d spherical harmonic shapes
k A geodesic sphere experiences a series of eruptions
remove pattern from end of str, if it is there
remove pattern from beginning of string, if it is there
return I am not here indication
enable running of the program while there is no VGA access
Wherever Change Directory chdir for DOS and Unix
print summary of make world logs
locate the binary, source, and manual page files for a command
a Doom/Heretic/Strife level editor
indicate if there are more message parts to receive
informal introduction to the zsh manual The Zsh Manual, like the shell itself, is large and often complicated. This section of the manual provides some pointers to areas of the shell that are likely to be of particular interest to new users, and indicates where in the rest of the manual the documentation is to be found
Some exception was thrown somewhere Subclass of AnyEvent::XMPP::Error
General utilities for yath that do not fit anywhere else
Configuration items which need to be saved across the lifetime of a Biber object This class contains a static object and static methods to access configuration and state data. There are several classes of data in here which have separate accessors: * Biber options * Biblatex options * State information used by Biber as it processes entries * displaymode date
keeps track of where the tentmaker templates live
Keep track of where to find ontologies. Allows lookups by name
Object for the local execution of the NCBI BLAST program suite (blastall, blastpgp, bl2seq). There is experimental support for WU-Blast and NCBI rpsblast
Catch application errors and emit them somewhere
deep_search_where() for Class::DBI
(NBS/ISCC P) Plochere Color System
Role to grab data from elsewhere in the tree
Emulates the behavior of Class::DBI where the object can be accessed as a hash of columns
Where your Sandbox Database Lives
Where your migration files live
Pre-ANSI Joins-via-Where-Clause Syntax
ODBC wrapper for DBIx::Class::Schema::Loader::DBI::SQLAnywhere
DBIx::Class::Schema::Loader::DBI SQL Anywhere Implementation
DBIx::Class::Schema::Loader::Optional::Dependencies(3), $class(3)
Optional module dependency specifications (for module authors) EOC #@@ #@@ SYNOPSIS HEADING #@@ push @chunks, <<"EOC"; =head1 SYNOPSIS Somewhere in your build-file (e.g. ExtUtils::MakeMaker's Makefile.PL): ... e$EUMM_ARGS{CONFIGURE_REQUIRES} = { e%{ e$EUMM_ARGS{CONFIGURE_REQUIRES} || {} }, DBIx::Class::Schema::Loader => $distver, }; ... my %DBIC_CONFIG_AND_ORACLE_DEPS = %{ eval { require $class; $class->req_list_for([qw( dbicdump_config rdbms_oracle )]); } || {} }; e$EUMM_ARGS{PREREQ_PM} = { e%DBIC_CONFIG_AND_ORACLE_DEPS, e%{ e$EUMM_ARGS{PREREQ_PM} || {} }, }; ... ExtUtils::MakeMaker::WriteMakefile(e%EUMM_ARGS); Note: The eval protection within the example is due to support for requirements during the configure build phase not being available on a sufficient portion of production installations of Perl. Robust support for such dependency requirements is available in the CPAN installer only since version 1.94_56 first made available for production with perl version 5.12. It is the belief of the current maintainer that support for requirements during the configure build phase will not be sufficiently ubiquitous until the year 2020 at the earliest, hence the extra care demonstrated above. It should also be noted that some 3rd party installers (e.g. cpanminus) do the right thing with configure requirements independent from the versions of perl and CPAN available. EOC #@@ #@@ DESCRIPTION HEADING #@@ push @chunks, <<'EOC'; =head1 DESCRIPTION Some of the less-frequently used features of DBIx::Class::Schema::Loader have external module dependencies on their own. In order not to burden the average user with modules they will never use, these optional dependencies are not included in the base Makefile.PL. Instead an exception with a descriptive message is thrown when a specific feature can't find one or several modules required for its operation. This module is the central holding place for the current list of such dependencies, for DBIx::Class::Schema::Loader core authors, and DBIx::Class::Schema::Loader extension authors alike. Dependencies are organized in groups where each group can list one or more required modules, with an optional minimum version (or 0 for any version). In addition groups prefixed with test_ can specify a set of environment variables, some (or all) of which are marked as required for the group to be considered by req_list_for Each group name (or a combination thereof) can be used in the public methods as described below. EOC #@@ #@@ REQUIREMENT GROUPLIST HEADING #@@ push @chunks, '=head1 CURRENT REQUIREMENT GROUPS'; my $standalone_info; for my $group (sort keys %$dbic_reqs) { my $info = $standalone_info->{$group} ||= $class->_groups_to_reqs($group); next unless ( $info->{modreqs_fully_documented} and ( $info->{augments} or $info->{modreqs} ) ); my $p = $dbic_reqs->{$group}{pod}; push @chunks, ( "=head2 $p->{title}", "=head3 $group", $p->{desc}, =over, ); if ( keys %{ $info->{modreqs}||{} } ) { push @chunks, map { "=item * $_" . ($info->{modreqs}{$_} ? " >= $info->{modreqs}{$_}" : ) } ( sort keys %{ $info->{modreqs} } ) ; } else { push @chunks, =item * No standalone requirements, } push @chunks, =back; for my $ag ( sort keys %{ $info->{augments} || {} } ) { my $ag_info = $standalone_info->{$ag} ||= $class->_groups_to_reqs($ag); my $newreqs = $class->modreq_list_for([ $group, $ag ]); for (keys %$newreqs) { delete $newreqs->{$_} if ( ( defined $info->{modreqs}{$_} and $info->{modreqs}{$_} == $newreqs->{$_} ) or ( defined $ag_info->{modreqs}{$_} and $ag_info->{modreqs}{$_} == $newreqs->{$_} ) ); } if (keys %$newreqs) { push @chunks, ( "Combined with L</$ag> additionally requires:", =over, ( map { "=item * $_" . ($newreqs->{$_} ? " >= $newreqs->{$_}" : ) } ( sort keys %$newreqs ) ), =back, ); } } } #@@ #@@ API DOCUMENTATION HEADING #@@ push @chunks, <<'EOC';
Driver for using Sybase SQL Anywhere through ODBC
Oracle joins in WHERE syntax support (instead of ANSI)
Driver for SQL Anywhere
GUID Support for SQL Anywhere over DBD::SQLAnywhere
Where clause
Identify where print output comes from
indicate where leaked variables are coming from
See where you code warns and dies using stack traces
run stuff in a dir where your dist is built
a plugin to remove gathered prereqs
something that gathers files into the distribution
Add line numbers to heredoc blocks that contain perl source code
install files from here to there
Utility functions for AAT tables n .SS "($classes, $states) = AAT_read_subtable($fh, $baseOffset, $subtableStart, $limits)" .SS "($classes, $states) = AAT_read_subtable($fh, $baseOffset, $subtableStart, $limits)" Subsection "($classes, $states) = AAT_read_subtable($fh, $baseOffset, $subtableStart, $limits)" n .SS "$length = AAT_write_state_table($fh, $classes, $states, $numExtraTables, $packEntry)" .SS "$length = AAT_write_state_table($fh, $classes, $states, $numExtraTables, $packEntry)" Subsection "$length = AAT_write_state_table($fh, $classes, $states, $numExtraTables, $packEntry)" $packEntry is a subroutine for packing an entry into binary form, called as $dat = $packEntry($entry, $entryTable, $numEntries) where the entry is a comma-separated list of nextStateOffset, flags, actions n .SS "($classes, $states, $entries) = AAT_read_state_table($fh, $numActionWords)" .SS "($classes, $states, $entries) = AAT_read_state_table($fh, $numActionWords)" Subsection "($classes, $states, $entries) = AAT_read_state_table($fh, $numActionWords)" n .SS "($format, $lookup) = AAT_read_lookup($fh, $valueSize, $length, $default)" .SS "($format, $lookup) = AAT_read_lookup($fh, $valueSize, $length, $default)" Subsection "($format, $lookup) = AAT_read_lookup($fh, $valueSize, $length, $default)" n .SS "AAT_write_lookup($fh, $format, $lookup, $valueSize, $default)" .SS "AAT_write_lookup($fh, $format, $lookup, $valueSize, $default)" Subsection "AAT_write_lookup($fh, $format, $lookup, $valueSize, $default)"
Frequently Asked Questions regarding Gantry::Conf "Why should I use Gantry::Conf at all?" 4 Item "Why should I use Gantry::Conf at all?" There are many reasons why we feel Gantry::Conf is helpful both during development and after deployment. The next two entries should hopefully answer this question for you as they outline a few common scenarios programmers and system administrators often face. "How is Gantry::Conf helpful during development?" 4 Item "How is Gantry::Conf helpful during development?" "Easy separation of development configs from production configs" 4 Item "Easy separation of development configs from production configs" Often programmers have a separate development environment from their production environment. By using <shared> blocks and dev instances you can avoid spending any serious time setting up your application in the development environment. Take this configuration example: <shared dev> dbuser nobody dbpass secret dbconn "dbi:Pg:dbname=dev" </shared> <shared production> dbuser apache dbpass secret2 dbconn "dbi:Pg:dbname=production" </shared> <instance app1> ConfigureVia FlatFile Config::General /etc/apps/app1.conf use production </instance> <instance app1-dev> ConfigureVia FlatFile Config::General /etc/apps/app1.conf use dev </instance> By separating out our production and dev database information into shared blocks we can essentially switch between our production and dev environments by simply changing the instance we are using. If you were working on a script this would be a simple matter of running: $ --instance=app1-dev instead of: $ --instance=app1 "How is Gatnry::Conf helpful in production?" 4 Item "How is Gatnry::Conf helpful in production?" Gantry::Conf has several advantages in a production environment. First, it provides a single place for all config information, if you commit to it. Even if you don't commit to it for all apps, it still provides control to the installing admin over how and where conf information is stored. For instance, the admin could put the config information directly into /etc/gantry.conf, or into a separate file in /etc/gantry.d. She could even set up a secure web server where all boxes would go to get their conf. The short answer is, Gantry::Conf is flexible and production environments benefit from flexibility. "How do I pass my instance information into my application?" 4 Item "How do I pass my instance information into my application?" There are many possible ways to do this a few of which are: "Command line arguments" 4 Item "Command line arguments" If your application accepts arguments on the command line we suggest adding an --instance option to pass in the instance's name. "PerlSetVar" 4 Item "PerlSetVar" In a mod_perl environment you could use a PerlSetVar, possibly named GantryConfInstance, to pull in this value for your application. "ModPerl::ParamBuilder" 4 Item "ModPerl::ParamBuilder" Again in a mod_perl environment, another option would be to use ModPerl::ParamBuilder to pass the instance name. "Hard coded" 4 Item "Hard coded" We include this for the sake of completeness, but advise against it. You could always simply hard code your instance information into your application, but this will greatly reduce the flexibility you have. "How do I add a different provider for an existing ConfigVia method?" 4 Item "How do I add a different provider for an existing ConfigVia method?" Place your provider module in the Gantry::Conf::Provider::Method::* namespace. Make sure your public API matches the existing providers which use the same method. For instance the flat file providers all implement a config method which is called as a class method and receives a file name. "How do I add to the ConfigVia methods?" 4 Item "How do I add to the ConfigVia methods?" If none of the existing provider methods will do, you need to work in Gantry::Conf. In particular, you need to augment the dispatch hash with the name of your provisioning method and a sub name which will handle it. Then you need to implement the method you put in %dispatch
Model the Team: who? what? why? where? how?
Process very simple ThereDocs --- looking for Things!
Like ThereDocs except they execute inline
Process ThereDocs embedded in Perl5 programs
Process ThereDocs embedded Perl modules
Gungho FAQ n .SH "Q. ""Why Did You Call It Gungho""?" .SH "Q. ``Why Did You Call It Gungho''?" Header "Q. Why Did You Call It Gungho?" It rhymes with Xango, which is its predecessor. n .SH "Q. ""I don't understand the notation of the config""" .SH "Q. ``I don't understand the notation of the config''" Header "Q. I don't understand the notation of the config" To make the notation concise, we use a notation like engine.module = POE. Each level is a key in the hash, so the previous example translates to a config like my $config = { engine => { module => "POE" } } Or, in YAML: engine: module: POE n .SH "Q. ""My requests are being served slow. What can I do?""" .SH "Q. ``My requests are being served slow. What can I do?''" Header "Q. My requests are being served slow. What can I do?" There are actually a number of things that may affect fetch speed
For When Template Systems Are Too Huge And Heredocs Too Messy
methods that produce images where every pixel is a function of all pixels in the source image
methods that produce images where every pixel is a function of pixels in the neighborhood
a perl module that implements an object storage space where data is persisted across process boundaries
Handler for IBM Websphere
There And Back Again
Jifty coding style guide Default style Subsection "Default style" When in doubt, default to whatever Damian Conway's Perl Best Practices says. Private documentation Subsection "Private documentation" When documenting a private method, or providing documentation which is not useful to the user of the module (and is presumably useful to the developer), wrap it in =begin/end private. This way it does not show up in perldoc where a user would see it and yet is still available and well formatted (that is, not just a lump comment) when looking at the code. =begin private =head2 import_extra Called by L<Test::More>s C<import> code when L<Jifty::Test> is first C<use>d, it calls L</setup>, and asks Test::More to export its symbols to the namespace that C<use>d this one. =end private sub import_extra { ... } Test temp files Subsection "Test temp files" Files created by tests should be declared as such using Jifty::Test->test_file() so they are cleaned up on a successful test run. Use Shell::Command Subsection "Use Shell::Command" Shell::Command has a number of functions which work like common shell file commands such as touch, cp and mv. They are battle tested and cross-platform. Use them instead of coding your own. For example, instead of this: open my $file, ">foo"; close $file; Do this: use Shell::Command; touch $file; Case insensitive matching Subsection "Case insensitive matching" To check if a string equals another string case insensitively, do this lc $foo eq lc $bar; lc $foo eq bar; not this: $foo =~ /^eQ$bareE/i; $foo =~ /^bar$/i;
Things that don't fit anywhere else
Tell Log::Any where to send its logs
Returns 1 if there is CUDA aware support and 0 if there is not
Math::Expr::FormulaDB(3), Math::Expr::FormulaDB(3)
A db of formulas and there properties
Math::Expr::TypeDB(3), Math::Expr::TypeDB(3)
A db of basic type and there properties
Math::Expr::VarSet(3), Math::Expr::VarSet(3)
Represents a set of variables and there values
Search where an element lies in a list of sorted elements
Checks if there is a license
There be dragons here
all constants are defined here
Some exception was thrown somewhere Subclass of Net::XMPP2::Error
Used to assemble an SQL WHERE condition regarding dates that assures the strictest date range is used
Token class for the here-doc
Finds where a variable was declared using PPI
Find a development path somewhere in an upper hierarchy
A problem for which there is no specialized information
Use concatenation or HEREDOCs instead of literal line breaks in strings
Don't write " print <<_|_END_|_ "
Write " print <<THE_END " or " print <<"THE_END" "
Write " <<THE_END; " instead of " <<theEnd; "
gather related paragraphs under a shared header
extension defining a virtual SRPC client or server class
SNMP Interface to Firewall Services Modules for features not covered elsewhere
SOAP::WSDL::Manual::CodeFirst(3), CodeFirst(3)
Writing Code-First Web Services with SOAP::WSDL Note: This document is just a collection of thought. There's no implementation yet
turn free-text queries into SQL WHERE clauses
Comments that do more than just sit there
A class to represent where a type or coercion was declared
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
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
make sure there is always one invocation of a script active
SyslogScan::WhereIs(3), SyslogScan::WhereIs::guess(3)
-- return full path of syslog file where mail messages are logged
Parsing harness related environmental variables where appropriate
what there is to be improved in Tangram
Implements a Hash where the key is a subnet
Where dead link-shortening services go
Searches through the one-line usage messages for each mged command and displays the name of each command where a match is found
Searches through the one-line usage messages for a specified BRL-CAD library interface command and displays the name of each command where a match is found
bk-findmerge(1), bk findmerge(1)
show where two revisions where merged
bk-here(1), bk here(1)
list or change the set of populated repositories bk populate - add one or more components to a nested collection bk unpopulate - remove one or more components to a nested collection
bk-names(1), bk names(1)
put files where they should be
d.where(1), d.where (1)
Identifies the geographic coordinates associated with point locations given in display coordinates
db.copy(1), db.copy (1)
Copy a table. Either (cqfrom_table(cq (optionally with (cqwhere(cq) can be used or (cqselect(cq option, but not (cqfrom_table(cq and (cqselect(cq at the same time
i.aster.toar(1), i.aster.toar (1)
Calculates Top of Atmosphere Radiance/Reflectance/Brightness Temperature from ASTER DN
i.landsat.toar(1), i.landsat.toar (1)
Calculates top-of-atmosphere radiance or reflectance and temperature for Landsat MSS/TM/ETM+/OLI
Changes the name of old_name to new_name wherever it occurs in the database
v.lrs.where(1), v.lrs.where (1)
Finds line id and real km+offset for given points in vector map using linear reference system
home | help