neulab/tldr huggingface dataset:
MODULES_NEARLY_FORBIDDEN_DAYS Number of days a module is considered nearly forbidden prior reaching its expiry date set by module-forbid modulefile command. When a nearly forbidden module is evaluated a warning message is issued to inform module will soon be forbidden. If set to 0, modules will never be considered nearly forbidden. Accepted values are integers comprised between 0 and 365.
This configuration is defined in the following order of preference: MODULES_NEARLY_FORBIDDEN_DAYS environment variable then the default set in modulecmd.tcl script configuration. Which means MODULES_NEARLY_FORBIDDEN_DAYS overrides default configuration.
MODULES_PAGER Text viewer for use to paginate message output if error output stream is attached to a terminal. The value of this variable is composed of a pager command name or path eventually followed by command-line options.
Paging command and options are defined for Modules in the following order of preference: MODULES_PAGER environment variable, then the default set in modulecmd.tcl script configuration. Which means MODULES_PAGER overrides default configuration.
If MODULES_PAGER variable is set to an empty string or to the value cat, pager will not be launched.
MODULES_QUARANTINE_SUPPORT If set to 1, produces the shell code for quarantine mechanism when the autoinit sub-command generates the module shell function.
The generated shell code for quarantine mechanism indirectly passes the environment variable defined in MODULES_RUN_QUARANTINE to the modulecmd.tcl script to protect its run-time environment from side-effect coming from the current definition of these variables.
To enable quarantine support, MODULES_QUARANTINE_SUPPORT should be set to 1 prior Modules initialization or the quarantine_support configuration should be set to 1 in the initrc configuration file.
Generated code for quarantine mechanism sets the __MODULES_QUARANTINE_SET environment variable when calling the modulecmd.tcl script to make it restore the environment variable put in quarantine.
Quarantine mechanism support is defined for Modules in the following order of preference: MODULES_QUARANTINE_SUPPORT environment variable, then the default set in modulecmd.tcl script configuration. Which means MODULES_QUARANTINE_SUPPORT overrides default configuration.
MODULES_RUN_QUARANTINE A space separated list of environment variable names that should be passed indirectly to modulecmd.tcl to protect its run-time environment from side-effect coming from their current definition.
If the quarantine mechanism has been included in module shell function (see MODULES_QUARANTINE_SUPPORT), each variable found in MODULES_RUN_QUARANTINE will have its value emptied or set to the value of the corresponding MODULES_RUNENV_<VAR> variable when defining modulecmd.tcl run-time environment.
Original values of these environment variables set in quarantine are passed to modulecmd.tcl via __MODULES_QUAR_<VAR> variables.
MODULES_RUNENV_<VAR> Value to set to environment variable <VAR> for modulecmd.tcl run-time execution if <VAR> is referred in MODULES_RUN_QUARANTINE.
MODULES_SEARCH_MATCH When searching for modules with avail sub-command, defines the way query string should match against available module names. With starts_with value, returned modules are those whose name begins by search query string. When set to contains, any modules whose fully qualified name contains search query string are returned.
Module search match style is defined in the following order of preference: --starts-with and --contains command line switches, then MODULES_SEARCH_MATCH environment variable, then the default set in modulecmd.tcl script configuration. Which means MODULES_SEARCH_MATCH overrides default configuration and --starts-with/--contains command line switches override every other ways to set search match style.
MODULES_SET_SHELL_STARTUP If set to 1, defines when module command initializes the shell startup file to ensure that the module command is still defined in sub-shells. Setting shell startup file means defining the ENV and BASH_ENV environment variable to the Modules bourne shell initialization script. If set to 0, shell startup file is not defined.
MODULES_SHELLS_WITH_KSH_FPATH A list of shell on which the FPATH environment variable should be defined at initialization time to point to the ksh-functions directory where the ksh initialization script for module command is located.  It enables for the listed shells to get module function defined when starting ksh as sub-shell from there.
Accepted values are a list of shell among sh, bash, csh, tcsh and fish separated by colon character (:).
MODULES_SILENT_SHELL_DEBUG If set to 1, disable any xtrace or verbose debugging property set on current shell session for the duration of either the module command or the module shell initialization script. Only applies to Bourne Shell (sh) and its derivatives.
To generate the code to silence shell debugging property in the module shell function, MODULES_SILENT_SHELL_DEBUG should be set to 1 prior Modules initialization or the silent_shell_debug configuration option should be set to 1 in the initrc configuration file.
MODULES_SITECONFIG Location of a site-specific configuration script to source into modulecmd.tcl. See also Modulecmd startup section.
This environment variable is ignored if extra_siteconfig has been declared locked in locked_configs configuration option.
MODULES_TAG_ABBREV Specifies the abbreviation strings used to report module tags (see Module tags section). Its value is a colon-separated list of module tag names associated to an abbreviation string (e.g. tagname=abbrev).
If a tag is associated to an empty string abbreviation, this tag will not be reported. In case the whole MODULES_TAG_ABBREV environment variable is set to an empty string, tags are reported but not abbreviated.
The tag abbreviation definition set in MODULES_TAG_ABBREV environment variable supersedes the default configuration set in modulecmd.tcl script.
MODULES_TAG_COLOR_NAME Specifies the tag names or abbreviations whose graphical rendering should be applied over themselves instead of being applied over the name of the module they are attached to. Value of MODULES_TAG_COLOR_NAME is a colon-separated list of module tag names or abbreviation strings (see Module tags section).
When a select graphic rendition is defined for a tag name or a tag abbreviation string, it is applied over the module name associated with the tag and tag name or abbreviation is not displayed. When listed in MODULES_TAG_COLOR_NAME environment variable, a tag name or abbreviation is displayed and select graphic rendition is applied over it.
The definition set in MODULES_TAG_COLOR_NAME environment variable supersedes the default configuration set in modulecmd.tcl script.
MODULES_TERM_BACKGROUND Inform Modules of the terminal background color to determine if the color set for dark background or the color set for light background should be used to color output in case no specific color set is defined with the MODULES_COLORS variable. Accepted values are dark and light.
MODULES_TERM_WIDTH Specifies the number of columns of the output. If set to 0, the output width will be the full terminal width, which is automatically detected by the module command. Accepted values are integers comprised between 0 and 1000.
This configuration is defined in the following order of preference: --width or -w command line switches, then MODULES_TERM_WIDTH environment variable, then the default set in modulecmd.tcl script configuration. Which means MODULES_TERM_WIDTH overrides default configuration.  --width or -w command line switches override every other configuration.
MODULES_UNLOAD_MATCH_ORDER When a module unload request matches multiple loaded modules, unload firstly loaded module or lastly loaded module. Accepted values are returnfirst and returnlast.
MODULES_VARIANT_SHORTCUT Specifies the shortcut characters that could be used to specify and report module variants (see Module variants section). Its value is a colon-separated list of variant names associated to a shortcut character (e.g., variantname=shortcutchar).
A variant shortcut must be of one character length and must avoid characters used for other concerns or in module names (i.e., [-+~/@=a-zA-Z0-9]).
If a shortcut is associated to an empty string or an invalid character, this shortcut definition will be ignored.
The variant shortcut definition set in MODULES_VARIANT_SHORTCUT environment variable supersedes the default configuration set in modulecmd.tcl script.
MODULES_VERBOSITY Defines the verbosity level of the module command. Available verbosity levels from the least to the most verbose are:
• silent: turn off error, warning and informational messages but does not affect module command output result.
• concise: enable error and warning messages but disable informational messages.
• normal: turn on informational messages, like a report of the additional module evaluations triggered by loading or unloading modules, aborted evaluation issues or a report of each module evaluation occurring during a restore or source sub-commands.
• verbose: add additional informational messages, like a systematic report of the loading or unloading module evaluations.
• verbose2: report loading or unloading module evaluations of hidden-loaded modules, report if loading module is already loaded or if unloading module is not loaded.
• trace: provide details on module searches, resolutions, selections and evaluations.
• debug: print debugging messages about module command execution.
• debug2: report modulecmd.tcl procedure calls in addition to printing debug messages.
Module command verbosity is defined in the following order of preference: --silent, --verbose, --debug and --trace command line switches, then MODULES_VERBOSITY environment variable, then the default set in modulecmd.tcl script configuration. Which means MODULES_VERBOSITY overrides default configuration and --silent/‐ --verbose/--debug/--trace command line switches overrides every other ways to set verbosity level.
MODULES_WA_277 If set to 1 prior to Modules package initialization, enables workaround for Tcsh history issue (see https://github.com/cea-hpc/modules/issues/277).  This issue leads to erroneous history entries under Tcsh shell. When workaround is enabled, an alternative module alias is defined which fixes the history mechanism issue. However the alternative definition of the module alias weakens shell evaluation of the code produced by modulefiles.  Characters with a special meaning for Tcsh shell (like { and }) may not be used anymore in shell alias definition otherwise the evaluation of the code produced by modulefiles will return a syntax error.
MODULESHOME The location of the main Modules package file directory containing module command initialization scripts, the executable program modulecmd.tcl, and a directory containing a collection of main modulefiles.
/usr/share/modules The MODULESHOME directory.
/etc/environment-modules/initrc The configuration file evaluated by modulecmd.tcl when it initializes to enable the default modulepaths, load the default modules and set module command configuration.
initrc is a modulefile(4) so it is written as a Tcl script and defines modulepaths to enable with module use, modules to load with module load and configuration to apply with module config. As any modulefile initrc must begin with the magic cookie #%Module.
initrc is optional. When this configuration file is present it is evaluated after the modulespath configuration file. See the Package Initialization section for details.
/etc/environment-modules/modulespath The configuration file evaluated by modulecmd.tcl when it initializes to enable the default modulepaths. This file contains the list of modulepaths separated by either newline or colon characters.
modulespath is optional. When this configuration file is present it is evaluated before the initrc configuration file. See the Package Initialization section for details.
/etc/environment-modules/siteconfig.tcl The site-specific configuration script of modulecmd.tcl. An additional configuration script could be defined using the MODULES_SITECONFIG environment variable.
/etc/environment-modules/rc The system-wide modules rc file. The location of this file can be changed using the MODULERCFILE environment variable as described above.
$HOME/.modulerc The user specific modules rc file.
$HOME/.module The user specific collection directory.
/usr/share/modules/modulefiles The directory for system-wide modulefiles. The location of the directory can be changed using the MODULEPATH environment variable as described above.
/usr/lib/x86_64-linux-gnu/modulecmd.tcl The modulefile interpreter that gets executed upon each invocation of module.
/usr/share/modules/init/<shell> The Modules package initialization file sourced into the user's environment.
ml(1), modulefile(4)
1996-1999 John L. Furlani & Peter W. Osel, 1998-2017 R.K.Owen, 2002-2004 Mark Lakata, 2004-2017 Kent Mein, 2016-2021 Xavier Delaruelle
PACMAN-KEY(8)                     Pacman Manual                    PACMAN-KEY(8)
pacman-key - manage pacman's list of trusted keys
pacman-key [options] operation [targets]
pacman-key is a wrapper script for GnuPG used to manage pacman’s keyring, which is the collection of PGP keys used to check signed packages and databases. It provides the ability to import and export keys, fetch keys from keyservers and update the key trust database.
More complex keyring management can be achieved using GnuPG directly combined with the --homedir option pointing at the pacman keyring (located in /etc/pacman.d/gnupg by default).
Invoking pacman-key consists of supplying an operation with any potential options and targets to operate on. Depending on the operation, a target may be a valid key identifier, filename, or directory.
-a, --add Add the key(s) contained in the specified file or files to pacman’s keyring. If a key already exists, update it.
-d, --delete Remove the key(s) identified by the specified keyid(s) from pacman’s keyring.
-e, --export Export key(s) identified by the specified keyid(s) to stdout. If no keyid is specified, all keys will be exported.
--edit-key Present a menu for key management task on the specified keyid(s). Useful for adjusting a keys trust level.
-f, --finger List a fingerprint for each specified keyid, or for all known keys if no keyids are specified.
--import Imports keys from pubring.gpg into the public keyring from the specified directories.
--import-trustdb Imports ownertrust values from trustdb.gpg into the shared trust database from the specified directories.
--init Ensure the keyring is properly initialized and has the required access permissions.
-l, --list-keys Lists all or specified keys from the public keyring.
--list-sigs Same as --list-keys, but the signatures are listed too.
--lsign-key Locally sign the given key. This is primarily used to root the web of trust in the local private key generated by --init.
--nocolor Disable colored output from pacman-key.
-r, --recv-keys Equivalent to --recv-keys in GnuPG.
--refresh-keys Equivalent to --refresh-keys in GnuPG.
--populate Reload the default keys from the (optionally provided) keyrings in /usr/share/pacman/keyrings. For more information, see Providing a Keyring for Import below.
-u, --updatedb Equivalent to --check-trustdb in GnuPG. This operation can be specified with other operations.
-V, --version Displays the program version.
-v, --verify Assume that the first argument is a signature and verify it. If a second argument is provided, it is the file to be verified.
With only one argument given, assume that the signature is a detached signature, and look for a matching data file to verify by stripping the file extension. If no matching data file is found, fall back on GnuPG semantics and attempt to verify a file with an embedded signature.
--config <file> Use an alternate configuration file instead of the /etc/pacman.conf default.
--gpgdir <dir> Set an alternate home directory for GnuPG. If unspecified, the value is read from /etc/pacman.conf.
--keyserver <keyserver> Use the specified keyserver if the operation requires one. This will take precedence over any keyserver option specified in a gpg.conf configuration file. Running --init with this option will set the default keyserver if one was not already configured.
A distribution or other repository provided may want to provide a set of PGP keys used in the signing of its packages and repository databases that can be readily imported into the pacman keyring. This is achieved by providing a PGP keyring file foo.gpg that contains the keys for the foo keyring in the directory /usr/share/pacman/keyrings.
Optionally, the file foo-trusted can be provided containing a list of trusted key IDs for that keyring. This is a file in a format compatible with gpg --export-ownertrust output. This file will inform the user which keys a user needs to verify and sign to build a local web of trust, in addition to assigning provided owner trust values.
Also optionally, the file foo-revoked can be provided containing a list of revoked key IDs for that keyring. Revoked is defined as "no longer valid for any signing", so should be used with prudence. A key being marked as revoked will be disabled in the keyring and no longer treated as valid, so this always takes priority over it’s trusted state in any other keyring.
pacman(8), pacman.conf(5)
IMAPSYNC(1)            User Contributed Perl Documentation           IMAPSYNC(1)
imapsync - Email IMAP tool for syncing, copying, migrating and archiving email mailboxes between two imap servers, one way, and without duplicates.
This documentation refers to Imapsync $Revision: 1.977 $
To synchronize the source imap account "test1" on server "test1.lamiral.info" with password "secret1" to the destination imap account "test2" on server "test2.lamiral.info" with password "secret2" do:
imapsync \ --host1 test1.lamiral.info --user1 test1 --password1 secret1 \ --host2 test2.lamiral.info --user2 test2 --password2 secret2
We sometimes need to transfer mailboxes from one imap server to one another.
Imapsync command is a tool allowing incremental and recursive imap transfers from one mailbox to another.  If you don't understand the previous sentence, it's normal, it's pedantic computer oriented jargon.
All folders are transferred, recursively, meaning the whole folder hierarchy is taken, all messages in them, and all messages flags (\Seen \Answered \Flagged etc.)  are synced too.
Imapsync reduces the amount of data transferred by not transferring a given message if it already resides on the destination side.  Messages that are on the destination side but not on the source side stay as they are (see the --delete2 option to have a strict sync).
How imapsync knows a message is already on both sides?  Same specific headers and the transfer is done only once.  By default, the identification headers are "Message-Id:" and "Received:" lines but this choice can be changed with the --useheader option.
All flags are preserved, unread messages will stay unread, read ones will stay read, deleted will stay deleted.
You can abort the transfer at any time and restart it later, imapsync works well with bad connections and interruptions, by design. On a terminal hit Ctr-c twice within two seconds in order to abort the program. Hit Ctr-c just once makes imapsync reconnect to both imap servers.
A classical scenario is synchronizing a mailbox B from another mailbox A where you just want to keep a strict copy of A in B. Strict meaning all messages in A will be in B but no more.
For this, option --delete2 has to be used, it deletes messages in host2 folder B that are not in host1 folder A. If you also need to destroy host2 folders that are not in host1 then use --delete2folders. See also --delete2foldersonly and --delete2foldersbutnot to set up exceptions on folders to destroy. INBOX will never be destroy, it's a mandatory folder in IMAP.
A different scenario is to delete the messages from the source mailbox after a successful transfer, it can be a good feature when migrating mailboxes since messages will be only on one side. The source account will only have messages that are not on the destination yet, ie, messages that arrived after a sync or that failed to be copied.
In that case, use the --delete1 option. Option --delete1 implies also option --expunge1 so all messages marked deleted on host1 will be really deleted. In IMAP protocol deleting a message does not really delete it, it marks it with the flag \Deleted, allowing an undelete. Expunging a folder removes, definitively, all the messages marked as \Deleted in this folder.
You can also decide to remove empty folders once all of their messages have been transferred. Add --delete1emptyfolders to obtain this behavior.
Imapsync is not adequate for maintaining two active imap accounts in synchronization when the user plays independently on both sides.  Use offlineimap (written by John Goerzen) or mbsync (written by Michael R. Elkins) for a 2 ways synchronization.
usage: imapsync [options]
The standard options are the six values forming the credentials.  Three values on each side are needed in order to log in into the IMAP servers. These six values are a host, a username, and a password, two times.
Conventions used in the following descriptions of the options:
str means string int means integer reg means regular expression cmd means command
--dry               : Makes imapsync doing nothing for real, just print what would be done without --dry.
OPTIONS/credentials --host1        str  : Source or "from" imap server. --port1        int  : Port to connect on host1. Optional since default ports are the well known ports imap/143 or imaps/993. --user1        str  : User to login on host1. --password1    str  : Password for the user1.
--host2        str  : "destination" imap server. --port2        int  : Port to connect on host2. Optional --user2        str  : User to login on host2. --password2    str  : Password for the user2.
--showpasswords     : Shows passwords on output instead of "MASKED". Useful to restart a complete run by just reading the command line used in the log, or to debug passwords. It's not a secure practice at all.
--passfile1    str  : Password file for the user1. It must contain the password on the first line. This option avoids showing the password on the command line like --password1 does. --passfile2    str  : Password file for the user2.
You can also pass the passwords in the environment variables IMAPSYNC_PASSWORD1 and IMAPSYNC_PASSWORD2
OPTIONS/encryption --nossl1            : Do not use a SSL connection on host1. --ssl1              : Use a SSL connection on host1. On by default if possible.
--nossl2            : Do not use a SSL connection on host2. --ssl2              : Use a SSL connection on host2. On by default if possible.
--notls1            : Do not use a TLS connection on host1. --tls1              : Use a TLS connection on host1. On by default if possible.
--notls2            : Do not use a TLS connection on host2. --tls2              : Use a TLS connection on host2. On by default if possible.
--debugssl     int  : SSL debug mode from 0 to 4.
--sslargs1     str  : Pass any ssl parameter for host1 ssl or tls connection. Example: --sslargs1 SSL_verify_mode=1 --sslargs1 SSL_version=SSLv3 See all possibilities in the new() method of IO::Socket::SSL http://search.cpan.org/perldoc?IO::Socket::SSL#Description_Of_Methods --sslargs2     str  : Pass any ssl parameter for host2 ssl or tls connection. See --sslargs1
--timeout1     int  : Connection timeout in seconds for host1. Default is 120 and 0 means no timeout at all. --timeout2     int  : Connection timeout in seconds for host2. Default is 120 and 0 means no timeout at all.
OPTIONS/authentication --authmech1    str  : Auth mechanism to use with host1: PLAIN, LOGIN, CRAM-MD5 etc. Use UPPERCASE. --authmech2    str  : Auth mechanism to use with host2. See --authmech1
--authuser1    str  : User to auth with on host1 (admin user). Avoid using --authmech1 SOMETHING with --authuser1. --authuser2    str  : User to auth with on host2 (admin user). --proxyauth1        : Use proxyauth on host1. Requires --authuser1. Required by Sun/iPlanet/Netscape IMAP servers to be able to use an administrative user. --proxyauth2        : Use proxyauth on host2. Requires --authuser2.
--authmd51          : Use MD5 authentication for host1. --authmd52          : Use MD5 authentication for host2. --domain1      str  : Domain on host1 (NTLM authentication). --domain2      str  : Domain on host2 (NTLM authentication).
OPTIONS/folders --folder       str  : Sync this folder. --folder       str  : and this one, etc. --folderrec    str  : Sync this folder recursively. --folderrec    str  : and this one, etc.
--folderfirst  str  : Sync this folder first. Ex. --folderfirst "INBOX" --folderfirst  str  : then this one, etc. --folderlast   str  : Sync this folder last. --folderlast "[Gmail]/All Mail" --folderlast   str  : then this one, etc.
--nomixfolders      : Do not merge folders when host1 is case-sensitive while host2 is not (like Exchange). Only the first similar folder is synced (example: with folders "Sent", "SENT" and "sent" on host1 only "Sent" will be synced to host2).
--skipemptyfolders  : Empty host1 folders are not created on host2.
--include      reg  : Sync folders matching this regular expression --include      reg  : or this one, etc. If both --include --exclude options are used, then include is done before. --exclude      reg  : Skips folders matching this regular expression Several folders to avoid: --exclude 'fold1|fold2|f3' skips fold1, fold2 and f3. --exclude      reg  : or this one, etc.
--automap           : guesses folders mapping, for folders well known as "Sent", "Junk", "Drafts", "All", "Archive", "Flagged".
--f1f2    str1=str2 : Force folder str1 to be synced to str2, --f1f2 overrides --automap and --regextrans2.
--subfolder2   str  : Syncs the whole host1 folders hierarchy under the host2 folder named str. It does it internally by adding three --regextrans2 options before all others. Add --debug to see what's really going on.
--subfolder1   str  : Syncs the host1 folders hierarchy which is under folder str to the root hierarchy of host2. It's the couterpart of a sync done by --subfolder2 when doing it in the reverse order. Backup/Restore scenario: Use --subfolder2 str for a backup to the folder str on host2. Then use --subfolder1 str for restoring from the folder str, after inverting host1/host2 user1/user2 values.
--subscribed        : Transfers subscribed folders. --subscribe         : Subscribe to the folders transferred on the host2 that are subscribed on host1. On by default. --subscribeall      : Subscribe to the folders transferred on the host2 even if they are not subscribed on host1.
--prefix1      str  : Remove prefix str to all destination folders, usually "INBOX." or "INBOX/" or an empty string "". imapsync guesses the prefix if host1 imap server does not have NAMESPACE capability. So this option should not be used most of the time. --prefix2      str  : Add prefix to all host2 folders. See --prefix1
--sep1         str  : Host1 separator. This option should not be used most of the time. Imapsync gets the separator from the server itself, by using NAMESPACE, or it tries to guess it from the folders listing (it counts characters / . \\ \ in folder names and choose the more frequent, or finally / if nothing is found. --sep2         str  : Host2 separator. See --sep1
--regextrans2  reg  : Apply the whole regex to each destination folders. --regextrans2  reg  : and this one. etc. When you play with the --regextrans2 option, first add also the safe options --dry --justfolders Then, when happy, remove --dry for a run, then remove --justfolders for the next ones. Have in mind that --regextrans2 is applied after the automatic prefix and separator inversion. For examples see: https://imapsync.lamiral.info/FAQ.d/FAQ.Folders_Mapping.txt
OPTIONS/folders sizes --nofoldersizes     : Do not calculate the size of each folder at the beginning of the sync. Default is to calculate them. --nofoldersizesatend: Do not calculate the size of each folder at the end of the sync. Default is to calculate them. --justfoldersizes   : Exit after having printed the initial folder sizes.
OPTIONS/tmp --tmpdir       str  : Where to store temporary files and subdirectories. Will be created if it doesn't exist. Default is system specific, Unix is /tmp but /tmp is often too small and deleted at reboot. --tmpdir /var/tmp should be better. --pidfile      str  : The file where imapsync pid is written, it can be dirname/filename. Default name is imapsync.pid in tmpdir. --pidfilelocking    : Abort if pidfile already exists. Useful to avoid concurrent transfers on the same mailbox.
OPTIONS/log --nolog             : Turn off logging on file --logfile      str  : Change the default log filename (can be dirname/filename). --logdir       str  : Change the default log directory. Default is LOG_imapsync/
The default logfile name is for example
LOG_imapsync/2019_12_22_23_57_59_532_user1_user2.txt
2019_12_22_23_57_59_532 is nearly the date of the start YYYY_MM_DD_HH_MM_SS_mmm year_month_day_hour_minute_seconde_millisecond
and user1 user2 are the --user1 --user2 values.
OPTIONS/messages --skipmess     reg  : Skips messages matching the regex. Example: 'm/[\x80-ff]/' # to avoid 8bits messages. --skipmess is applied before --regexmess --skipmess     reg  : or this one, etc.
--skipcrossduplicates : Avoid copying messages that are already copied in another folder,  good from Gmail to X when X is not also Gmail. Activated with --gmail1 unless --noskipcrossduplicates
--debugcrossduplicates : Prints which messages (UIDs) are skipped with --skipcrossduplicates (and in what other folders they are).
--pipemess     cmd  : Apply this cmd command to each message content before the copy. --pipemess     cmd  : and this one, etc. With several --pipemess, the output of each cmd command (STDOUT) is given to the input (STDIN) of the next command. For example, --pipemess cmd1 --pipemess cmd2 --pipemess cmd3 is like a Unix pipe: "cat message | cmd1 | cmd2 | cmd3"
--disarmreadreceipts : Disarms read receipts (host2 Exchange issue)
--regexmess    reg  : Apply the whole regex to each message before transfer. Example: 's/\000/ /g' # to replace null by space. --regexmess    reg  : and this one, etc.
OPTIONS/labels Gmail present labels as folders in imap. Imapsync can accelerate the sync by syncing X-GM-LABELS, it will avoid to transfer messages when they are already on host2.
--synclabels        : Syncs also Gmail labels when a message is copied to host2. Activated by default with --gmail1 --gmail2 unless --nosynclabels is added.
--resynclabels      : Resyncs Gmail labels when a message is already on host2. Activated by default with --gmail1 --gmail2 unless --noresynclabels is added.
For Gmail syncs, see also: https://imapsync.lamiral.info/FAQ.d/FAQ.Gmail.txt
OPTIONS/flags If you encounter flag problems see also: https://imapsync.lamiral.info/FAQ.d/FAQ.Flags.txt
--regexflag    reg  : Apply the whole regex to each flags list. Example: 's/"Junk"//g' # to remove "Junk" flag. --regexflag    reg  : then this one, etc.
--resyncflags       : Resync flags for already transferred messages. On by default. --noresyncflags     : Do not resync flags for already transferred messages. May be useful when a user has already started to play with its host2 account.
OPTIONS/deletions --delete1           : Deletes messages on host1 server after a successful transfer. Option --delete1 has the following behavior: it marks messages as deleted with the IMAP flag \Deleted, then messages are really deleted with an EXPUNGE IMAP command. If expunging after each message slows down too much the sync then use --noexpungeaftereach to speed up, expunging will then be done only twice per folder, one at the beginning and one at the end of a folder sync.
--expunge1          : Expunge messages on host1 just before syncing a folder. Expunge is done per folder. Expunge aims is to really delete messages marked deleted. An expunge is also done after each message copied if option --delete1 is set (unless --noexpungeaftereach).
--noexpunge1        : Do not expunge messages on host1.
--delete1emptyfolders : Deletes empty folders on host1, INBOX excepted. Useful with --delete1 since what remains on host1 is only what failed to be synced.
--delete2           : Delete messages in host2 that are not in host1 server. Useful for backup or pre-sync. --delete2 implies --uidexpunge2
--delete2duplicates : Delete messages in host2 that are duplicates. Works only without --useuid since duplicates are detected with an header part of each message.
--delete2folders    : Delete folders in host2 that are not in host1 server. For safety, first try it like this (it is safe): --delete2folders --dry --justfolders --nofoldersizes and see what folders will be deleted.
--delete2foldersonly   reg : Delete only folders matching the regex reg. Example: --delete2foldersonly "/^Junk$|^INBOX.Junk$/" This option activates --delete2folders
--delete2foldersbutnot reg : Do not delete folders matching the regex rex. Example: --delete2foldersbutnot "/Tasks$|Contacts$|Foo$/" This option activates --delete2folders
--noexpunge2        : Do not expunge messages on host2. --nouidexpunge2     : Do not uidexpunge messages on the host2 account that are not on the host1 account.
OPTIONS/dates If you encounter problems with dates, see also: https://imapsync.lamiral.info/FAQ.d/FAQ.Dates.txt
--syncinternaldates : Sets the internal dates on host2 same as host1. Turned on by default. Internal date is the date a message arrived on a host (Unix mtime). --idatefromheader   : Sets the internal dates on host2 same as the ones in "Date:" headers.
OPTIONS/message selection --maxsize      int  : Skip messages larger  (or equal) than  int  bytes --minsize      int  : Skip messages smaller (or equal) than  int  bytes --maxage       int  : Skip messages older than  int days. final stats (skipped) don't count older messages see also --minage --minage       int  : Skip messages newer than  int  days. final stats (skipped) don't count newer messages You can do (+ zone are the messages selected): past|----maxage+++++++++++++++>now past|+++++++++++++++minage---->now past|----maxage+++++minage---->now (intersection) past|++++minage-----maxage++++>now (union)
--search       str  : Selects only messages returned by this IMAP SEARCH command. Applied on both sides. For a complete set of what can be search see https://imapsync.lamiral.info/FAQ.d/FAQ.Messages_Selection.txt
--search1      str  : Same as --search but for selecting host1 messages only. --search2      str  : Same as --search but for selecting host2 messages only. So --search CRIT equals --search1 CRIT --search2 CRIT
--maxlinelength int : skip messages with a line length longer than  int  bytes. RFC 2822 says it must be no more than 1000 bytes but real life servers and email clients do more.
--useheader    str  : Use this header to compare messages on both sides. Ex: Message-ID or Subject or Date. --useheader    str    and this one, etc.
--usecache          : Use cache to speed up next syncs. Not set by default. --nousecache        : Do not use cache. Caveat: --useuid --nousecache creates duplicates on multiple runs. --useuid            : Use UIDs instead of headers as a criterion to recognize messages. Option --usecache is then implied unless --nousecache is used.
OPTIONS/miscellaneous --syncacls          : Synchronizes acls (Access Control Lists). Acls in IMAP are not standardized, be careful since one acl code on one side may signify something else on the other one. --nosyncacls        : Does not synchronize acls. This is the default.
--addheader         : When a message has no headers to be identified, --addheader adds a "Message-Id" header, like "Message-Id: 12345@imapsync", where 12345 is the imap UID of the message on the host1 folder.
OPTIONS/debugging --debug             : Debug mode. --debugfolders      : Debug mode for the folders part only. --debugcontent      : Debug content of the messages transferred. Huge output. --debugflags        : Debug mode for flags. --debugimap1        : IMAP debug mode for host1. Very verbose. --debugimap2        : IMAP debug mode for host2. Very verbose. --debugimap         : IMAP debug mode for host1 and host2. Twice very verbose. --debugmemory       : Debug mode showing memory consumption after each copy.
--errorsmax     int : Exit when int number of errors is reached. Default is 50.
--tests             : Run local non-regression tests. Exit code 0 means all ok. --testslive         : Run a live test with test1.lamiral.info imap server. Useful to check the basics. Needs internet connection. --testslive6        : Run a live test with ks2ipv6.lamiral.info imap server. Useful to check the ipv6 connectivity. Needs internet.
OPTIONS/specific --gmail1           : sets --host1 to Gmail and other options. See FAQ.Gmail.txt --gmail2           : sets --host2 to Gmail and other options. See FAQ.Gmail.txt
--office1          : sets --host1 to Office365 and other options. See FAQ.Exchange.txt --office2          : sets --host2 to Office365 and other options. See FAQ.Exchange.txt
--exchange1        : sets options for Exchange. See FAQ.Exchange.txt --exchange2        : sets options for Exchange. See FAQ.Exchange.txt
--domino1          : sets options for Domino. See FAQ.Domino.txt --domino2          : sets options for Domino. See FAQ.Domino.txt
OPTIONS/behavior --maxmessagespersecond int : limits the number of messages transferred per second.
--maxbytespersecond int : limits the average transfer rate per second. --maxbytesafter     int : starts --maxbytespersecond limitation only after --maxbytesafter amount of data transferred.
--maxsleep      int : do not sleep more than int seconds. On by default, 2 seconds max, like --maxsleep 2
--abort             : terminates a previous call still running. It uses the pidfile to know what process to abort.
--exitwhenover int  : Stop syncing and exits when int total bytes transferred is reached.
--version           : Print only software version. --noreleasecheck    : Do not check for any new imapsync release. --releasecheck      : Check for new imapsync release. it's an http request to http://imapsync.lamiral.info/prj/imapsync/VERSION
--noid              : Do not send/receive ID command to imap servers.
--justconnect       : Just connect to both servers and print useful information. Need only --host1 and --host2 options. Obsolete since "imapsync --host1 imaphost" alone implies --justconnect
--justlogin         : Just login to both host1 and host2 with users credentials, then exit.
--justfolders       : Do only things about folders (ignore messages).
--help              : print this help.
Example: to synchronize imap account "test1" on "test1.lamiral.info" to  imap account "test2" on "test2.lamiral.info" with test1 password "secret1" and  test2 password "secret2"
You can use --passfile1  instead of --password1 to give the password since it is safer. With --password1 option, on Linux, any user on your host can see the password by using the 'ps auxwwww' command. Using a variable (like IMAPSYNC_PASSWORD1) is also dangerous because of the 'ps auxwwwwe' command. So, saving the password in a well protected file (600 or rw-------) is the best solution.
Imapsync activates ssl or tls encryption by default, if possible.
What detailed behavior is under this "if possible"?
Imapsync activates ssl if the well known port imaps port (993) is open on the imap servers. If the imaps port is closed then it open a normal (clear) connection on port 143 but it looks for TLS support in the CAPABILITY list of the servers. If TLS is supported then imapsync goes to encryption.
If the automatic ssl and the tls detections fail then imapsync will not protect against sniffing activities on the network, especially for passwords.
If you want to force ssl or tls just use --ssl1 --ssl2 or --tls1 --tls2
See also the document FAQ.Security.txt in the FAQ.d/ directory or at https://imapsync.lamiral.info/FAQ.d/FAQ.Security.txt
Imapsync will exit with a 0 status (return code) if everything went good. Otherwise, it exits with a non-zero status. That's classical Unix behavior.  Here is the list of the exit code values (an integer between 0 and 255).  The names reflect their meaning:
EX_OK          => 0  ; #/* successful termination */ EX_USAGE       => 64 ; #/* command line usage error */ EX_NOINPUT     => 66 ; #/* cannot open input */ EX_UNAVAILABLE => 69 ; #/* service unavailable */ EX_SOFTWARE    => 70 ; #/* internal software error */ EXIT_CATCH_ALL              =>   1 ; # Any other error EXIT_BY_SIGNAL              =>   6 ; # Should be 128+n where n is the sig_num EXIT_PID_FILE_ERROR         =>   8 ; EXIT_CONNECTION_FAILURE     =>  10 ; EXIT_TLS_FAILURE            =>  12 ; EXIT_AUTHENTICATION_FAILURE =>  16 ; EXIT_SUBFOLDER1_NO_EXISTS   =>  21 ; EXIT_WITH_ERRORS            => 111 ; EXIT_WITH_ERRORS_MAX        => 112 ; EXIT_TESTS_FAILED           => 254 ; # Like Test::More API
Imapsync is free, open, public but not always gratis software cover by the NOLIMIT Public License, now called NLPL.  See the LICENSE file included in the distribution or just read this simple sentence as it IS the licence text:
"No limits to do anything with this work and this license."
In case it is not long enough, I repeat:
Look at https://imapsync.lamiral.info/LICENSE
Gilles LAMIRAL <gilles@lamiral.info>
Good feedback is always welcome.  Bad feedback is very often welcome.
Gilles LAMIRAL earns his living by writing, installing, configuring and teaching free, open and often gratis software. Imapsync used to be "always gratis" but now it is only "often gratis" because imapsync is sold by its author, a good way to maintain and support free open public software over decades.
See https://imapsync.lamiral.info/FAQ.d/FAQ.Reporting_Bugs.txt
IMAP SERVERS supported See https://imapsync.lamiral.info/S/imapservers.shtml
If you have many mailboxes to migrate think about a little shell program. Write a file called file.txt (for example) containing users and passwords.  The separator used in this example is ';'
The file.txt file contains:
user001_1;password001_1;user001_2;password001_2 user002_1;password002_1;user002_2;password002_2 user003_1;password003_1;user003_2;password003_2 user004_1;password004_1;user004_2;password004_2 user005_1;password005_1;user005_2;password005_2 ...
On Unix the shell program can be:
{ while IFS=';' read  u1 p1 u2 p2; do imapsync --host1 imap.side1.org --user1 "$u1" --password1 "$p1" \ --host2 imap.side2.org --user2 "$u2" --password2 "$p2" ... done ; } < file.txt
On Windows the batch program can be:
FOR /F "tokens=1,2,3,4 delims=; eol=#" %%G IN (file.txt) DO imapsync ^ --host1 imap.side1.org --user1 %%G --password1 %%H ^ --host2 imap.side2.org --user2 %%I --password2 %%J ...
The ... have to be replaced by nothing or any imapsync option.  Welcome in shell or batch programming !
You will find already written scripts at https://imapsync.lamiral.info/examples/
Imapsync works under any Unix with Perl.
Imapsync works under most Windows (2000, XP, Vista, Seven, Eight, Ten and all Server releases 2000, 2003, 2008 and R2, 2012 and R2, 2016) as a standalone binary software called imapsync.exe, usually launched from a batch file in order to avoid always typing the options. There is also a 64bit binary called imapsync_64bit.exe
Imapsync works under OS X as a standalone binary software called imapsync_bin_Darwin
Purchase latest imapsync at https://imapsync.lamiral.info/
You'll receive a link to a compressed tarball called imapsync-x.xx.tgz where x.xx is the version number. Untar the tarball where you want (on Unix):
tar xzvf  imapsync-x.xx.tgz
Go into the directory imapsync-x.xx and read the INSTALL file. As mentioned at https://imapsync.lamiral.info/#install the INSTALL file can also be found at https://imapsync.lamiral.info/INSTALL.d/INSTALL.ANY.txt It is now split in several files for each system https://imapsync.lamiral.info/INSTALL.d/
There is no specific configuration file for imapsync, everything is specified by the command line parameters and the default behavior.
Feel free to hack imapsync as the NOLIMIT license permits it.
See also https://imapsync.lamiral.info/S/external.shtml for a better up to date list.
Last updated and verified on Sun Dec 8, 2019.
imapsync: https://github.com/imapsync/imapsync (this is an imapsync copy, sometimes delayed, with --noreleasecheck by default since release 1.592, 2014/05/22) imap_tools: https://web.archive.org/web/20161228145952/http://www.athensfbc.com/imap_tools/. The imap_tools code is now at https://github.com/andrewnimmo/rick-sanders-imap-tools imaputils: https://github.com/mtsatsenko/imaputils (very old imap_tools fork) Doveadm-Sync: https://wiki2.dovecot.org/Tools/Doveadm/Sync ( Dovecot sync tool ) davmail: http://davmail.sourceforge.net/ offlineimap: http://offlineimap.org/ mbsync: http://isync.sourceforge.net/ mailsync: http://mailsync.sourceforge.net/ mailutil: https://www.washington.edu/imap/ part of the UW IMAP toolkit. (well, seems abandoned now) imaprepl: https://bl0rg.net/software/ http://freecode.com/projects/imap-repl/ imapcopy (Pascal): http://www.ardiehl.de/imapcopy/ imapcopy (Java): https://code.google.com/archive/p/imapcopy/ imapsize: http://www.broobles.com/imapsize/ migrationtool: http://sourceforge.net/projects/migrationtool/ imapmigrate: http://sourceforge.net/projects/cyrus-utils/ larch: https://github.com/rgrove/larch (derived from wonko_imapsync, good at Gmail) wonko_imapsync: http://wonko.com/article/554 (superseded by larch) pop2imap: http://www.linux-france.org/prj/pop2imap/ (I wrote that too) exchange-away: http://exchange-away.sourceforge.net/ SyncBackPro: http://www.2brightsparks.com/syncback/sbpro.html ImapSyncClient: https://github.com/ridaamirini/ImapSyncClient MailStore: https://www.mailstore.com/en/products/mailstore-home/ mnIMAPSync: https://github.com/manusa/mnIMAPSync imap-upload: http://imap-upload.sourceforge.net/ (A tool for uploading a local mbox file to IMAP4 server) imapbackup: https://github.com/rcarmo/imapbackup (A Python script for incremental backups of IMAP mailboxes) BitRecover email-backup 99 USD, 299 USD https://www.bitrecover.com/email-backup/. ImportExportTools: https://addons.thunderbird.net/en-us/thunderbird/addon/importexporttools/ ImportExportTools for Mozilla Thunderbird by Paolo Kaosmos. ImportExportTools does not do IMAP.
I initially wrote imapsync in July 2001 because an enterprise, called BaSystemes, paid me to install a new imap server without losing huge old mailboxes located in a far away remote imap server, accessible by an often broken low-bandwidth ISDN link.
I had to verify every mailbox was well transferred, all folders, all messages, without wasting bandwidth or creating duplicates upon resyncs. The imapsync design was made with the beautiful rsync command in mind.
Imapsync started its life as a patch of the copy_folder.pl script. The script copy_folder.pl comes from the Mail-IMAPClient-2.1.3 perl module tarball source (more precisely in the examples/ directory of the Mail- IMAPClient tarball).
So many happened since then that I wonder if it remains any lines of the original copy_folder.pl in imapsync source code.
LUAC(1)                      General Commands Manual                     LUAC(1)
luac - Lua compiler
luac [ options ] [ filenames ]
luac is the Lua compiler.  It translates programs written in the Lua programming language into binary files containing precompiled chunks that can be later loaded and executed.
The main advantages of precompiling chunks are: faster loading, protecting source code from accidental user changes, and off-line syntax checking.  Precompiling does not imply faster execution because in Lua chunks are always compiled into bytecodes before being executed.  luac simply allows those bytecodes to be saved in a file for later execution. Precompiled chunks are not necessarily smaller than the corresponding source.  The main goal in precompiling is faster loading.
In the command line, you can mix text files containing Lua source and binary files containing precompiled chunks.  luac produces a single output file containing the combined bytecodes for all files given. Executing the combined file is equivalent to executing the given files. By default, the output file is named luac.out, but you can change this with the -o option.
Precompiled chunks are not portable across different architectures. Moreover, the internal format of precompiled chunks is likely to change when a new version of Lua is released.  Make sure you save the source files of all Lua programs that you precompile.