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

FreeBSD Manual Pages

  
 
  

home | help
SDT(9)
a DTrace framework for adding statically-defined tracing probes
dwarf_add_typename(3)
add information about a user-defined type to a DWARF producer instance
dwarf_get_pubtypes(3), dwarf_pubtype_cu_offset(3), dwarf_pubtype_die_offset(3), dwarf_pubtype_name_offsets(3), dwarf_pubtypename(3)
retrieve information about user-defined types
dwarf_get_types(3), dwarf_type_cu_offset(3), dwarf_type_die_offset(3), dwarf_type_name_offsets(3), dwarf_typename(3)
retrieve information about user-defined types
dwarf_set_frame_cfa_value(3), dwarf_set_frame_rule_initial_value(3), dwarf_set_frame_rule_table_size(3), dwarf_set_frame_same_value(3), dwarf_set_frame_undefined_value(3)
set internal register rule table parameters
geom_map(4)
GEOM module that maps defined items as separate partitions
key_defined(3)
check if a keycode is defined
user_caps(5)
user-defined terminfo capabilities
zfsprops(7)
native and user-defined properties of ZFS datasets
ALLEGRO_DATE(3)
Defined to a number with the release date of Allegro
ALLEGRO_DATE_STR(3)
Defined to a string with the year Allegro was released
ALLEGRO_SUB_VERSION(3)
Defined to the middle version of Allegro
ALLEGRO_VERSION(3)
Defined to the major version of Allegro
ALLEGRO_VERSION_STR(3)
Defined to a string with the full Allegro version number
ALLEGRO_WIP_VERSION(3)
Defined to the minor version of Allegro
BSfinalize(3)
Finalizes BlockSolve and MPI. Prints the log stuff if MLOG was defined
BSprint_log(3)
Print log stuff if MLOG is defined
Constants(3)
Meaning of MPI's defined constants
MPI_Grequest_complete(3)
Notify MPI that a user-defined request is complete
MPI_Grequest_start(3)
Create and return a user-defined request
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_Op_create(3)
Creates a user-defined combination function handle
MPI_Op_free(3)
Frees a user-defined combination function handle
MPI_Register_datarep(3)
Register functions for user-defined data representations
MrmRegisterClass(3)
Saves the information needed for MRM to access the widget creation function for user-defined widgets "MrmRegisterClass" "uil functions" "MrmRegisterClass"
Munin::Common::Defaults(3)
Default values defined by installation scripts
PQregisterResult(3)
Registers sub-classes, composites and user-defined types found within a PGresult
PQregisterTypes(3)
Registers sub-classes, composites and user-defined types
PQregisterUserDefinedTypes(3)
Registers a user-defined types
RELEASE_SAVEPOINT(7)
destroy a previously defined savepoint
RkDefineDic(3)
define specified candidates in the dictionary
SDL_UserEvent(3)
A user-defined event type
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
asn1_expand_any_defined_by(3)
API function
checkalias(1)
check to see if an alias is defined
cursor_setstorage(3), cursor_setstorage (3)
Use the storage defined by one video object as an accelerated mouse cursor
gnome-screenshot(1)
capture the screen, a window, or an user-defined area and save the snapshot image to a file
gqrx(1)
Software Defined Radio GUI application
gtimer(1)
an application for recording time spent on user-defined tasks
hxunent(1)
replace HTML predefined character entities by UTF-8
key_defined(3x)
check if a keycode is defined
lis_solve_kernel(3)
solve the linear equation with the predefined preconditioner
lis_solve_kernel(3f)
solve the linear equation with the predefined preconditioner
lou_checkyaml(1)
A tool to check Braille tests defined in a YAML file
mate-screenshot(1)
capture the screen, a window, or an user-defined area and save the snapshot image to a file
ocf_heartbeat_Delay(7)
Waits for a defined timespan
openssl_user_macros(7ossl), OPENSSL_API_COMPAT(7ossl), OPENSSL_NO_DEPRECATED(7ossl)
User defined macros
p11sak_defined_attrs.conf(5)
Configuration file for p11sak list-key command
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_name(3), page_namePKIX/X.509 Names(3)
There are several names in PKIX/X.509, GeneralName and Name. A Name consists of an ordered list of Relative Distinguished Names (RDN). Each RDN consists of an unordered list of typed strings. The types are defined by OID and have long and short description. For example id-at-commonName (2.5.4.3) have the long name CommonName and short name CN. The string itself can be of several encoding, UTF8, UTF16, Teltex string, etc. The type limit what encoding should be used. GeneralName is a broader nametype that can contains al kind of stuff like Name, IP addresses, partial Name, etc. Name is mapped into a hx509_name object. Parse and string name into a hx509_name object with hx509_parse_name(), make it back into string representation with hx509_name_to_string(). Name string are defined rfc2253, rfc1779 and X.501. See the library functions here: hx509 name functions
panda_setlinedashing(3)
draw the subsequent lines with the defined dashing pattern
pfsinhdrgen(1)
Create a pfs stream with different exposures defined by hdrgen script
play_looped_midi(3)
Starts playing a MIDI file with a user-defined loop position. Allegro game programming library
pmapfilter(3)
User-defined labels for IPs and protocol/port pairs
sc_TwoBodyMOIntsTransform_MOSpaces(3), sc::TwoBodyMOIntsTransform::MOSpaces(3)
Predefined enumerated type for the MO spaces
shtk_config_get(3)
Gets the value of a defined configuration variable
shtk_config_run_hook(3)
Executes a hook defined in a configuration file
tpm2_nvreadpublic(1), tpm2_nvreadpublic(1)(1)
Display all defined Non-Volatile (NV)s indices
user_caps(5)
user-defined terminfo capabilities
wnsearch(3), findtheinfo(3)
findtheinfo_ds, is_defined, in_wn, index_lookup, parse_index, getindex, read_synset, parse_synset, free_syns, free_synset, free_index, traceptrs_ds, do_trace
xcbautolock(1)
run a command after a user defined time of inactivity
xlsatoms(1)
list interned atoms defined on server
yuvinactive(1)
Set a part of the video to a defined state
zfsprops(7)
native and user-defined properties of ZFS datasets
Bio::MAGETAB::Comment(3)
MAGE-TAB user-defined comment class
CAD::Drawing::Defined(3)
exported constants for CAD::Drawing::*
Crypt::JWT(3)
JSON Web Token (JWT, JWS, JWE) as defined by RFC7519, RFC7515, RFC7516
Crypt::KeyWrap(3)
Key management/wrapping algorithms defined in RFC7518 (JWA)
DBIx::Class::DeploymentHandler::VersionStorage::Deprecated::VersionResultSet(3)
(DEPRECATED) Predefined searches to find what you want from the version storage
DBIx::Class::DeploymentHandler::VersionStorage::Standard::VersionResultSet(3)
Predefined searches to find what you want from the version storage
DBIx::Class::Helper::ResultSet::Me(3)
Define predefined searches more nicely
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';
DateTime::Locale::FromData(3)
Class for locale objects instantiated from pre-defined data
Devel::REPL::Plugin::FancyPrompt(3)
Facilitate user-defined prompts
DtWsmGetWorkspaceList(3)
get the names of the currently defined workspaces
Google::Chart::Type::XY(3)
Google::Chart XY Line Type In charts of this type, each drawn line is defined by a pair of data sets, one of X coordinates and one for Y coordinates. See the API documentation at http://code.google.com/apis/chart/types.html#line_charts for details
JE::Undefined(3)
JavaScript undefined value
Log::Agent::Tag_List(3)
user-defined tags to add to every log
Log::Log4perl::Level(3)
Predefined log levels
Log::Syslog::Constants(3)
Perl extension containing syslog priority constants as defined in RFC3164
MPI_Buffer_attach(3)
Attaches a user-defined buffer for sending
MPI_Info_get_nkeys(3)
Gets the number of keys currently defined in an info object
MPI_Info_get_nthkey(3)
Returns the nth defined key in info
MPI_Op_create(3)
Creates a user-defined combination function handle
MPI_Op_free(3)
Frees a user-defined combination function handle
Math::Symbolic::Custom::Simplification(3)
User defined simplification routines
Maypole::Constants(3)
Maypole predefined constants
Memcached::libmemcached::constants(3)
document list of constants defined by libmemcached
Moose::Autobox::Defined(3)
the Defined role
MooseX::Types::UndefinedType(3)
a fallback type for when a type cannot be found
Net::Blogger::API::Extended(3)
provides helper methods not defined in the Blogger API
Net::Google::Code::Role::Predefined(3)
Predefined Role
Net::SinFP::Consts(3)
all constants are defined here
Paws::Glue::CreateUserDefinedFunction(3)
Arguments for method CreateUserDefinedFunction on Paws::Glue
Paws::Glue::DeleteUserDefinedFunction(3)
Arguments for method DeleteUserDefinedFunction on Paws::Glue
Paws::Glue::GetUserDefinedFunction(3)
Arguments for method GetUserDefinedFunction on Paws::Glue
Paws::Glue::GetUserDefinedFunctions(3)
Arguments for method GetUserDefinedFunctions on Paws::Glue
Paws::Glue::UpdateUserDefinedFunction(3)
Arguments for method UpdateUserDefinedFunction on Paws::Glue
Perl::Critic::Policy::Subroutines::ProhibitReturnSort(3)
Behavior of "sort" is not defined if called in scalar context
Perl::Critic::Policy::ValuesAndExpressions::ProhibitUnknownBackslash(3)
don't use undefined backslash forms
PerlX::Maybe(3)
return a pair only if they are both defined
Prima::Const(3)
predefined constants
SOAP::Defs(3)
Spec-defined constants
SQL::Statement::Functions(3)
built-in & user-defined SQL functions
SQL::Translator::Role::BuildArgs(3)
Remove undefined constructor arguments
SWF::Constants(3)
Constants defined in ming
Sisimai::RFC1894(3)
DSN field defined in RFC3464 (obsoletes RFC1894)
Sisimai::Reason::Undefined(3)
Sisimai could not detect the error reason
Solr::Schema(3)
Reads user defined fields from solr config file schema.xml
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
Template::Plugin::Assert(3)
trap undefined values
Template::Semantic::Filter(3)
Template::Semantic Defined filters
Test2::Compare::Undef(3)
Check that something is undefined
Tk::Optionmenu(3)
Let the user select one of some predefined options values
Tk::demos::widget_lib::trace2(3), Tk::TraceText(3)
Text contents defined by a traced variable
Types::Core(3)
Core types defined as tests and literals (ease of use)
Variable::Magic(3)
Associate user-defined magic to variables from Perl
X11::AtomConstants(3)
-- predefined X11 atoms
XML::Compile::Schema::Specs(3)
Predefined Schema Information
XML::Compile::WSDL11(3)
create SOAP messages defined by WSDL 1.1
XML::Handler::Subs(3)
a PerlSAX handler base class for calling user-defined subs
XMLTV::Augment(3)
Augment XMLTV listings files with automatic and user-defined rules
ansible-playbook(1)
Runs Ansible playbooks, executing the defined tasks on the targeted hosts. rst2man-indent-level 0 1 rstReportMargin \$1
bk-templates(1), bk templates(1)
predefined templates for comments
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 options: -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.26.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. (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: True) certificates: List certificates managed by Certbot delete: Options for deleting a certificate revoke: Options for revocation of certificates --reason {unspecified,keycompromise,affiliationchanged,superseded,cessationofoperation} Specify reason for revoking certificate. (default: unspecified) --delete-after-revoke Delete certificates after revoking them, along with all previous and later versions of those certificates. (default: None) --no-delete-after-revoke Do not delete certificates after revoking them. This option should be used with caution because the (aqrenew(aq subcommand will attempt to renew undeleted revoked certificates. (default: None) register: Options for account registration --register-unsafely-without-email Specifying this flag enables registering an account with no email address. This is strongly discouraged, because you will be unable to receive notice about impending expiration or revocation of your certificates or problems with your Certbot installation that will lead to failure to renew. (default: False) -m EMAIL, --email EMAIL Email used for registration and recovery contact. Use comma to register multiple emails, ex: u1@example.com,u2@example.com. (default: Ask). --eff-email Share your e-mail address with EFF (default: None) --no-eff-email Don(aqt share your e-mail address with EFF (default: None) update_account: Options for account modification unregister: Options for account deactivation. --account ACCOUNT_ID Account ID to use (default: None) install: Options for modifying how a certificate is deployed rollback: Options for rolling back server configuration changes --checkpoints N Revert configuration N number of checkpoints. (default: 1) plugins: Options for the "plugins" subcommand --init Initialize plugins. (default: False) --prepare Initialize and prepare plugins. (default: False) --authenticators Limit to authenticator plugins only. (default: None) --installers Limit to installer plugins only. (default: None) update_symlinks: Recreates certificate and key symlinks in /etc/letsencrypt/live, if you changed them by hand or edited a renewal configuration file enhance: Helps to harden the TLS configuration by adding security enhancements to already existing configuration. 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
d.background(1), d.background (1)
Fills the graphics display frame with user defined color
d.erase(1), d.erase (1)
Erases the contents of the active graphics display frame with user defined color
dtudcfonted(1)
Edit user-defined characters
erlang(3)
The Erlang BIFs and predefined types
fmtinstall(3), dofmt(3), dorfmt(3), fmtprint(3), fmtvprint(3), fmtrune(3), fmtstrcpy(3), fmtrunestrcpy(3), fmtfdinit(3), fmtfdflush(3), fmtstrinit(3), fmtstrflush(3), runefmtstrinit(3), runefmtstrflush(3), errfmt(3)
support for user-defined print formats and output routines
g.gisenv(1), g.gisenv (1)
Outputs and modifies the user(cqs current GRASS variable settings. Prints all defined GRASS variables if no option is given
kvalid_bit(3), kvalid_date(3), kvalid_double(3), kvalid_email(3), kvalid_int(3), kvalid_string(3), kvalid_stringne(3), kvalid_udouble(3), kvalid_uint(3)
predefined validation functions for kcgi
odf_set_fields(1)
Set names & values for user-defined fields
perlvar(1)
Perl predefined variables
r.profile(1), r.profile (1)
Outputs the raster map layer values lying on user-defined line(s)
r.surf.random(1), r.surf.random (1)
Produces a raster surface map of uniform random deviates with defined range
r.transect(1), r.transect (1)
Outputs raster map layer values lying along user defined transect line(s)
r3.retile(1), r3.retile (1)
Retiles an existing 3D raster map with user defined x, y and z tile size
rex(1)
execute tasks defined in a Rexfile
t.rast.aggregate(1), t.rast.aggregate (1)
Aggregates temporally the maps of a space time raster dataset by a user defined granularity
tickit_pen_is_nonempty(3), tickit_pen_is_nondefault(3)
test if a pen has attributes defined
tv_augment(1)
Augment XMLTV listings files with automatic and user-defined rules
v.extrude(1), v.extrude (1)
Extrudes flat vector features to 3D vector features with defined height. Optionally the height can be derived from sampling of elevation raster map
v.mkgrid(1), v.mkgrid (1)
Creates a vector map of a user-defined grid
home | help