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

FreeBSD Manual Pages

  
 
  

home | help
acpi_sony(4)
ACPI notebook controller driver for Sony laptops
elfctl(1)
change an ELF binary's feature control note
kqueue_add_filteropts(9), kqueue_del_filteropts(9), kqfd_register(9), knote_fdclose(9), knlist_init(9), knlist_init_mtx(9), knlist_init_rw_reader(9), knlist_add(9), knlist_remove(9), knlist_remove_inevent(9), knlist_empty(9), knlist_clear(9), knlist_delete(9), knlist_destroy(9), KNOTE_LOCKED(9), KNOTE_UNLOCKED(9)
event delivery subsystem
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
AG_Notebook(3)
agar notebook container widget
NAL_BUFFER_new(2), NAL_BUFFER_free(2), NAL_BUFFER_set_size(2), NAL_BUFFER_empty(2), NAL_BUFFER_full(2), NAL_BUFFER_notempty(2), NAL_BUFFER_notfull(2), NAL_BUFFER_used(2), NAL_BUFFER_unused(2), NAL_BUFFER_data(2), NAL_BUFFER_size(2), NAL_BUFFER_write(2), NAL_BUFFER_read(2), NAL_BUFFER_write_ptr(2), NAL_BUFFER_takedata(2), NAL_BUFFER_wrote(2)
libnal buffer functions
PS_add_note(3)
Adds note to current page
XkbChangeDeviceInfo(3)
Update the server's description of a device with the changes noted in an XkbDeviceChangesRec
XkbGetControlsChanges(3)
Updates a local copy of a keyboard description with the changes previously noted by one or more calls to XkbNoteControlsChanges
XkbGetIndicatorChanges(3)
Updates a local copy of the keyboard description with the actual values of one or more calls to XkbNoteIndicatorChanges
XkbGetNameChanges(3)
Update the local copy of the keyboard description with the actual values of the results of one or more calls to XkbNoteNameChanges
XkbNoteControlsChanges(3)
Notes the changes in a changes structure when a client receives an XkbControlsNotify event
XkbNoteDeviceChanges(3)
Note device changes reported in an XkbExtensionDeviceNotify event
XkbNoteIndicatorChanges(3)
Notes the changes in a changes structure
XkbNoteNameChanges(3)
Note the changed names in a changes structure
XmCreateNotebook(3)
The Notebook widget creation function "XmCreateNotebook" "Notebook functions" "XmCreateNotebook"
XmNotebook(3)
The Notebook widget class "XmNotebook" "widget class" "Notebook"
XmNotebookGetPageInfo(3)
A Notebook function that returns page information "XmNotebookGetPageInfo" "Notebook functions" "XmNotebookGetPageInfo"
XmVaCreateNotebook(3)
XmVaCreateManagedNotebook A Notebook widget convenience creation functions. "XmVaCreateToggleNotebook" "XmVaCreateManagedNotebook" "creation functions" "XmVaCreateNotebook"
aspostit(1)
X window system Post-it(r) notes
aubionotes(1)
a command line tool to extract musical notes
cmake-variables(7)
CMake Variables Reference This page documents variables that are provided by CMake or have meaning to CMake when set by project code. For general information on variables, see the Variables section in the cmake-language manual. NOTE: 0.0 3.5 CMake reserves identifiers that: 0.0 (bu 2 begin with CMAKE_ (upper-, lower-, or mixed-case), or (bu 2 begin with _CMAKE_ (upper-, lower-, or mixed-case), or (bu 2 begin with _ followed by the name of any CMake Command
createablnotexpr(3)
complements an expression. man1/alc_origin.1
cual(6), Cual(6)
Cuyo Animation Language Cual is the main language used to describe the animations in cuyo. Strictly speaking it's the stuff between the << >> brackets in the level description files (xxx.ld). On the other hand this man page aims at being a complete description of how to write levels for cuyo. But it's still under construction. See the file "example.ld" to get an idea of how the rest of the level description works. There's also a bit of example Cual code in "example.ld". And of course, all the existing levels are examples. Note that Cual is probably still very buggy. So if strange things happen and you're sure it's not your fault, tell me (cuyo@karimmi.de)
fixmsxpart(1)
corrects note spacing in a single-staff MusiXTeX part
git-notes(1)
Add or inspect object notes
gnote(1)
A simple note-taking application for Gnome
groff_hdtbl(7)
Heidelberger table macros for GNU roff nr groff_hdtbl_C n[.C] Some simple formatting macros. Note that we use '.ig' here and not a comment to make 'mandb' 2.4.1 (and probably more recent versions also) happy; otherwise the '.char' lines and the stuff which follows is included in the 'whatis' database. . [lB] F[n[.fam]][ [rB] F[n[.fam]]] [or] F[n[.fam]]||| [ell] F[n[.fam]].|.|. [oq] F[n[.fam]][oq] [cq] F[n[.fam]][cq] F CR {
hnb(1)
Hierarchical notebook
iwidgets_notebook(n), iwidgets::notebook(n)
create and manipulate notebook widgets
iwidgets_tabnotebook(n), iwidgets::tabnotebook(n)
create and manipulate tabnotebook widgets
llvmopenmp-devel(1), llvmopenmp(1)
LLVM/OpenMP NOTE: 0.0 3.5 This document is a work in progress and most of the expected content is not yet available. While you can expect changes, we always welcome feedback and additions. Please contact, e.g., through openmp-dev@lists.llvm.org. OpenMP impacts various parts of the LLVM project, from the frontends (%Clang and Flang), through middle-end optimizations, up to the multitude of available OpenMP runtimes. A high-level overview of OpenMP in LLVM can be found here
llvmopenmp12(1), llvmopenmp(1)
LLVM/OpenMP NOTE: 0.0 3.5 This document is a work in progress and most of the expected content is not yet available. While you can expect changes, we always welcome feedback and additions. Please contact, e.g., through openmp-dev@lists.llvm.org. OpenMP impacts various parts of the LLVM project, from the frontends (%Clang and Flang), through middle-end optimizations, up to the multitude of available OpenMP runtimes. A high-level overview of OpenMP in LLVM can be found here
makepp_release_notes(1)
-- Major changes in each version of makepp
msxlint(1)
detects incorrectly formatted notes lines in a MusiXTeX source file
nbdkit-release-notes-1.10(1)
release notes for nbdkit 1.10
nbdkit-release-notes-1.12(1)
release notes for nbdkit 1.12
nbdkit-release-notes-1.14(1)
release notes for nbdkit 1.14
nbdkit-release-notes-1.16(1)
release notes for nbdkit 1.16
nbdkit-release-notes-1.18(1)
release notes for nbdkit 1.18
nbdkit-release-notes-1.20(1)
release notes for nbdkit 1.20
nbdkit-release-notes-1.4(1)
release notes for nbdkit 1.4
nbdkit-release-notes-1.6(1)
release notes for nbdkit 1.6
nbdkit-release-notes-1.8(1)
release notes for nbdkit 1.8
notepad(1)
Wine text editor
panda_freetextannotation(3)
draw a text annotation which doesn't look like a sticky note onto a page
panda_textannotation(3)
draw a text annotation which looks like a sticky note onto a page
sieve-filter(1)
Pigeonhole(aqs Sieve mailbox filter tool WARNING: This tool is still experimental. Read this manual carefully, and backup any important mail before using this tool. Also note that some of the features documented here are not actually implemented yet; this is clearly indicated where applicable
smokeping_extend(7)
Notes on extending Smokeping
smokeping_upgrade(7)
Notes on upgrading Smokeping
tixListNoteBook(n)
Create and manipulate tixListNoteBook widgets '" '" '" '"
tixNBFrame(n)
Create and manipulate Tix NoteBook Frame widgets '" '" '"
tixNoteBook(n)
Create and manipulate tixNoteBook widgets '" '" '" '"
ttk::notebook.tk85(n), ttk::notebook(n)
Multi-paned container widget
ttk_notebook.tk86(n), ttk::notebook(n)
Multi-paned container widget
uctags-lang-julia(7), ctags-lang-julia(7)
Random notes about tagging Julia source code with Universal-ctags
uctags-lang-python(7), ctags-lang-python(7)
Random notes about tagging python source code with Universal Ctags
uctags-lang-r(7), ctags-lang-r(7)
Random notes about tagging R source code with Universal Ctags
xcalendar(1)
calendar with a notebook for X11
xpad(1)
A sticky notes application for GTK+ 2.0
xpostit(1)
X window system Post-it(r) notes
xpostit(1)
X window system Post-it(rg notes
zipnote(1)
write the comments in zipfile to stdout, edit comments and rename files in zipfile
Algorithm::CheckDigits::M09_001(3), CheckDigits::M09_001(3)
compute check digits for Euro notes
Biber::Input::file::endnotexml(3)
look in a Zotero RDFXML file for an entry and create it if found
Bio::NEXUS::NotesBlock(3)
Represents a NOTES block in a NEXUS file
CAM::PDF::GS::NoText(3)
PDF graphic state
CSS::Inliner::Parser(3)
Interface through which to read/write CSS files while respecting the cascade order NOTE: This sub-module very seriously focuses on respecting cascade order. As such this module is not for you if you want to modified a stylesheet once it's read. If you are looking for that functionality you may want to look at the sister module, CSS::Simple
Catalyst::Manual::Tutorial::09_AdvancedCRUD::09_FormBuilder(3)
Catalyst Tutorial - Chapter 9: Advanced CRUD - FormBuilder NOTE: This chapter of the tutorial is in progress. Feel free to volunteer to help out. :-)
Catalyst::Plugin::AutoCRUD::Manual::Limitations(3)
Noted Limitations
Curses::UI::Notebook(3)
Create and manipulate notebook widgets
DBIx::Class::Schema::Loader::Optional::Dependencies(3), $class(3)
Optional module dependency specifications (for module authors) EOC #@@ #@@ SYNOPSIS HEADING #@@ push @chunks, <<"EOC"; =head1 SYNOPSIS Somewhere in your build-file (e.g. ExtUtils::MakeMaker's Makefile.PL): ... e$EUMM_ARGS{CONFIGURE_REQUIRES} = { e%{ e$EUMM_ARGS{CONFIGURE_REQUIRES} || {} }, DBIx::Class::Schema::Loader => $distver, }; ... my %DBIC_CONFIG_AND_ORACLE_DEPS = %{ eval { require $class; $class->req_list_for([qw( dbicdump_config rdbms_oracle )]); } || {} }; e$EUMM_ARGS{PREREQ_PM} = { e%DBIC_CONFIG_AND_ORACLE_DEPS, e%{ e$EUMM_ARGS{PREREQ_PM} || {} }, }; ... ExtUtils::MakeMaker::WriteMakefile(e%EUMM_ARGS); Note: The eval protection within the example is due to support for requirements during the configure build phase not being available on a sufficient portion of production installations of Perl. Robust support for such dependency requirements is available in the CPAN installer only since version 1.94_56 first made available for production with perl version 5.12. It is the belief of the current maintainer that support for requirements during the configure build phase will not be sufficiently ubiquitous until the year 2020 at the earliest, hence the extra care demonstrated above. It should also be noted that some 3rd party installers (e.g. cpanminus) do the right thing with configure requirements independent from the versions of perl and CPAN available. EOC #@@ #@@ DESCRIPTION HEADING #@@ push @chunks, <<'EOC'; =head1 DESCRIPTION Some of the less-frequently used features of DBIx::Class::Schema::Loader have external module dependencies on their own. In order not to burden the average user with modules they will never use, these optional dependencies are not included in the base Makefile.PL. Instead an exception with a descriptive message is thrown when a specific feature can't find one or several modules required for its operation. This module is the central holding place for the current list of such dependencies, for DBIx::Class::Schema::Loader core authors, and DBIx::Class::Schema::Loader extension authors alike. Dependencies are organized in groups where each group can list one or more required modules, with an optional minimum version (or 0 for any version). In addition groups prefixed with test_ can specify a set of environment variables, some (or all) of which are marked as required for the group to be considered by req_list_for Each group name (or a combination thereof) can be used in the public methods as described below. EOC #@@ #@@ REQUIREMENT GROUPLIST HEADING #@@ push @chunks, '=head1 CURRENT REQUIREMENT GROUPS'; my $standalone_info; for my $group (sort keys %$dbic_reqs) { my $info = $standalone_info->{$group} ||= $class->_groups_to_reqs($group); next unless ( $info->{modreqs_fully_documented} and ( $info->{augments} or $info->{modreqs} ) ); my $p = $dbic_reqs->{$group}{pod}; push @chunks, ( "=head2 $p->{title}", "=head3 $group", $p->{desc}, =over, ); if ( keys %{ $info->{modreqs}||{} } ) { push @chunks, map { "=item * $_" . ($info->{modreqs}{$_} ? " >= $info->{modreqs}{$_}" : ) } ( sort keys %{ $info->{modreqs} } ) ; } else { push @chunks, =item * No standalone requirements, } push @chunks, =back; for my $ag ( sort keys %{ $info->{augments} || {} } ) { my $ag_info = $standalone_info->{$ag} ||= $class->_groups_to_reqs($ag); my $newreqs = $class->modreq_list_for([ $group, $ag ]); for (keys %$newreqs) { delete $newreqs->{$_} if ( ( defined $info->{modreqs}{$_} and $info->{modreqs}{$_} == $newreqs->{$_} ) or ( defined $ag_info->{modreqs}{$_} and $ag_info->{modreqs}{$_} == $newreqs->{$_} ) ); } if (keys %$newreqs) { push @chunks, ( "Combined with L</$ag> additionally requires:", =over, ( map { "=item * $_" . ($newreqs->{$_} ? " >= $newreqs->{$_}" : ) } ( sort keys %$newreqs ) ), =back, ); } } } #@@ #@@ API DOCUMENTATION HEADING #@@ push @chunks, <<'EOC';
DBIx::Custom::NotExists(3)
Not exists object
Dancer2::Logger::Note(3)
Test::More note() logging engine for Dancer2
Dancer::Logger::Note(3)
Test::More note() logging engine for Dancer
Facebook::Graph::Publish::Note(3)
Add a note to a user's list of notes
Genezzo::Block::RDBlkA(3), Genezzo::Block::RDBlkA.pm(3)
Row Directory Block Adjunct tied hash class. This class adds array-like splice capabilities to Genezzo::Block::RDBlock. Genezzo::Block::RDBArray uses this class as the basis of a tied array. Note: Like its parent RDBlock, this class is almost, but not quite, a pushhash
Genezzo::Block::RDBlk_NN(3), Genezzo::Block::RDBlk_NN.pm(3)
Row Directory Block Not Null (array) tied hash class. This class converts the Genezzo::Block::RDBlkA operations from a conventional array to a "Not Null" array. Genezzo::Block::RDBArray uses this class as the basis of a tied array. Note: Like its parent RDBlock, this class is almost, but not quite, a pushhash
Genezzo::Block::RDBlock(3), Genezzo::Block::RDBlock.pm(3)
Row Directory Block tied hash class. A class that lets you treat the contents of a block (byte buffer) as a hash. Note: This implementation is almost, but not quite, a pushhash. The push hash implementation is Genezzo::Row::RSBlock. It also forms the basis of a tied array in Genezzo::Block::RDBArray
Gtk2::Ex::FormFactory::Notebook(3)
A Notebook in a FormFactory framework
Gtk2::Notebook(3)
wrapper for GtkNotebook
HTML::FormatText::WithLinks(3)
HTML to text conversion with links as footnotes
Image::ExifTool::Apple(3)
Apple EXIF maker notes tags
Image::ExifTool::Canon(3)
Canon EXIF maker notes tags
Image::ExifTool::Casio(3)
Casio EXIF maker notes tags
Image::ExifTool::DJI(3)
DJI Phantom maker notes tags
Image::ExifTool::FujiFilm(3)
Read/write FujiFilm maker notes and RAF images
Image::ExifTool::GE(3)
General Imaging maker notes tags
Image::ExifTool::HP(3)
Hewlett-Packard maker notes tags
Image::ExifTool::JVC(3)
JVC EXIF maker notes tags
Image::ExifTool::Kodak(3)
Kodak EXIF maker notes and APP3 "Meta" tags
Image::ExifTool::MakerNotes(3)
Read and write EXIF maker notes
Image::ExifTool::Minolta(3)
Minolta EXIF maker notes tags
Image::ExifTool::Nikon(3)
Nikon EXIF maker notes tags
Image::ExifTool::Nintendo(3)
Nintendo EXIF maker notes tags
Image::ExifTool::Olympus(3)
Olympus/Epson maker notes tags
Image::ExifTool::Panasonic(3)
Panasonic/Leica maker notes tags
Image::ExifTool::Pentax(3)
Pentax/Asahi maker notes tags
Image::ExifTool::PhaseOne(3)
Phase One maker notes tags
Image::ExifTool::Reconyx(3)
Reconyx maker notes tags
Image::ExifTool::Ricoh(3)
Ricoh EXIF maker notes tags
Image::ExifTool::Samsung(3)
Samsung EXIF maker notes tags
Image::ExifTool::Sanyo(3)
Sanyo EXIF maker notes tags
Image::ExifTool::Sigma(3)
Sigma/Foveon EXIF maker notes tags
Image::ExifTool::Sony(3)
Sony EXIF maker notes tags
Image::ExifTool::Unknown(3)
Unknown EXIF maker notes tags
Image::MetaData::JPEG::MakerNotes(3)
This document contains random information and details on MakerNotes; it is an appendix to the main manual page of the Image::MetaData::JPEG module, which the reader should refer to for further details and the general scope. The note on MakerNote parsing in the main manual page is of particular interest
Imager::Graph::Horizontal(3), Imager::Graph::Horizontal(3)
A super class for line/bar charts n .IP "add_data_series(e@data, $series_name)" 4 .IP "add_data_series(e@data, $series_name)" 4 Item "add_data_series(@data, $series_name)" Add a data series to the graph, of the default type. n .IP "add_bar_data_series(e@data, $series_name)" 4 .IP "add_bar_data_series(e@data, $series_name)" 4 Item "add_bar_data_series(@data, $series_name)" Add a bar data series to the graph. n .IP "add_line_data_series(e@data, $series_name)" 4 .IP "add_line_data_series(e@data, $series_name)" 4 Item "add_line_data_series(@data, $series_name)" Add a line data series to the graph. "set_column_padding($int)" 4 Item "set_column_padding($int)" Sets the number of pixels that should go between columns of data. "set_negative_background($color)" 4 Item "set_negative_background($color)" Sets the background color or fill used below the y axis. "draw()" 4 Item "draw()" Draw the graph "show_vertical_gridlines()" 4 Item "show_vertical_gridlines()" Shows vertical gridlines at the y-tics. Feature: vertical_gridlines "set_vertical_gridline_style(color => ..., style => ...)" 4 Item "set_vertical_gridline_style(color => ..., style => ...)" Set the color and style of the lines drawn for gridlines. Style equivalent: vgrid "show_line_markers()" 4 Item "show_line_markers()" "show_line_markers($value)" 4 Item "show_line_markers($value)" Feature: linemarkers. If $value is missing or true, draw markers on a line data series. Note: line markers are drawn by default. "use_automatic_axis()" 4 Item "use_automatic_axis()" Automatically scale the Y axis, based on Chart::Math::Axis. If Chart::Math::Axis isn't installed, this sets an error and returns undef. Returns 1 if it is installed. "set_x_tics($count)" 4 Item "set_x_tics($count)" Set the number of X tics to use. Their value and position will be determined by the data range
Imager::Install(3)
installation notes for Imager
Imager::Security(3)
brief notes on security and image processing
Lingua::Ispell(3), Lingua::Ispell.pm(3)
a module encapsulating access to the Ispell program. Note: this module was previously known as Text::Ispell; if you have Text::Ispell installed on your system, it is now obsolete and should be replaced by Lingua::Ispell
Module::Build::Notes(3)
Create persistent distribution configuration modules
MojoMojo::Formatter::Markdown(3)
MultiMarkdown formatting for your content. MultiMarkdown is an extension of Markdown, adding support for tables, footnotes, bibliography, automatic cross-references, glossaries, appendices, definition lists, math syntax, anchor and image attributes, and document metadata. Markdown syntax: <http://daringfireball.net/projects/markdown/syntax> MultiMarkdown syntax: <http://fletcherpenney.net/multimarkdown/users_guide/multimarkdown_syntax_guide/>
NOTEDB::binary(3)
module lib for accessing a notedb from perl
NOTEDB::dbm(3)
module lib for accessing a notedb from perl
NOTEDB::general(3)
module lib for accessing a notedb from perl
NOTEDB::mysql(3)
module lib for accessing a notedb from perl
NOTEDB::pwsafe3(3)
module lib for accessing a notedb from perl
NOTEDB::text(3)
module lib for accessing a notedb from perl
Net::BitTorrent::Notes(3)
Annotated Guide to the Ins and Outs of Net::BitTorrent
Net::Interface::Developer(3)
api, notes, hints
PDF::Builder::Content::Text(3)
additional specialized text-related formatting methods. Inherits from PDF::Builder::Content Note: If you have used some of these methods in PDF::API2 with a graphics type object (e.g., $page->gfx()->method()), you may have to change to a text type object (e.g., $page->text()->method())
Prima::Notebooks(3)
multipage widgets
RPC::ExtDirect::Migration(3)
Migration notes for RPC::ExtDirect
SOAP::WSDL::Manual::CodeFirst(3), CodeFirst(3)
Writing Code-First Web Services with SOAP::WSDL Note: This document is just a collection of thought. There's no implementation yet
Sisimai::Lhost::Notes(3)
bounce mail parser class for "Lotus Notes Server"
Test2::Event::Note(3)
Note event type
Test2::Transition(3)
Transition notes when upgrading to Test2
Test::Deep::NoTest(3)
Use Test::Deep outside of the testing framework
Time::Interval(3)
Converts time intervals of days, hours, minutes, and seconds This is a rather simple perl module for dealing with time intervals. Among other things, this module can tell you the number of hours, minutes, and seconds elapsed between two dates. NOTE: this module does not handle resolutions < 1 second. Please see the Time::HiRes module for high resolution time operations. This module will round fractional second values to the nearest whole number
Tk::DynaTabFrame(3)
A NoteBook widget with orientable, dynamically stacking tabs
Tk::NoteBook(3)
display several windows in limited space with notebook metaphor
Tk::TabFrame(3)
An alternative to the NoteBook widget : a tabbed geometry manager
VCS::Cvs(3)
notes for the CVS implementation
VCS::Rcs(3)
notes for the rcs implementation
WWW::Facebook::API::Notes(3)
Facebook Notes
cadabra-server(1)
the server backend for running Cadabra2 notebooks
cadabra2-gtk(1)
gtk notebook front-end for cadabra2
cadabra2cadabra(1)
convert Cadabra2 notebooks to text input files
cadabra2html(1)
convert Cadabra2 notebooks to standalone HTML files
cadabra2ipynb(1)
convert Cadabra2 notebooks to Jupyter notebooks
cadabra2latex(1)
convert Cadabra2 notebooks to standalone LaTeX files
certbot(1)
certbot script documentation 0.0 3.5 C usage: certbot [SUBCOMMAND] [options] [-d DOMAIN] [-d DOMAIN] ... Certbot can obtain and install HTTPS/TLS/SSL certificates. By default, it will attempt to use a webserver both for obtaining and installing the certificate. The most common SUBCOMMANDS and flags are: obtain, install, and renew certificates: (default) run Obtain & install a certificate in your current webserver certonly Obtain or renew a certificate, but do not install it renew Renew all previously obtained certificates that are near expiry enhance Add security enhancements to your existing configuration -d DOMAINS Comma-separated list of domains to obtain a certificate for --apache Use the Apache plugin for authentication & installation --standalone Run a standalone webserver for authentication --nginx Use the Nginx plugin for authentication & installation --webroot Place files in a server(aqs webroot folder for authentication --manual Obtain certificates interactively, or using shell script hooks -n Run non-interactively --test-cert Obtain a test certificate from a staging server --dry-run Test "renew" or "certonly" without saving any certificates to disk manage certificates: certificates Display information about certificates you have from Certbot revoke Revoke a certificate (supply --cert-name or --cert-path) delete Delete a certificate (supply --cert-name) manage your account: register Create an ACME account unregister Deactivate an ACME account update_account Update an ACME account --agree-tos Agree to the ACME server(aqs Subscriber Agreement -m EMAIL Email address for important account notifications optional arguments: -h, --help show this help message and exit -c CONFIG_FILE, --config CONFIG_FILE path to config file (default: /etc/letsencrypt/cli.ini and ~/.config/letsencrypt/cli.ini) -v, --verbose This flag can be used multiple times to incrementally increase the verbosity of output, e.g. -vvv. (default: -2) --max-log-backups MAX_LOG_BACKUPS Specifies the maximum number of backup logs that should be kept by Certbot(aqs built in log rotation. Setting this flag to 0 disables log rotation entirely, causing Certbot to always append to the same log file. (default: 1000) -n, --non-interactive, --noninteractive Run without ever asking for user input. This may require additional command line flags; the client will try to explain which ones are required if it finds one missing (default: False) --force-interactive Force Certbot to be interactive even if it detects it(aqs not being run in a terminal. This flag cannot be used with the renew subcommand. (default: False) -d DOMAIN, --domains DOMAIN, --domain DOMAIN Domain names to apply. For multiple domains you can use multiple -d flags or enter a comma separated list of domains as a parameter. The first domain provided will be the subject CN of the certificate, and all domains will be Subject Alternative Names on the certificate. The first domain will also be used in some software user interfaces and as the file paths for the certificate and related material unless otherwise specified or you already have a certificate with the same name. In the case of a name collision it will append a number like 0001 to the file path name. (default: Ask) --eab-kid EAB_KID Key Identifier for External Account Binding (default: None) --eab-hmac-key EAB_HMAC_KEY HMAC key for External Account Binding (default: None) --cert-name CERTNAME Certificate name to apply. This name is used by Certbot for housekeeping and in file paths; it doesn(aqt affect the content of the certificate itself. To see certificate names, run (aqcertbot certificates(aq. When creating a new certificate, specifies the new certificate(aqs name. (default: the first provided domain or the name of an existing certificate on your system for the same domains) --dry-run Perform a test run of the client, obtaining test (invalid) certificates but not saving them to disk. This can currently only be used with the (aqcertonly(aq and (aqrenew(aq subcommands. Note: Although --dry-run tries to avoid making any persistent changes on a system, it is not completely side-effect free: if used with webserver authenticator plugins like apache and nginx, it makes and then reverts temporary config changes in order to obtain test certificates, and reloads webservers to deploy and then roll back those changes. It also calls --pre-hook and --post-hook commands if they are defined because they may be necessary to accurately simulate renewal. --deploy- hook commands are not called. (default: False) --debug-challenges After setting up challenges, wait for user input before submitting to CA (default: False) --preferred-chain PREFERRED_CHAIN If the CA offers multiple certificate chains, prefer the chain whose topmost certificate was issued from this Subject Common Name. If no match, the default offered chain will be used. (default: None) --preferred-challenges PREF_CHALLS A sorted, comma delimited list of the preferred challenge to use during authorization with the most preferred challenge listed first (Eg, "dns" or "http,dns"). Not all plugins support all challenges. See https://certbot.eff.org/docs/using.html#plugins for details. ACME Challenges are versioned, but if you pick "http" rather than "http-01", Certbot will select the latest version automatically. (default: []) --user-agent USER_AGENT Set a custom user agent string for the client. User agent strings allow the CA to collect high level statistics about success rates by OS, plugin and use case, and to know when to deprecate support for past Python versions and flags. If you wish to hide this information from the Let(aqs Encrypt server, set this to "". (default: CertbotACMEClient/1.15.0 (certbot; OS_NAME OS_VERSION) Authenticator/XXX Installer/YYY (SUBCOMMAND; flags: FLAGS) Py/major.minor.patchlevel). The flags encoded in the user agent are: --duplicate, --force-renew, --allow-subset-of-names, -n, and whether any hooks are set. --user-agent-comment USER_AGENT_COMMENT Add a comment to the default user agent string. May be used when repackaging Certbot or calling it from another tool to allow additional statistical data to be collected. Ignored if --user-agent is set. (Example: Foo-Wrapper/1.0) (default: None) automation: Flags for automating execution & other tweaks --keep-until-expiring, --keep, --reinstall If the requested certificate matches an existing certificate, always keep the existing one until it is due for renewal (for the (aqrun(aq subcommand this means reinstall the existing certificate). (default: Ask) --expand If an existing certificate is a strict subset of the requested names, always expand and replace it with the additional names. (default: Ask) --version show program(aqs version number and exit --force-renewal, --renew-by-default If a certificate already exists for the requested domains, renew it now, regardless of whether it is near expiry. (Often --keep-until-expiring is more appropriate). Also implies --expand. (default: False) --renew-with-new-domains If a certificate already exists for the requested certificate name but does not match the requested domains, renew it now, regardless of whether it is near expiry. (default: False) --reuse-key When renewing, use the same private key as the existing certificate. (default: False) --allow-subset-of-names When performing domain validation, do not consider it a failure if authorizations can not be obtained for a strict subset of the requested domains. This may be useful for allowing renewals for multiple domains to succeed even if some domains no longer point at this system. This option cannot be used with --csr. (default: False) --agree-tos Agree to the ACME Subscriber Agreement (default: Ask) --duplicate Allow making a certificate lineage that duplicates an existing one (both can be renewed in parallel) (default: False) -q, --quiet Silence all output except errors. Useful for automation via cron. Implies --non-interactive. (default: False) security: Security parameters & server settings --rsa-key-size N Size of the RSA key. (default: 2048) --key-type {rsa,ecdsa} Type of generated private key(Only *ONE* per invocation can be provided at this time) (default: rsa) --elliptic-curve N The SECG elliptic curve name to use. Please see RFC 8446 for supported values. (default: secp256r1) --must-staple Adds the OCSP Must Staple extension to the certificate. Autoconfigures OCSP Stapling for supported setups (Apache version >= 2.3.3 ). (default: False) --redirect Automatically redirect all HTTP traffic to HTTPS for the newly authenticated vhost. (default: redirect enabled for install and run, disabled for enhance) --no-redirect Do not automatically redirect all HTTP traffic to HTTPS for the newly authenticated vhost. (default: redirect enabled for install and run, disabled for enhance) --hsts Add the Strict-Transport-Security header to every HTTP response. Forcing browser to always use SSL for the domain. Defends against SSL Stripping. (default: None) --uir Add the "Content-Security-Policy: upgrade-insecure- requests" header to every HTTP response. Forcing the browser to use https:// for every http:// resource. (default: None) --staple-ocsp Enables OCSP Stapling. A valid OCSP response is stapled to the certificate that the server offers during TLS. (default: None) --strict-permissions Require that all configuration files are owned by the current user; only needed if your config is somewhere unsafe like /tmp/ (default: False) --auto-hsts Gradually increasing max-age value for HTTP Strict Transport Security security header (default: False) testing: The following flags are meant for testing and integration purposes only. --test-cert, --staging Use the staging server to obtain or revoke test (invalid) certificates; equivalent to --server https://acme-staging-v02.api.letsencrypt.org/directory (default: False) --debug Show tracebacks in case of errors (default: False) --no-verify-ssl Disable verification of the ACME server(aqs certificate. (default: False) --http-01-port HTTP01_PORT Port used in the http-01 challenge. This only affects the port Certbot listens on. A conforming ACME server will still attempt to connect on port 80. (default: 80) --http-01-address HTTP01_ADDRESS The address the server listens to during http-01 challenge. (default: ) --https-port HTTPS_PORT Port used to serve HTTPS. This affects which port Nginx will listen on after a LE certificate is installed. (default: 443) --break-my-certs Be willing to replace or renew valid certificates with invalid (testing/staging) certificates (default: False) paths: Flags for changing execution paths & servers --cert-path CERT_PATH Path to where certificate is saved (with certonly --csr), installed from, or revoked (default: None) --key-path KEY_PATH Path to private key for certificate installation or revocation (if account key is missing) (default: None) --fullchain-path FULLCHAIN_PATH Accompanying path to a full certificate chain (certificate plus chain). (default: None) --chain-path CHAIN_PATH Accompanying path to a certificate chain. (default: None) --config-dir CONFIG_DIR Configuration directory. (default: /etc/letsencrypt) --work-dir WORK_DIR Working directory. (default: /var/lib/letsencrypt) --logs-dir LOGS_DIR Logs directory. (default: /var/log/letsencrypt) --server SERVER ACME Directory Resource URI. (default: https://acme-v02.api.letsencrypt.org/directory) manage: Various subcommands and flags are available for managing your certificates: certificates List certificates managed by Certbot delete Clean up all files related to a certificate renew Renew all certificates (or one specified with --cert- name) revoke Revoke a certificate specified with --cert-path or --cert-name update_symlinks Recreate symlinks in your /etc/letsencrypt/live/ directory run: Options for obtaining & installing certificates certonly: Options for modifying how a certificate is obtained --csr CSR Path to a Certificate Signing Request (CSR) in DER or PEM format. Currently --csr only works with the (aqcertonly(aq subcommand. (default: None) renew: The (aqrenew(aq subcommand will attempt to renew all certificates (or more precisely, certificate lineages) you have previously obtained if they are close to expiry, and print a summary of the results. By default, (aqrenew(aq will reuse the options used to create obtain or most recently successfully renew each certificate lineage. You can try it with (ga--dry-run(ga first. For more fine-grained control, you can renew individual lineages with the (gacertonly(ga subcommand. Hooks are available to run commands before and after renewal; see https://certbot.eff.org/docs/using.html#renewal for more information on these. --pre-hook PRE_HOOK Command to be run in a shell before obtaining any certificates. Intended primarily for renewal, where it can be used to temporarily shut down a webserver that might conflict with the standalone plugin. This will only be called if a certificate is actually to be obtained/renewed. When renewing several certificates that have identical pre-hooks, only the first will be executed. (default: None) --post-hook POST_HOOK Command to be run in a shell after attempting to obtain/renew certificates. Can be used to deploy renewed certificates, or to restart any servers that were stopped by --pre-hook. This is only run if an attempt was made to obtain/renew a certificate. If multiple renewed certificates have identical post- hooks, only one will be run. (default: None) --deploy-hook DEPLOY_HOOK Command to be run in a shell once for each successfully issued certificate. For this command, the shell variable $RENEWED_LINEAGE will point to the config live subdirectory (for example, "/etc/letsencrypt/live/example.com") containing the new certificates and keys; the shell variable $RENEWED_DOMAINS will contain a space-delimited list of renewed certificate domains (for example, "example.com www.example.com" (default: None) --disable-hook-validation Ordinarily the commands specified for --pre- hook/--post-hook/--deploy-hook will be checked for validity, to see if the programs being run are in the $PATH, so that mistakes can be caught early, even when the hooks aren(aqt being run just yet. The validation is rather simplistic and fails if you use more advanced shell constructs, so you can use this switch to disable it. (default: False) --no-directory-hooks Disable running executables found in Certbot(aqs hook directories during renewal. (default: False) --disable-renew-updates Disable automatic updates to your server configuration that would otherwise be done by the selected installer plugin, and triggered when the user executes "certbot renew", regardless of if the certificate is renewed. This setting does not apply to important TLS configuration updates. (default: False) --no-autorenew Disable auto renewal of certificates. (default: True) certificates: List certificates managed by Certbot delete: Options for deleting a certificate revoke: Options for revocation of certificates --reason {unspecified,keycompromise,affiliationchanged,superseded,cessationofoperation} Specify reason for revoking certificate. (default: unspecified) --delete-after-revoke Delete certificates after revoking them, along with all previous and later versions of those certificates. (default: None) --no-delete-after-revoke Do not delete certificates after revoking them. This option should be used with caution because the (aqrenew(aq subcommand will attempt to renew undeleted revoked certificates. (default: None) register: Options for account registration --register-unsafely-without-email Specifying this flag enables registering an account with no email address. This is strongly discouraged, because you will be unable to receive notice about impending expiration or revocation of your certificates or problems with your Certbot installation that will lead to failure to renew. (default: False) -m EMAIL, --email EMAIL Email used for registration and recovery contact. Use comma to register multiple emails, ex: u1@example.com,u2@example.com. (default: Ask). --eff-email Share your e-mail address with EFF (default: None) --no-eff-email Don(aqt share your e-mail address with EFF (default: None) update_account: Options for account modification unregister: Options for account deactivation. --account ACCOUNT_ID Account ID to use (default: None) install: Options for modifying how a certificate is deployed rollback: Options for rolling back server configuration changes --checkpoints N Revert configuration N number of checkpoints. (default: 1) plugins: Options for the "plugins" subcommand --init Initialize plugins. (default: False) --prepare Initialize and prepare plugins. (default: False) --authenticators Limit to authenticator plugins only. (default: None) --installers Limit to installer plugins only. (default: None) update_symlinks: Recreates certificate and key symlinks in /etc/letsencrypt/live, if you changed them by hand or edited a renewal configuration file enhance: Helps to harden the TLS configuration by adding security enhancements to already existing configuration. plugins: Plugin Selection: Certbot client supports an extensible plugins architecture. See (aqcertbot plugins(aq for a list of all installed plugins and their names. You can force a particular plugin by setting options provided below. Running --help <plugin_name> will list flags specific to that plugin. --configurator CONFIGURATOR Name of the plugin that is both an authenticator and an installer. Should not be used together with --authenticator or --installer. (default: Ask) -a AUTHENTICATOR, --authenticator AUTHENTICATOR Authenticator plugin name. (default: None) -i INSTALLER, --installer INSTALLER Installer plugin name (also used to find domains). (default: None) --apache Obtain and install certificates using Apache (default: False) --nginx Obtain and install certificates using Nginx (default: False) --standalone Obtain certificates using a "standalone" webserver. (default: False) --manual Provide laborious manual instructions for obtaining a certificate (default: False) --webroot Obtain certificates by placing files in a webroot directory. (default: False) --dns-cloudflare Obtain certificates using a DNS TXT record (if you are using Cloudflare for DNS). (default: False) --dns-cloudxns Obtain certificates using a DNS TXT record (if you are using CloudXNS for DNS). (default: False) --dns-digitalocean Obtain certificates using a DNS TXT record (if you are using DigitalOcean for DNS). (default: False) --dns-dnsimple Obtain certificates using a DNS TXT record (if you are using DNSimple for DNS). (default: False) --dns-dnsmadeeasy Obtain certificates using a DNS TXT record (if you are using DNS Made Easy for DNS). (default: False) --dns-gehirn Obtain certificates using a DNS TXT record (if you are using Gehirn Infrastructure Service for DNS). (default: False) --dns-google Obtain certificates using a DNS TXT record (if you are using Google Cloud DNS). (default: False) --dns-linode Obtain certificates using a DNS TXT record (if you are using Linode for DNS). (default: False) --dns-luadns Obtain certificates using a DNS TXT record (if you are using LuaDNS for DNS). (default: False) --dns-nsone Obtain certificates using a DNS TXT record (if you are using NS1 for DNS). (default: False) --dns-ovh Obtain certificates using a DNS TXT record (if you are using OVH for DNS). (default: False) --dns-rfc2136 Obtain certificates using a DNS TXT record (if you are using BIND for DNS). (default: False) --dns-route53 Obtain certificates using a DNS TXT record (if you are using Route53 for DNS). (default: False) --dns-sakuracloud Obtain certificates using a DNS TXT record (if you are using Sakura Cloud for DNS). (default: False) apache: Apache Web Server plugin (Please note that the default values of the Apache plugin options change depending on the operating system Certbot is run on.) --apache-enmod APACHE_ENMOD Path to the Apache (aqa2enmod(aq binary (default: None) --apache-dismod APACHE_DISMOD Path to the Apache (aqa2dismod(aq binary (default: None) --apache-le-vhost-ext APACHE_LE_VHOST_EXT SSL vhost configuration extension (default: -le- ssl.conf) --apache-server-root APACHE_SERVER_ROOT Apache server root directory (default: /etc/apache2) --apache-vhost-root APACHE_VHOST_ROOT Apache server VirtualHost configuration root (default: None) --apache-logs-root APACHE_LOGS_ROOT Apache server logs directory (default: /var/log/apache2) --apache-challenge-location APACHE_CHALLENGE_LOCATION Directory path for challenge configuration (default: /etc/apache2) --apache-handle-modules APACHE_HANDLE_MODULES Let installer handle enabling required modules for you (Only Ubuntu/Debian currently) (default: False) --apache-handle-sites APACHE_HANDLE_SITES Let installer handle enabling sites for you (Only Ubuntu/Debian currently) (default: False) --apache-ctl APACHE_CTL Full path to Apache control script (default: apache2ctl) --apache-bin APACHE_BIN Full path to apache2/httpd binary (default: None) dns-cloudflare: Obtain certificates using a DNS TXT record (if you are using Cloudflare for DNS). --dns-cloudflare-propagation-seconds DNS_CLOUDFLARE_PROPAGATION_SECONDS The number of seconds to wait for DNS to propagate before asking the ACME server to verify the DNS record. (default: 10) --dns-cloudflare-credentials DNS_CLOUDFLARE_CREDENTIALS Cloudflare credentials INI file. (default: None) dns-cloudxns: Obtain certificates using a DNS TXT record (if you are using CloudXNS for DNS). --dns-cloudxns-propagation-seconds DNS_CLOUDXNS_PROPAGATION_SECONDS The number of seconds to wait for DNS to propagate before asking the ACME server to verify the DNS record. (default: 30) --dns-cloudxns-credentials DNS_CLOUDXNS_CREDENTIALS CloudXNS credentials INI file. (default: None) dns-digitalocean: Obtain certificates using a DNS TXT record (if you are using DigitalOcean for DNS). --dns-digitalocean-propagation-seconds DNS_DIGITALOCEAN_PROPAGATION_SECONDS The number of seconds to wait for DNS to propagate before asking the ACME server to verify the DNS record. (default: 10) --dns-digitalocean-credentials DNS_DIGITALOCEAN_CREDENTIALS DigitalOcean credentials INI file. (default: None) dns-dnsimple: Obtain certificates using a DNS TXT record (if you are using DNSimple for DNS). --dns-dnsimple-propagation-seconds DNS_DNSIMPLE_PROPAGATION_SECONDS The number of seconds to wait for DNS to propagate before asking the ACME server to verify the DNS record. (default: 30) --dns-dnsimple-credentials DNS_DNSIMPLE_CREDENTIALS DNSimple credentials INI file. (default: None) dns-dnsmadeeasy: Obtain certificates using a DNS TXT record (if you are using DNS Made Easy for DNS). --dns-dnsmadeeasy-propagation-seconds DNS_DNSMADEEASY_PROPAGATION_SECONDS The number of seconds to wait for DNS to propagate before asking the ACME server to verify the DNS record. (default: 60) --dns-dnsmadeeasy-credentials DNS_DNSMADEEASY_CREDENTIALS DNS Made Easy credentials INI file. (default: None) dns-gehirn: Obtain certificates using a DNS TXT record (if you are using Gehirn Infrastructure Service for DNS). --dns-gehirn-propagation-seconds DNS_GEHIRN_PROPAGATION_SECONDS The number of seconds to wait for DNS to propagate before asking the ACME server to verify the DNS record. (default: 30) --dns-gehirn-credentials DNS_GEHIRN_CREDENTIALS Gehirn Infrastructure Service credentials file. (default: None) dns-google: Obtain certificates using a DNS TXT record (if you are using Google Cloud DNS for DNS). --dns-google-propagation-seconds DNS_GOOGLE_PROPAGATION_SECONDS The number of seconds to wait for DNS to propagate before asking the ACME server to verify the DNS record. (default: 60) --dns-google-credentials DNS_GOOGLE_CREDENTIALS Path to Google Cloud DNS service account JSON file. (See https://developers.google.com/identity/protocols/ OAuth2ServiceAccount#creatinganaccount forinformation about creating a service account and https://cloud.google.com/dns/access- control#permissions_and_roles for information about therequired permissions.) (default: None) dns-linode: Obtain certificates using a DNS TXT record (if you are using Linode for DNS). --dns-linode-propagation-seconds DNS_LINODE_PROPAGATION_SECONDS The number of seconds to wait for DNS to propagate before asking the ACME server to verify the DNS record. (default: 120) --dns-linode-credentials DNS_LINODE_CREDENTIALS Linode credentials INI file. (default: None) dns-luadns: Obtain certificates using a DNS TXT record (if you are using LuaDNS for DNS). --dns-luadns-propagation-seconds DNS_LUADNS_PROPAGATION_SECONDS The number of seconds to wait for DNS to propagate before asking the ACME server to verify the DNS record. (default: 30) --dns-luadns-credentials DNS_LUADNS_CREDENTIALS LuaDNS credentials INI file. (default: None) dns-nsone: Obtain certificates using a DNS TXT record (if you are using NS1 for DNS). --dns-nsone-propagation-seconds DNS_NSONE_PROPAGATION_SECONDS The number of seconds to wait for DNS to propagate before asking the ACME server to verify the DNS record. (default: 30) --dns-nsone-credentials DNS_NSONE_CREDENTIALS NS1 credentials file. (default: None) dns-ovh: Obtain certificates using a DNS TXT record (if you are using OVH for DNS). --dns-ovh-propagation-seconds DNS_OVH_PROPAGATION_SECONDS The number of seconds to wait for DNS to propagate before asking the ACME server to verify the DNS record. (default: 30) --dns-ovh-credentials DNS_OVH_CREDENTIALS OVH credentials INI file. (default: None) dns-rfc2136: Obtain certificates using a DNS TXT record (if you are using BIND for DNS). --dns-rfc2136-propagation-seconds DNS_RFC2136_PROPAGATION_SECONDS The number of seconds to wait for DNS to propagate before asking the ACME server to verify the DNS record. (default: 60) --dns-rfc2136-credentials DNS_RFC2136_CREDENTIALS RFC 2136 credentials INI file. (default: None) dns-route53: Obtain certificates using a DNS TXT record (if you are using AWS Route53 for DNS). --dns-route53-propagation-seconds DNS_ROUTE53_PROPAGATION_SECONDS The number of seconds to wait for DNS to propagate before asking the ACME server to verify the DNS record. (default: 10) dns-sakuracloud: Obtain certificates using a DNS TXT record (if you are using Sakura Cloud for DNS). --dns-sakuracloud-propagation-seconds DNS_SAKURACLOUD_PROPAGATION_SECONDS The number of seconds to wait for DNS to propagate before asking the ACME server to verify the DNS record. (default: 90) --dns-sakuracloud-credentials DNS_SAKURACLOUD_CREDENTIALS Sakura Cloud credentials file. (default: None) manual: Authenticate through manual configuration or custom shell scripts. When using shell scripts, an authenticator script must be provided. The environment variables available to this script depend on the type of challenge. $CERTBOT_DOMAIN will always contain the domain being authenticated. For HTTP-01 and DNS-01, $CERTBOT_VALIDATION is the validation string, and $CERTBOT_TOKEN is the filename of the resource requested when performing an HTTP-01 challenge. An additional cleanup script can also be provided and can use the additional variable $CERTBOT_AUTH_OUTPUT which contains the stdout output from the auth script. For both authenticator and cleanup script, on HTTP-01 and DNS-01 challenges, $CERTBOT_REMAINING_CHALLENGES will be equal to the number of challenges that remain after the current one, and $CERTBOT_ALL_DOMAINS contains a comma-separated list of all domains that are challenged for the current certificate. --manual-auth-hook MANUAL_AUTH_HOOK Path or command to execute for the authentication script (default: None) --manual-cleanup-hook MANUAL_CLEANUP_HOOK Path or command to execute for the cleanup script (default: None) nginx: Nginx Web Server plugin --nginx-server-root NGINX_SERVER_ROOT Nginx server root directory. (default: /etc/nginx or /usr/local/etc/nginx) --nginx-ctl NGINX_CTL Path to the (aqnginx(aq binary, used for (aqconfigtest(aq and retrieving nginx version number. (default: nginx) --nginx-sleep-seconds NGINX_SLEEP_SECONDS Number of seconds to wait for nginx configuration changes to apply when reloading. (default: 1) null: Null Installer standalone: Spin up a temporary webserver webroot: Place files in webroot directory --webroot-path WEBROOT_PATH, -w WEBROOT_PATH public_html / webroot path. This can be specified multiple times to handle different domains; each domain will have the webroot path that preceded it. For instance: (ga-w /var/www/example -d example.com -d www.example.com -w /var/www/thing -d thing.net -d m.thing.net(ga (default: Ask) --webroot-map WEBROOT_MAP JSON dictionary mapping domains to webroot paths; this implies -d for each entry. You may need to escape this from your shell. E.g.: --webroot-map (aq{"eg1.is,m.eg1.is":"/www/eg1/", "eg2.is":"/www/eg2"}(aq This option is merged with, but takes precedence over, -w / -d entries. At present, if you put webroot-map in a config file, it needs to be on a single line, like: webroot-map = {"example.com":"/var/www"}. (default: {}) P
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-releasenotes(1)
fish-shell release notes
install(1)
notes about Plan 9 from User Space installation
iwidgets_notebook(n), iwidgets::notebook(n)
create and manipulate notebook widgets
iwidgets_tabnotebook(n), iwidgets::tabnotebook(n)
create and manipulate tabnotebook widgets
kitty.conf(5)
kitty.conf Documentation kitty is highly customizable, everything from keyboard shortcuts, to rendering frames-per-second. See below for an overview of all customization possibilities. You can open the config file within kitty by pressing %ctrl+shift+f2. You can reload the config file within kitty by pressing %ctrl+shift+f5 or sending kitty the SIGUSR1 signal. You can also display the current configuration by pressing the %ctrl+shift+f6 key. kitty looks for a config file in the OS config directories (usually ~/.config/kitty/kitty.conf) but you can pass a specific path via the kitty --config option or use the KITTY_CONFIG_DIRECTORY environment variable. See the kitty --config option for full details. Comments can be added to the config file as lines starting with the # character. This works only if the # character is the first character in the line. You can include secondary config files via the include directive. If you use a relative path for include, it is resolved with respect to the location of the current config file. Note that environment variables are expanded, so ${USER}.conf becomes name.conf if USER=name. For example: 0.0 3.5 C include other.conf P
mach-file(3), crackhdr(3), uncrackhdr(3), mapfile(3), unmapfile(3), mapproc(3), unmapproc(3), detachproc(3), ctlproc(3), procnotes(3)
machine-independent access to exectuable files and running processes
note(3)
a perl script for maintaining notes
notify(3), noted(3), atnotify(3), noteenable(3), notedisable(3), notifyon(3), notifyoff(3)
handle asynchronous process notification
ompi-ps(1), orte-ps(1)
Displays information about the active jobs and processes in Open MPI. NOTE: ompi-ps, and orte-ps are exact synonyms for each other. Using any of the names will result in exactly identical behavior
ompi-top(1), orte-top(1)
Diagnostic to provide process info similar to the popular "top" program. NOTE: ompi-top, and orte-top are exact synonyms for each other. Using any of the names will result in exactly identical behavior
orte-dvm(1), ompi_dvm(1)
Establish a Distributed Virtual Machine (DVM). Note: orte-dvm and ompi-dvm are synonyms for each other. Using either of the names will produce the same behavior
orterun(1), mpirun(1), mpiexec(1)
Execute serial and parallel jobs in Open MPI. oshrun, shmemrun - Execute serial and parallel jobs in Open SHMEM. Note: mpirun, mpiexec, and orterun are all synonyms for each other as well as oshrun, shmemrun in case Open SHMEM is installed. Using any of the names will produce the same behavior
perlpodspec(1)
Plain Old Documentation: format specification and notes
postnote(3)
send a note to a process or process group
r.thin(1), r.thin (1)
Thins non-null cells that denote linear features in a raster map layer
setjmp(3), longjmp(3), notejmp(3)
non-local goto
sleep(3), alarm(3)
delay, ask for delayed note
v.net.salesman(1), v.net.salesman (1)
Creates a cycle connecting given nodes (Traveling salesman problem). Note that TSP is NP-hard, heuristic algorithm is used by this module and created cycle may be sub optimal
v.net.steiner(1), v.net.steiner (1)
Creates Steiner tree for the network and given terminals. Note that (cqMinimum Steiner Tree(cq problem is NP-hard and heuristic algorithm is used in this module so the result may be sub optimal
waon(1), WaoN(1)
a Wave-to-Notes transcriber
wxAuiNotebook(3)
See external documentation: wxAuiNotebook
wxAuiNotebookEvent(3)
See external documentation: wxAuiNotebookEvent
wxNotebook(3)
See external documentation: wxNotebook
wxNotebookEvent(3)
See external documentation: wxNotebookEvent
home | help