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

FreeBSD Manual Pages

  
 
  

home | help
_exit(2)
terminate the calling process
_nc_freeall(3), _nc_free_and_exit(3), _nc_free_tinfo(3)
curses memory-leak checking
at_quick_exit(3)
registers a cleanup function to run on quick exit
atexit(3)
register a function to be called on exit
atf-c(3), ATF_CHECK(3), ATF_CHECK_MSG(3), ATF_CHECK_EQ(3), ATF_CHECK_EQ_MSG(3), ATF_CHECK_MATCH(3), ATF_CHECK_MATCH_MSG(3), ATF_CHECK_STREQ(3), ATF_CHECK_STREQ_MSG(3), ATF_CHECK_ERRNO(3), ATF_REQUIRE(3), ATF_REQUIRE_MSG(3), ATF_REQUIRE_EQ(3), ATF_REQUIRE_EQ_MSG(3), ATF_REQUIRE_MATCH(3), ATF_REQUIRE_MATCH_MSG(3), ATF_REQUIRE_STREQ(3), ATF_REQUIRE_STREQ_MSG(3), ATF_REQUIRE_ERRNO(3), ATF_TC(3), ATF_TC_BODY(3), ATF_TC_BODY_NAME(3), ATF_TC_CLEANUP(3), ATF_TC_CLEANUP_NAME(3), ATF_TC_HEAD(3), ATF_TC_HEAD_NAME(3), ATF_TC_NAME(3), ATF_TC_WITH_CLEANUP(3), ATF_TC_WITHOUT_HEAD(3), ATF_TP_ADD_TC(3), ATF_TP_ADD_TCS(3), atf_tc_get_config_var(3), atf_tc_get_config_var_wd(3), atf_tc_get_config_var_as_bool(3), atf_tc_get_config_var_as_bool_wd(3), atf_tc_get_config_var_as_long(3), atf_tc_get_config_var_as_long_wd(3), atf_no_error(3), atf_tc_expect_death(3), atf_tc_expect_exit(3), atf_tc_expect_fail(3), atf_tc_expect_pass(3), atf_tc_expect_signal(3), atf_tc_expect_timeout(3), atf_tc_fail(3), atf_tc_fail_nonfatal(3), atf_tc_pass(3), atf_tc_skip(3), atf_utils_cat_file(3), atf_utils_compare_file(3), atf_utils_copy_file(3), atf_utils_create_file(3), atf_utils_file_exists(3), atf_utils_fork(3), atf_utils_free_charpp(3), atf_utils_grep_file(3), atf_utils_grep_string(3), atf_utils_readline(3), atf_utils_redirect(3), atf_utils_wait(3)
C API to write ATF-based test programs
atf_add_test_case(3), atf_check(3), atf_check_equal(3), atf_check_not_equal(3), atf_config_get(3), atf_config_has(3), atf_expect_death(3), atf_expect_exit(3), atf_expect_fail(3), atf_expect_pass(3), atf_expect_signal(3), atf_expect_timeout(3), atf_fail(3), atf_get(3), atf_get_srcdir(3), atf_init_test_cases(3), atf_pass(3), atf_require_prog(3), atf_set(3), atf_skip(3), atf_test_case(3)
POSIX shell API to write ATF-based test programs
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
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
call_once(3), cnd_broadcast(3), cnd_destroy(3), cnd_init(3), cnd_signal(3), cnd_timedwait(3), cnd_wait(3), mtx_destroy(3), mtx_init(3), mtx_lock(3), mtx_timedlock(3), mtx_trylock(3), mtx_unlock(3), thrd_create(3), thrd_current(3), thrd_detach(3), thrd_equal(3), thrd_exit(3), thrd_join(3), thrd_sleep(3), thrd_yield(3), tss_create(3), tss_delete(3), tss_get(3), tss_set(3)
C11 threads interface
critical_enter(9), critical_exit(9)
enter and exit a critical region
epoch(9), epoch_context(9), epoch_alloc(9), epoch_free(9), epoch_enter(9), epoch_exit(9), epoch_wait(9), epoch_enter_preempt(9), epoch_exit_preempt(9), epoch_wait_preempt(9), epoch_call(9), epoch_drain_callbacks(9), in_epoch(9), in_epoch_verbose(9)
kernel epoch based reclamation
err(3), verr(3), errc(3), verrc(3), errx(3), verrx(3), warn(3), vwarn(3), warnc(3), vwarnc(3), warnx(3), vwarnx(3), err_set_exit(3), err_set_file(3)
formatted error messages
exit(3), _Exit(3)
perform normal program termination
kproc_start(9), kproc_shutdown(9), kproc_create(9), kproc_exit(9), kproc_resume(9), kproc_suspend(9), kproc_suspend_check(9)
kernel processes
kthread_start(9), kthread_shutdown(9), kthread_add(9), kthread_exit(9), kthread_resume(9), kthread_suspend(9), kthread_suspend_check(9)
kernel threads
osd(9), osd_register(9), osd_deregister(9), osd_set(9), osd_reserve(9), osd_set_reserved(9), osd_free_reserved(9), osd_get(9), osd_del(9), osd_call(9), osd_exit(9)
Object Specific Data
pthread_cleanup_push(3)
add a cleanup function for thread exit
pthread_exit(3)
terminate the calling thread
quick_exit(3)
exits a program quickly, running minimal cleanup
signal(9), SIGADDSET(9), SIGDELSET(9), SETEMPTYSET(9), SIGFILLSET(9), SIGISMEMBER(9), SIGISEMPTY(9), SIGNOTEMPTY(9), SIGSETEQ(9), SIGSETNEQ(9), SIGSETOR(9), SIGSETAND(9), SIGSETNAND(9), SIGSETCANTMASK(9), SIG_STOPSIGMASK(9), SIG_CONTSIGMASK(9), SIGPENDING(9), cursig(9), execsigs(9), issignal(9), killproc(9), pgsigio(9), postsig(9), sigexit(9), siginit(9), signotify(9), trapsignal(9)
kernel signal functions
svc_dg_enablecache(3), svc_exit(3), svc_fdset(3), svc_freeargs(3), svc_getargs(3), svc_getreq_common(3), svc_getreq_poll(3), svc_getreqset(3), svc_getrpccaller(3), svc_pollset(3), svc_run(3), svc_sendreply(3)
library routines for RPC servers
sysexits(3)
preferable exit codes for programs
thr_exit(2)
terminate current thread
thread_exit(9)
abandon current thread context
OPENSSL_INIT_new(3), OPENSSL_INIT_set_config_filename(3), OPENSSL_INIT_set_config_appname(3), OPENSSL_INIT_set_config_file_flags(3), OPENSSL_INIT_free(3), OPENSSL_init_crypto(3), OPENSSL_cleanup(3), OPENSSL_atexit(3), OPENSSL_thread_stop(3)
OpenSSL initialisation and deinitialisation functions
Dpkg::Exit(3perl)
program exit handlers
HPL_grid_exit(3)
Exit process grid
OPENSSL_INIT_new(3), OPENSSL_INIT_set_config_filename(3), OPENSSL_INIT_set_config_appname(3), OPENSSL_INIT_set_config_file_flags(3), OPENSSL_INIT_free(3), OPENSSL_init_crypto(3), OPENSSL_cleanup(3), OPENSSL_atexit(3), OPENSSL_thread_stop(3)
OpenSSL initialisation and deinitialisation functions
OPENSSL_INIT_new(3ossl), OPENSSL_INIT_set_config_filename(3ossl), OPENSSL_INIT_set_config_appname(3ossl), OPENSSL_INIT_set_config_file_flags(3ossl), OPENSSL_INIT_free(3ossl), OPENSSL_init_crypto(3ossl), OPENSSL_cleanup(3ossl), OPENSSL_atexit(3ossl), OPENSSL_thread_stop_ex(3ossl), OPENSSL_thread_stop(3ossl)
OpenSSL initialisation and deinitialisation functions
Tcl_CreateExitHandler.tcl85(3), Tcl_Exit(3), Tcl_Finalize(3), Tcl_CreateExitHandler(3), Tcl_DeleteExitHandler(3), Tcl_ExitThread(3), Tcl_FinalizeThread(3), Tcl_CreateThreadExitHandler(3), Tcl_DeleteThreadExitHandler(3), Tcl_SetExitProc(3)
end the application or thread (and invoke exit handlers)
Tcl_CreateExitHandler.tcl86(3), Tcl_Exit(3), Tcl_Finalize(3), Tcl_CreateExitHandler(3), Tcl_DeleteExitHandler(3), Tcl_ExitThread(3), Tcl_FinalizeThread(3), Tcl_CreateThreadExitHandler(3), Tcl_DeleteThreadExitHandler(3), Tcl_SetExitProc(3)
end the application or thread (and invoke exit handlers)
Tcl_CreateExitHandler.tcl87(3), Tcl_Exit(3), Tcl_Finalize(3), Tcl_CreateExitHandler(3), Tcl_DeleteExitHandler(3), Tcl_ExitThread(3), Tcl_FinalizeThread(3), Tcl_CreateThreadExitHandler(3), Tcl_DeleteThreadExitHandler(3), Tcl_SetExitProc(3)
end the application or thread (and invoke exit handlers)
XSetErrorHandler(3), XGetErrorText(3), XDisplayName(3), XSetIOErrorHandler(3), XSetIOErrorExitHandler(3), XGetErrorDatabaseText(3)
default error handlers
XmtErrorMsg(3), XmtErrorMsg()(3), XmtWarningMsg()(3)
print an error message and exit or print a warning message and return
XtAppSetExitFlag(3), XtAppGetExitFlag(3)
thread support functions
allegro_exit(3)
Closes down the Allegro system
atf-c(3), ATF_CHECK(3), ATF_CHECK_MSG(3), ATF_CHECK_EQ(3), ATF_CHECK_EQ_MSG(3), ATF_CHECK_MATCH(3), ATF_CHECK_MATCH_MSG(3), ATF_CHECK_STREQ(3), ATF_CHECK_STREQ_MSG(3), ATF_CHECK_ERRNO(3), ATF_REQUIRE(3), ATF_REQUIRE_MSG(3), ATF_REQUIRE_EQ(3), ATF_REQUIRE_EQ_MSG(3), ATF_REQUIRE_MATCH(3), ATF_REQUIRE_MATCH_MSG(3), ATF_REQUIRE_STREQ(3), ATF_REQUIRE_STREQ_MSG(3), ATF_REQUIRE_ERRNO(3), ATF_TC(3), ATF_TC_BODY(3), ATF_TC_BODY_NAME(3), ATF_TC_CLEANUP(3), ATF_TC_CLEANUP_NAME(3), ATF_TC_HEAD(3), ATF_TC_HEAD_NAME(3), ATF_TC_NAME(3), ATF_TC_WITH_CLEANUP(3), ATF_TC_WITHOUT_HEAD(3), ATF_TP_ADD_TC(3), ATF_TP_ADD_TCS(3), atf_tc_get_config_var(3), atf_tc_get_config_var_wd(3), atf_tc_get_config_var_as_bool(3), atf_tc_get_config_var_as_bool_wd(3), atf_tc_get_config_var_as_long(3), atf_tc_get_config_var_as_long_wd(3), atf_no_error(3), atf_tc_expect_death(3), atf_tc_expect_exit(3), atf_tc_expect_fail(3), atf_tc_expect_pass(3), atf_tc_expect_signal(3), atf_tc_expect_timeout(3), atf_tc_fail(3), atf_tc_fail_nonfatal(3), atf_tc_pass(3), atf_tc_skip(3), atf_utils_cat_file(3), atf_utils_compare_file(3), atf_utils_copy_file(3), atf_utils_create_file(3), atf_utils_file_exists(3), atf_utils_fork(3), atf_utils_free_charpp(3), atf_utils_grep_file(3), atf_utils_grep_string(3), atf_utils_readline(3), atf_utils_redirect(3), atf_utils_wait(3)
C API to write ATF-based test programs
atf-sh(3), atf_add_test_case(3), atf_check(3), atf_check_equal(3), atf_config_get(3), atf_config_has(3), atf_expect_death(3), atf_expect_exit(3), atf_expect_fail(3), atf_expect_pass(3), atf_expect_signal(3), atf_expect_timeout(3), atf_fail(3), atf_get(3), atf_get_srcdir(3), atf_pass(3), atf_require_prog(3), atf_set(3), atf_skip(3), atf_test_case(3)
POSIX shell API to write ATF-based test programs
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
cdk_objs(3), cleanCdkTitle drawCdkTitle positionCDKObject setCDKObjectBackgroundColor setCDKObjectPostProcess setCDKObjectPreProcess setCdkExitType setCdkTitle validCDKObject cdk_objs(3)
Cdk object-support functions
cdk_traverse(3), exitCancelCDKScreen exitCancelCDKScreenOf exitOKCDKScreen exitOKCDKScreenOf getCDKFocusCurrent resetCDKScreen resetCDKScreenOf setCDKFocusCurrent setCDKFocusFirst setCDKFocusLast setCDKFocusNext setCDKFocusPrevious traverseCDKOnce traverseCDKScreen cdk_traverse(3)
functions to support keyboard traversal
dbh_sweep(3), dbh_fanout(3), dbh_foreach_sweep(3), dbh_foreach_fanout(3), dbh_exit_sweep(3), dbh_exit_fanout(3)
apply a function to all or part of the DBHashtable
ecalloc(3), emalloc(3), eread(3), erealloc(3), esetenv(3), estrdup(3), ewrite(3)
exit-on-failure wrapper functions
encapsulate(1)
multiplex several channels over a single socket with sampling of remote process exit status, and provide conversation termination without closing the socket. netpipes 4.2
exit.tcl85(n), exit(n)
End the application
exit.tcl86(n), exit(n)
End the application
exit.tcl87(n), exit(n)
End the application
exit_curses(3x), exit_terminfo(3x)
curses memory-leak checking
explain_exit(3)
print an explanation of exit status before exiting require_index { }
filter_wait(3), filter_wait (3)
wrap waitpid to decode the exitcode and why your filter quit
gcin-exit(1)
send quit message to gcin
grace(1)
command line interface xmgrace - full-featured GUI mode gracebat - batch mode - print and exit
iv_quit(3)
signal ivykis to exit the main loop
jack_wait(1)
JACK toolkit client to check and wait for existence/exit of jackd
libssh2_channel_get_exit_signal(3)
get the remote exit signal
libssh2_channel_get_exit_status(3)
get the remote exit code
libssh2_exit(3)
global library deinitialization
nbdkit-exitlast-filter(1)
exit on last client connection
ne_sock_init(3), ne_sock_exit(3)
perform library initialization
panda_exitgraphicsmode(3)
make sure the page description stream is out of graphics mode
panic(l), warn(l)
print error or warning message and eventualy exit
pcl(3), co_create(3), co_call(3), co_resume(3), co_delete(3), co_exit_to(3), co_exit(3), co_current(3)
C coroutine management
pmccabe(1)
calculate McCabe cyclomatic complexity or non-commented line counts for C and C++ programs
pvm_exit(3)
Tells the local pvmd that this process is leaving PVM
rle_get_setup(3)
Read the header from an RLE file. rle_get_setup_ok - Print error message and exit if rle_get_setup fails. rle_get_error - Print error message for rle_get_setup failure. rle_debug - Turn on or off debugging messages
rle_open_f(3)
Open a binary file for input or output with defaults. rle_open_f_noexit - Returns error code instead of exiting
shtk_cleanup(3), cleanup(3)
Utilities to install exit handlers for cleanup routines
shtk_cli_error(3)
Prints a runtime error message and exits
shtk_cli_usage_error(3)
Prints a usage error and exits
shtk_unittest_assert_command(3)
Runs a command and validates its exit status and output
shtk_unittest_expect_command(3)
Runs a command and validates its exit status and output
smi_config(3), smiInit(3), smiExit(3), smiSetErrorLevel(3), smiGetFlags(3), smiSetFlags(3), smiLoadModule(3), smiGetPath(3), smiSetPath(3), smiReadConfig(3)
SMI library configuration routines
three_finger_flag(3)
Flag to deactivate the emergency exit key combination. Allegro game programming library
timelimit(1)
spawn a subprocess and if the child does not finish within the time limit either kill it, or exit, leaving the child in the background. netpipes 4.2
v7sh(1), sh(1), for(1), case(1), if(1), while(1), : (1), . (1), break(1), continue(1), cd(1), eval(1), exec(1), exit(1), export(1), login(1), newgrp(1), read(1), readonly(1), set(1), shift(1), times(1), trap(1), umask(1), wait(1)
command language
AtExit(3)
perform exit processing for a program or object
Bio::Tools::Run::Seg(3)
Object for identifying low complexity regions in a given protein seequence
Dist::Zilla::App::Command::nop(3)
initialize dzil, then exit
DtInfo_Quit(4)
notice sent by the browser when it exits normally
DtSearchExit(3)
Perform orderly shutdown of search engine
Goo::Exiter(3)
Exit from The Goo
IO::Async::PID(3), "IO::Async::PID"(3)
event callback on exit of a child process
JMX::Jmx4Perl::Nagios::MessageHandler(3)
Handling Nagios exit message (one or many)
Monitoring::Plugin::ExitResult(3)
Helper class for returning both output and return codes when testing
Nagios::Plugin::ExitResult(3)
Helper class for returning both output and return codes when testing
Paws::AutoScaling::ExitStandby(3)
Arguments for method ExitStandby on Paws::AutoScaling
Perl::Critic::Policy::ControlStructures::ProhibitUnreachableCode(3)
Don't write code after an unconditional "die, exit, or next"
Perl::Critic::Policy::Modules::ProhibitExcessMainComplexity(3)
Minimize complexity in code that is outside of subroutines
Perl::Critic::Policy::Subroutines::ProhibitExcessComplexity(3)
Minimize complexity by factoring code into smaller subroutines
Reflex::PID(3)
Watch the exit of a subprocess by its SIGCHLD signal
Test2::Manual::Tooling::Plugin::TestExit(3)
How to safely add pre-exit behaviors
Test2::Plugin::ExitSummary(3)
Add extra diagnostics on failure at the end of the test
Test::Exit(3)
Test that some code calls exit() without terminating testing
Test::Trap(3)
Trap exit codes, exceptions, output, etc
Tk::exit(3)
End the application
await(3), awaitnohang(3), awaitfor(3), wait(3), waitnohang(3), waitfor(3), waitpid(3)
wait for a process to exit
certbot(1)
certbot script documentation 0.0 3.5 C usage: certbot [SUBCOMMAND] [options] [-d DOMAIN] [-d DOMAIN] ... Certbot can obtain and install HTTPS/TLS/SSL certificates. By default, it will attempt to use a webserver both for obtaining and installing the certificate. The most common SUBCOMMANDS and flags are: obtain, install, and renew certificates: (default) run Obtain & install a certificate in your current webserver certonly Obtain or renew a certificate, but do not install it renew Renew all previously obtained certificates that are near expiry enhance Add security enhancements to your existing configuration -d DOMAINS Comma-separated list of domains to obtain a certificate for --apache Use the Apache plugin for authentication & installation --standalone Run a standalone webserver for authentication --nginx Use the Nginx plugin for authentication & installation --webroot Place files in a server(aqs webroot folder for authentication --manual Obtain certificates interactively, or using shell script hooks -n Run non-interactively --test-cert Obtain a test certificate from a staging server --dry-run Test "renew" or "certonly" without saving any certificates to disk manage certificates: certificates Display information about certificates you have from Certbot revoke Revoke a certificate (supply --cert-name or --cert-path) delete Delete a certificate (supply --cert-name) manage your account: register Create an ACME account unregister Deactivate an ACME account update_account Update an ACME account --agree-tos Agree to the ACME server(aqs Subscriber Agreement -m EMAIL Email address for important account notifications optional arguments: -h, --help show this help message and exit -c CONFIG_FILE, --config CONFIG_FILE path to config file (default: /etc/letsencrypt/cli.ini and ~/.config/letsencrypt/cli.ini) -v, --verbose This flag can be used multiple times to incrementally increase the verbosity of output, e.g. -vvv. (default: 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 (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: []) --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.21.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) --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. plugins: Plugin Selection: Certbot client supports an extensible plugins architecture. See (aqcertbot plugins(aq for a list of all installed plugins and their names. You can force a particular plugin by setting options provided below. Running --help <plugin_name> will list flags specific to that plugin. --configurator CONFIGURATOR Name of the plugin that is both an authenticator and an installer. Should not be used together with --authenticator or --installer. (default: Ask) -a AUTHENTICATOR, --authenticator AUTHENTICATOR Authenticator plugin name. (default: None) -i INSTALLER, --installer INSTALLER Installer plugin name (also used to find domains). (default: None) --apache Obtain and install certificates using Apache (default: False) --nginx Obtain and install certificates using Nginx (default: False) --standalone Obtain certificates using a "standalone" webserver. (default: False) --manual Provide laborious manual instructions for obtaining a certificate (default: False) --webroot Obtain certificates by placing files in a webroot directory. (default: False) --dns-cloudflare Obtain certificates using a DNS TXT record (if you are using Cloudflare for DNS). (default: False) --dns-cloudxns Obtain certificates using a DNS TXT record (if you are using CloudXNS for DNS). (default: False) --dns-digitalocean Obtain certificates using a DNS TXT record (if you are using DigitalOcean for DNS). (default: False) --dns-dnsimple Obtain certificates using a DNS TXT record (if you are using DNSimple for DNS). (default: False) --dns-dnsmadeeasy Obtain certificates using a DNS TXT record (if you are using DNS Made Easy for DNS). (default: False) --dns-gehirn Obtain certificates using a DNS TXT record (if you are using Gehirn Infrastructure Service for DNS). (default: False) --dns-google Obtain certificates using a DNS TXT record (if you are using Google Cloud DNS). (default: False) --dns-linode Obtain certificates using a DNS TXT record (if you are using Linode for DNS). (default: False) --dns-luadns Obtain certificates using a DNS TXT record (if you are using LuaDNS for DNS). (default: False) --dns-nsone Obtain certificates using a DNS TXT record (if you are using NS1 for DNS). (default: False) --dns-ovh Obtain certificates using a DNS TXT record (if you are using OVH for DNS). (default: False) --dns-rfc2136 Obtain certificates using a DNS TXT record (if you are using BIND for DNS). (default: False) --dns-route53 Obtain certificates using a DNS TXT record (if you are using Route53 for DNS). (default: False) --dns-sakuracloud Obtain certificates using a DNS TXT record (if you are using Sakura Cloud for DNS). (default: False) apache: Apache Web Server plugin (Please note that the default values of the Apache plugin options change depending on the operating system Certbot is run on.) --apache-enmod APACHE_ENMOD Path to the Apache (aqa2enmod(aq binary (default: None) --apache-dismod APACHE_DISMOD Path to the Apache (aqa2dismod(aq binary (default: None) --apache-le-vhost-ext APACHE_LE_VHOST_EXT SSL vhost configuration extension (default: -le- ssl.conf) --apache-server-root APACHE_SERVER_ROOT Apache server root directory (default: /etc/apache2) --apache-vhost-root APACHE_VHOST_ROOT Apache server VirtualHost configuration root (default: None) --apache-logs-root APACHE_LOGS_ROOT Apache server logs directory (default: /var/log/apache2) --apache-challenge-location APACHE_CHALLENGE_LOCATION Directory path for challenge configuration (default: /etc/apache2) --apache-handle-modules APACHE_HANDLE_MODULES Let installer handle enabling required modules for you (Only Ubuntu/Debian currently) (default: False) --apache-handle-sites APACHE_HANDLE_SITES Let installer handle enabling sites for you (Only Ubuntu/Debian currently) (default: False) --apache-ctl APACHE_CTL Full path to Apache control script (default: apache2ctl) --apache-bin APACHE_BIN Full path to apache2/httpd binary (default: None) dns-cloudflare: Obtain certificates using a DNS TXT record (if you are using Cloudflare for DNS). --dns-cloudflare-propagation-seconds DNS_CLOUDFLARE_PROPAGATION_SECONDS The number of seconds to wait for DNS to propagate before asking the ACME server to verify the DNS record. (default: 10) --dns-cloudflare-credentials DNS_CLOUDFLARE_CREDENTIALS Cloudflare credentials INI file. (default: None) dns-cloudxns: Obtain certificates using a DNS TXT record (if you are using CloudXNS for DNS). --dns-cloudxns-propagation-seconds DNS_CLOUDXNS_PROPAGATION_SECONDS The number of seconds to wait for DNS to propagate before asking the ACME server to verify the DNS record. (default: 30) --dns-cloudxns-credentials DNS_CLOUDXNS_CREDENTIALS CloudXNS credentials INI file. (default: None) dns-digitalocean: Obtain certificates using a DNS TXT record (if you are using DigitalOcean for DNS). --dns-digitalocean-propagation-seconds DNS_DIGITALOCEAN_PROPAGATION_SECONDS The number of seconds to wait for DNS to propagate before asking the ACME server to verify the DNS record. (default: 10) --dns-digitalocean-credentials DNS_DIGITALOCEAN_CREDENTIALS DigitalOcean credentials INI file. (default: None) dns-dnsimple: Obtain certificates using a DNS TXT record (if you are using DNSimple for DNS). --dns-dnsimple-propagation-seconds DNS_DNSIMPLE_PROPAGATION_SECONDS The number of seconds to wait for DNS to propagate before asking the ACME server to verify the DNS record. (default: 30) --dns-dnsimple-credentials DNS_DNSIMPLE_CREDENTIALS DNSimple credentials INI file. (default: None) dns-dnsmadeeasy: Obtain certificates using a DNS TXT record (if you are using DNS Made Easy for DNS). --dns-dnsmadeeasy-propagation-seconds DNS_DNSMADEEASY_PROPAGATION_SECONDS The number of seconds to wait for DNS to propagate before asking the ACME server to verify the DNS record. (default: 60) --dns-dnsmadeeasy-credentials DNS_DNSMADEEASY_CREDENTIALS DNS Made Easy credentials INI file. (default: None) dns-gehirn: Obtain certificates using a DNS TXT record (if you are using Gehirn Infrastructure Service for DNS). --dns-gehirn-propagation-seconds DNS_GEHIRN_PROPAGATION_SECONDS The number of seconds to wait for DNS to propagate before asking the ACME server to verify the DNS record. (default: 30) --dns-gehirn-credentials DNS_GEHIRN_CREDENTIALS Gehirn Infrastructure Service credentials file. (default: None) dns-google: Obtain certificates using a DNS TXT record (if you are using Google Cloud DNS for DNS). --dns-google-propagation-seconds DNS_GOOGLE_PROPAGATION_SECONDS The number of seconds to wait for DNS to propagate before asking the ACME server to verify the DNS record. (default: 60) --dns-google-credentials DNS_GOOGLE_CREDENTIALS Path to Google Cloud DNS service account JSON file. (See https://developers.google.com/identity/protocols/ OAuth2ServiceAccount#creatinganaccount forinformation about creating a service account and https://cloud.google.com/dns/access- control#permissions_and_roles for information about therequired permissions.) (default: None) dns-linode: Obtain certificates using a DNS TXT record (if you are using Linode for DNS). --dns-linode-propagation-seconds DNS_LINODE_PROPAGATION_SECONDS The number of seconds to wait for DNS to propagate before asking the ACME server to verify the DNS record. (default: 120) --dns-linode-credentials DNS_LINODE_CREDENTIALS Linode credentials INI file. (default: None) dns-luadns: Obtain certificates using a DNS TXT record (if you are using LuaDNS for DNS). --dns-luadns-propagation-seconds DNS_LUADNS_PROPAGATION_SECONDS The number of seconds to wait for DNS to propagate before asking the ACME server to verify the DNS record. (default: 30) --dns-luadns-credentials DNS_LUADNS_CREDENTIALS LuaDNS credentials INI file. (default: None) dns-nsone: Obtain certificates using a DNS TXT record (if you are using NS1 for DNS). --dns-nsone-propagation-seconds DNS_NSONE_PROPAGATION_SECONDS The number of seconds to wait for DNS to propagate before asking the ACME server to verify the DNS record. (default: 30) --dns-nsone-credentials DNS_NSONE_CREDENTIALS NS1 credentials file. (default: None) dns-ovh: Obtain certificates using a DNS TXT record (if you are using OVH for DNS). --dns-ovh-propagation-seconds DNS_OVH_PROPAGATION_SECONDS The number of seconds to wait for DNS to propagate before asking the ACME server to verify the DNS record. (default: 30) --dns-ovh-credentials DNS_OVH_CREDENTIALS OVH credentials INI file. (default: None) dns-rfc2136: Obtain certificates using a DNS TXT record (if you are using BIND for DNS). --dns-rfc2136-propagation-seconds DNS_RFC2136_PROPAGATION_SECONDS The number of seconds to wait for DNS to propagate before asking the ACME server to verify the DNS record. (default: 60) --dns-rfc2136-credentials DNS_RFC2136_CREDENTIALS RFC 2136 credentials INI file. (default: None) dns-route53: Obtain certificates using a DNS TXT record (if you are using AWS Route53 for DNS). --dns-route53-propagation-seconds DNS_ROUTE53_PROPAGATION_SECONDS The number of seconds to wait for DNS to propagate before asking the ACME server to verify the DNS record. (default: 10) dns-sakuracloud: Obtain certificates using a DNS TXT record (if you are using Sakura Cloud for DNS). --dns-sakuracloud-propagation-seconds DNS_SAKURACLOUD_PROPAGATION_SECONDS The number of seconds to wait for DNS to propagate before asking the ACME server to verify the DNS record. (default: 90) --dns-sakuracloud-credentials DNS_SAKURACLOUD_CREDENTIALS Sakura Cloud credentials file. (default: None) manual: Authenticate through manual configuration or custom shell scripts. When using shell scripts, an authenticator script must be provided. The environment variables available to this script depend on the type of challenge. $CERTBOT_DOMAIN will always contain the domain being authenticated. For HTTP-01 and DNS-01, $CERTBOT_VALIDATION is the validation string, and $CERTBOT_TOKEN is the filename of the resource requested when performing an HTTP-01 challenge. An additional cleanup script can also be provided and can use the additional variable $CERTBOT_AUTH_OUTPUT which contains the stdout output from the auth script. For both authenticator and cleanup script, on HTTP-01 and DNS-01 challenges, $CERTBOT_REMAINING_CHALLENGES will be equal to the number of challenges that remain after the current one, and $CERTBOT_ALL_DOMAINS contains a comma-separated list of all domains that are challenged for the current certificate. --manual-auth-hook MANUAL_AUTH_HOOK Path or command to execute for the authentication script (default: None) --manual-cleanup-hook MANUAL_CLEANUP_HOOK Path or command to execute for the cleanup script (default: None) nginx: Nginx Web Server plugin --nginx-server-root NGINX_SERVER_ROOT Nginx server root directory. (default: /etc/nginx or /usr/local/etc/nginx) --nginx-ctl NGINX_CTL Path to the (aqnginx(aq binary, used for (aqconfigtest(aq and retrieving nginx version number. (default: nginx) --nginx-sleep-seconds NGINX_SLEEP_SECONDS Number of seconds to wait for nginx configuration changes to apply when reloading. (default: 1) null: Null Installer standalone: Spin up a temporary webserver webroot: Place files in webroot directory --webroot-path WEBROOT_PATH, -w WEBROOT_PATH public_html / webroot path. This can be specified multiple times to handle different domains; each domain will have the webroot path that preceded it. For instance: (ga-w /var/www/example -d example.com -d www.example.com -w /var/www/thing -d thing.net -d m.thing.net(ga (default: Ask) --webroot-map WEBROOT_MAP JSON dictionary mapping domains to webroot paths; this implies -d for each entry. You may need to escape this from your shell. E.g.: --webroot-map (aq{"eg1.is,m.eg1.is":"/www/eg1/", "eg2.is":"/www/eg2"}(aq This option is merged with, but takes precedence over, -w / -d entries. At present, if you put webroot-map in a config file, it needs to be on a single line, like: webroot-map = {"example.com":"/var/www"}. (default: {}) P
comerr(3), comerr()(3)
prints error message and exits
comerrno(3), comerrno()(3)
prints error message, given error code, and exits
countperl(1)
count lines, packages, subs and complexity of Perl files
exit(1)
exit the current shell rst2man-indent-level 0 1 rstReportMargin \$1
exit(1)
exit the shell
exit(nged)
Ends the MGED process
exits(3), _exits(3), exitcode(3), atexit(3), atexitdont(3)
terminate process, process cleanup
fish-completions(1)
Writing fish completions To specify a completion, use the complete command. complete takes as a parameter the name of the command to specify a completion for. For example, to add a completion for the program myprog, one would start the completion command with complete -c myprog ... To provide a list of possible completions for myprog, use the -a switch. If myprog accepts the arguments start and stop, this can be specified as complete -c myprog -a (aqstart stop(aq. The argument to the -a switch is always a single string. At completion time, it will be tokenized on spaces and tabs, and variable expansion, command substitution and other forms of parameter expansion will take place. fish has a special syntax to support specifying switches accepted by a command. The switches -s, -l and -o are used to specify a short switch (single character, such as -l), a gnu style long switch (such as --color) and an old-style long switch (like -shuffle), respectively. If the command (aqmyprog(aq has an option (aq-o(aq which can also be written as --output, and which can take an additional value of either (aqyes(aq or (aqno(aq, this can be specified by writing: 0.0 3.5 C complete -c myprog -s o -l output -a "yes no" P There are also special switches for specifying that a switch requires an argument, to disable filename completion, to create completions that are only available in some combinations, etc.. For a complete description of the various switches accepted by the complete command, see the documentation for the complete builtin, or write complete --help inside the fish shell. As a more comprehensive example, here(aqs a commented excerpt of the completions for systemd(aqs timedatectl: 0.0 3.5 C # All subcommands that timedatectl knows - this is useful for later. set -l commands status set-time set-timezone list-timezones set-local-rtc set-ntp # Disable file completions for the entire command # because it does not take files anywhere # Note that this can be undone by using "-F". # # File completions also need to be disabled # if you want to have more control over what files are offered # (e.g. just directories, or just files ending in ".mp3"). complete -c timedatectl -f # This line offers the subcommands # -"status", # -"set-timezone", # -"set-time" # -"list-timezones" # if no subcommand has been given so far. # # The (ga-n(ga/(ga--condition(ga option takes script as a string, which it executes. # If it returns true, the completion is offered. # Here the condition is the (ga__fish_seen_subcommands_from(ga helper function. # If returns true if any of the given commands is used on the commandline, # as determined by a simple heuristic. # For more complex uses, you can write your own function. # See e.g. the git completions for an example. # complete -c timedatectl -n "not __fish_seen_subcommand_from $commands" e -a "status set-time set-timezone list-timezones" # If the "set-timezone" subcommand is used, # offer the output of (gatimedatectl list-timezones(ga as completions. # Each line of output is used as a separate candidate, # and anything after a tab is taken as the description. # It(aqs often useful to transform command output with (gastring(ga into that form. complete -c timedatectl -n "__fish_seen_subcommand_from set-timezone" e -a "(timedatectl list-timezones)" # Completion candidates can also be described via (ga-d(ga, # which is useful if the description is constant. # Try to keep these short, because that means the user gets to see more at once. complete -c timedatectl -n "not __fish_seen_subcommand_from $commands" e -a "set-local-rtc" -d "Maintain RTC in local time" # We can also limit options to certain subcommands by using conditions. complete -c timedatectl -n "__fish_seen_subcommand_from set-local-rtc" e -l adjust-system-clock -d (aqSynchronize system clock from the RTC(aq # These are simple options that can be used everywhere. complete -c timedatectl -s h -l help -d (aqPrint a short help text and exit(aq complete -c timedatectl -l version -d (aqPrint a short version string and exit(aq complete -c timedatectl -l no-pager -d (aqDo not pipe output into a pager(aq P For examples of how to write your own complex completions, study the completions in /usr/share/fish/completions. (The exact path depends on your chosen installation prefix and may be slightly different)
fish_status_to_signal(1)
Convert exit codes to human-friendly signals
gr(nged), dg(nged)
Add or remove primitives or primitive parents from a group using a GUI selection box. dg exits grouper mode
html_score(1), "html_score"(1)
Show complexity metric and other stats for web page
measureperl(1)
count lines, packages, subs and complexity of Perl files
measureperl-checkstyle(1)
count lines, packages, subs and complexity of Perl files
mispipe(1)
pipe two commands, returning the exit status of the first
not(1)
negate the exit status of a job
pidwatch(1)
Run a command and if another PID exits, kill the command
rc(1), cd(1), eval(1), exec(1), exit(1), flag(1), rfork(1), shift(1), wait(1), whatis(1), .(1), ~(1)
command language
thread(3), alt(3), chancreate(3), chanfree(3), chanprint(3), chansetname(3), mainstacksize(3), proccreate(3), procdata(3), recv(3), recvp(3), recvul(3), send(3), sendp(3), sendul(3), nbrecv(3), nbrecvp(3), nbrecvul(3), nbsend(3), nbsendp(3), nbsendul(3), threadcreate(3), threaddata(3), threadexec(3), threadexecl(3), threadexits(3), threadexitsall(3), threadgetgrp(3), threadgetname(3), threadint(3), threadintgrp(3), threadkill(3), threadkillgrp(3), threadmain(3), threadnotify(3), threadid(3), threadpid(3), threadpin(3), threadunpin(3), threadsetgrp(3), threadsetname(3), threadsetstate(3), threadspawn(3), threadspawnd(3), threadspawnl(3), threadwaitchan(3), yield(3)
thread and proc management
tstatd(1)
Logs real-time accounting daemon SYNOPSIS tstatd [ options ] plugin [zone1:]wildcard1 .. [zoneN:]wildcardN OPTIONS "-a zone, --agregate-zone=zone" 4 Item "-a zone, --agregate-zone=zone" Agregate data from all anonymous logs (wildcards without explicit zone specified) into zone. Default behavior is to create new zone for each anonymous log from its file name. "-b file, --database-file=file" 4 Item "-b file, --database-file=file" Use file as persistent storage to keep accumulated data across daemon restarts. Default is auto generated from daemon name, specified identity and '.db' suffix. "--basename" 4 Item "--basename" Use only base name (excluding directories and suffix) of anonymous log file for auto-created zones. "-c dir, --change-dir=dir" 4 Item "-c dir, --change-dir=dir" Change current directory to dir before wildcards expanding. "-d, --debug" 4 Item "-d, --debug" Composition of options: --foreground and --log-level=debug. "-f, --foreground" 4 Item "-f, --foreground" Don't detach daemon from control terminal, logging to stderr instead log file or syslog. "--log-facility=name" 4 Item "--log-facility=name" Use name as facility for syslog logging (see syslog (3) for list of available values). Default is 'daemon'. "--log-level=level" 4 Item "--log-level=level" Set minimal logging level to level (see syslog (3) for list of available values). Default is 'notice'. "--log-file=file" 4 Item "--log-file=file" Use logging to file instead of syslog logging (which is default). "-e num, --expand-period=num" 4 Item "-e num, --expand-period=num" Do wildcards re-expanding and checking for new and missed logs every num seconds. Default is '60'. "-h, --help" 4 Item "-h, --help" Print brief help message about available options. "-i string, --identity=string" 4 Item "-i string, --identity=string" Just a string used in title of daemon process, syslog ident (see syslog|(3)), --database-file and --pid-file. Idea behind this options - multiple tstatd instances running simultaneosly. "-l [address:]port, --listen=[address:]port" 4 Item "-l [address:]port, --listen=[address:]port" Specify address and port for TCP listen socket binding. Default is '127.0.0.1:3638'. "--multiple" 4 Item "--multiple" With this option specified same log file could be included into several zones (if log name satisifies several wildcards). Default behavior is to include log file only in first satisified zone. "-n num, --windows-num=num" 4 Item "-n num, --windows-num=num" Set number of sliding-windows to num. Default is '60'. "-o string, --options=string" 4 Item "-o string, --options=string" Comma-separated plugin supported options (like a mount (8) options). "--override-from=file" 4 Item "--override-from=file" Load content of file into plugin package namespace. This is way to easy customize plugin behavior without creating another plugin. "-p file, --pid-file=file" 4 Item "-p file, --pid-file=file" Use file to keep daemon process id. Default is auto generated from daemon name, specified identity and '.pid' suffix. "--parse-error=level" 4 Item "--parse-error=level" Do logging with level (see syslog (3) for available values) about all unparsed log lines. Hint: use 'none' for ignoring such lines. Default is defining by plugin and usually is 'debug'. "-r pattern, --regex=pattern" 4 Item "-r pattern, --regex=pattern" Use pattern instead of plugin default regular expression for matching log lines. "--regex-from=file" 4 Item "--regex-from=file" Load regular expression from file and use instead of plugin default regular expression for matching log lines. "-s num, --store-period=num" 4 Item "-s num, --store-period=num" Store accumulated data in a persistent storage every num seconds. Default is '60'. "--timer=zone:timer:num" 4 Item "--timer=zone:timer:num" Create named timer firing every num seconds for zone. "-u <user>, --user=user" 4 Item "-u <user>, --user=user" Change effective privileges of daemon process to user. "-v, --version" 4 Item "-v, --version" Print version information of tstatd and exit. "-w num, --window-size=<num>" 4 Item "-w num, --window-size=<num>" Set size (duration) of sliding window to num seconds. Default is '10'
tt_message_send_on_exit(3)
set up a message to send upon unexpected exit
home | help