diff --git a/docsrc/conf.py b/docsrc/conf.py index 120e56b93..2d5ba676f 100644 --- a/docsrc/conf.py +++ b/docsrc/conf.py @@ -1,543 +1,543 @@ # -*- coding: utf-8 -*- # # Cyrus IMAP documentation build configuration file, created by # sphinx-quickstart on Fri Jun 6 19:23:19 2014. # # This file is execfile()d with the current directory set to its # containing dir. # # # Note that not all possible configuration values are present in this # autogenerated file. # # All configuration values have a default; values that are commented out # serve to show the default. import sys import os # If extensions (or modules to document with autodoc) are in another directory, # add these directories to sys.path here. If the directory is relative to the # documentation root, use os.path.abspath to make it absolute, like shown here. #sys.path.insert(0, os.path.abspath('.')) sys.path.insert(0, os.path.abspath('exts')) # -- General configuration ------------------------------------------------ # If your documentation needs a minimal Sphinx version, state it here. # XXX The oldest version we need to support at present is 1.3.6, and the # XXX oldest version we actually support is 1.3.2, but these versions # XXX don't check the third field properly, so we can't bump this line to # XXX match reality! See discussion from last time we tried to bump this # XXX at https://github.com/cyrusimap/cyrus-imapd/pull/2868 needs_sphinx = '1.2' # Add any Sphinx extension module names here, as strings. They can be # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom # ones. extensions = [ 'sphinx.ext.coverage', 'sphinx.ext.extlinks', 'sphinx.ext.graphviz', 'sphinx.ext.ifconfig', 'sphinx.ext.mathjax', 'sphinx.ext.todo', 'sphinx.ext.intersphinx', ] extensions.append('sphinxlocal.builders.manpage') extensions.append('sphinxlocal.roles.cyrusman') extensions.append('sphinxlocal.builders.gitstamp') gitstamp_fmt = "%b %d %Y" extensions.append('sphinxlocal.sitemap') # We publish master branch at /dev # Other branches are available at multiple locations (3.0 is at 3.0 and stable and /). # Supply all webroots that this set of docs is available at. sitemap_website = ["https://www.cyrusimap.org/dev/"] intersphinx_mapping = {'cyrussasl': ('https://www.cyrusimap.org/sasl', None)} mathjax_path = 'https://cdn.mathjax.org/mathjax/latest/MathJax.js' todo_include_todos = False locale_dirs = [ 'locale/' ] gettext_compact = False # Add any paths that contain templates here, relative to this directory. templates_path = ['_templates'] # The suffix of source filenames. source_suffix = '.rst' # The encoding of source files. #source_encoding = 'utf-8-sig' # The master toctree document. master_doc = 'index' # General information about the project. project = u'Cyrus IMAP' copyright = u'1993-2018, The Cyrus Team' # The version info for the project you're documenting, acts as replacement for # |version| and |release|, also used in various other places throughout the # built documents. # # This is used in breadcrumbs.html to flag the version of the docs the user # is on. It is NOT the latest version: it is the version of the branch this # file is in. # # Needs to be kept in sync with the rst_prolog imap_*_version replacements # below as branches increment version numbers. # May need to also update toplevel index.rst to point to other versions. # # The short X.Y version. version = '3.5.0' # The full version, including alpha/beta/rc tags. release = '3.5.0-alpha0 (dev)' # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages. #language = None # There are two options for replacing |today|: either, you set today to some # non-false value, then it is used: #today = '' # Else, today_fmt is used as the format for a strftime call. #today_fmt = '%B %d, %Y' # List of patterns, relative to source directory, that match files and # directories to ignore when looking for source files. exclude_patterns = [ 'assets', '**/template.rst' ] # The reST default role (used for this markup: `text`) to use for all # documents. #default_role = None # If true, '()' will be appended to :func: etc. cross-reference text. #add_function_parentheses = True # If true, the current module name will be prepended to all description # unit titles (such as .. function::). #add_module_names = True # If true, sectionauthor and moduleauthor directives will be shown in the # output. They are ignored by default. show_authors = True # The name of the Pygments (syntax highlighting) style to use. pygments_style = 'sphinx' # A list of ignored prefixes for module index sorting. #modindex_common_prefix = [] # If true, keep warnings as "system message" paragraphs in the built documents. #keep_warnings = False # -- Options for HTML output ---------------------------------------------- # The theme to use for HTML and HTML Help pages. See the documentation for # a list of builtin themes. html_theme = 'cyrus' html_context = { "display_github": True, # Add 'Edit on Github' link instead of 'View page source' "github_user": "cyrusimap", "github_repo": "cyrus-imapd", "github_version": "master", "conf_py_path": "/docsrc/", "source_suffix": source_suffix, "githubexclude": ["imap/reference/manpages/usercommands/sieveshell", "imap/reference/manpages/systemcommands/cyradm", "imap/reference/manpages/configs/imapd.conf"] } # Theme options are theme-specific and customize the look and feel of a theme # further. For a list of options available for each theme, see the # documentation. html_theme_options = { 'travis_version': 'master'} # Add any paths that contain custom themes here, relative to this directory. html_theme_path = ["exts/themes"] # The name for this set of Sphinx documents. If None, it defaults to # " v documentation". #html_title = None # A shorter title for the navigation bar. Default is the same as html_title. #html_short_title = None # The name of an image file (relative to this directory) to place at the top # of the sidebar. #html_logo = "themes/images/logo.gif" # The name of an image file (within the static path) to use as favicon of the # docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 # pixels large. # html_favicon = "_static/favicon.ico" # Add any paths that contain custom static files (such as style sheets) here, # relative to this directory. They are copied after the builtin static files, # so a file named "default.css" will overwrite the builtin "default.css". html_static_path = ['_static'] # Add any extra paths that contain custom files (such as robots.txt or # .htaccess) here, relative to this directory. These files are copied # directly to the root of the documentation. #html_extra_path = [] # If not '', a 'Last updated on:' timestamp is inserted at every page bottom, # using the given strftime format. # html_last_updated_fmt = '%b %d, %Y' # If true, SmartyPants will be used to convert quotes and dashes to # typographically correct entities. html_use_smartypants = False # Custom sidebar templates, maps document names to template names. html_sidebars = {'**' : ['localtoc.html', 'searchbox.html', 'buildstatus.html']} # Additional templates that should be rendered to pages, maps page names to # template names. #html_additional_pages = {} # If false, no module index is generated. #html_domain_indices = True # If false, no index is generated. #html_use_index = True # If true, the index is split into individual pages for each letter. #html_split_index = False # If true, links to the reST sources are added to the pages. html_show_sourcelink = True # If true, "Created using Sphinx" is shown in the HTML footer. Default is True. #html_show_sphinx = True # If true, "(C) Copyright ..." is shown in the HTML footer. Default is True. #html_show_copyright = True # If true, an OpenSearch description file will be output, and all pages will # contain a tag referring to it. The value of this option must be the # base URL from which the finished HTML is served. #html_use_opensearch = '' # This is the file name suffix for HTML files (e.g. ".xhtml"). #html_file_suffix = None # Output file base name for HTML help builder. htmlhelp_basename = 'Cyrusdoc' # -- Options for LaTeX output --------------------------------------------- latex_elements = { # The paper size ('letterpaper' or 'a4paper'). #'papersize': 'letterpaper', # The font size ('10pt', '11pt' or '12pt'). #'pointsize': '10pt', # Additional stuff for the LaTeX preamble. #'preamble': '', } # Grouping the document tree into LaTeX files. List of tuples # (source start file, target name, title, # author, documentclass [howto, manual, or own class]). latex_documents = [ ('index', 'Cyrus.tex', u'Cyrus Documentation', u'The Cyrus Team', 'manual'), ] # The name of an image file (relative to this directory) to place at the top of # the title page. #latex_logo = None # For "manual" documents, if this is true, then toplevel headings are parts, # not chapters. #latex_use_parts = False # If true, show page references after internal links. #latex_show_pagerefs = False # If true, show URL addresses after external links. #latex_show_urls = False # Documents to append as an appendix to all manuals. #latex_appendices = [] # If false, no module index is generated. #latex_domain_indices = True # -- Options for manual page output --------------------------------------- # (source start file, name, description, authors, manual section). man_pages = [] import glob, os, io # Which paths relate to which man page sections pathset = [ ("imap/reference/manpages/systemcommands/", 8), ("imap/developer/libraries/", 3), ("imap/reference/manpages/usercommands/", 1), ("imap/reference/manpages/configs/", 5) ] # For each man page section/path, # look for all the rst files. # With each file, check if there's an '.. author: ' attribution (strict on # spacing and case sensitivity) and add to the author info. # Then add the file with all its details into the man_page array. # If the file is an :orphan:, then don't include it. current = os.path.abspath(os.getcwd()) for tuple in pathset: os.chdir(tuple[0]) for rstfile in glob.glob("*.rst"): authors = [("The Cyrus Team")] orphan = 'False'; with io.open(rstfile,'r',encoding="utf8") as f: for line in f: if line.startswith(':orphan:'): orphan = 'True'; break; if line.startswith('.. author: '): authors.append(line[11: len(line.strip())]) f.close() if orphan == 'False': man_pages.append( (os.path.splitext(os.path.join(tuple[0],rstfile))[0], os.path.splitext(rstfile)[0], u'Cyrus IMAP documentation', authors, tuple[1]) ) os.chdir(current) # If true, show URL addresses after external links. #man_show_urls = False # -- Options for Texinfo output ------------------------------------------- # Grouping the document tree into Texinfo files. List of tuples # (source start file, target name, title, author, # dir menu entry, description, category) texinfo_documents = [ ('index', 'Cyrus', u'Cyrus Documentation', u'The Cyrus Team', 'Cyrus', 'One line description of project.', 'Miscellaneous'), ] # Documents to append as an appendix to all manuals. #texinfo_appendices = [] # If false, no module index is generated. #texinfo_domain_indices = True # How to display URL addresses: 'footnote', 'no', or 'inline'. #texinfo_show_urls = 'footnote' # If true, do not generate a @detailmenu in the "Top" node's menu. #texinfo_no_detailmenu = False # -- Options for Epub output ---------------------------------------------- # Bibliographic Dublin Core info. epub_title = u'Cyrus' epub_author = u'The Cyrus Team' epub_publisher = u'The Cyrus Team' epub_copyright = u'2014, The Cyrus Team' # The basename for the epub file. It defaults to the project name. epub_basename = u'Cyrus' # The HTML theme for the epub output. Since the default themes are not optimized # for small screen space, using the same theme for HTML and epub output is # usually not wise. This defaults to 'epub', a theme designed to save visual # space. #epub_theme = 'epub' # The language of the text. It defaults to the language option # or en if the language is not set. #epub_language = '' # The scheme of the identifier. Typical schemes are ISBN or URL. #epub_scheme = '' # The unique identifier of the text. This can be a ISBN number # or the project homepage. #epub_identifier = '' # A unique identification for the text. #epub_uid = '' # A tuple containing the cover image and cover page html template filenames. #epub_cover = () # A sequence of (type, uri, title) tuples for the guide element of content.opf. #epub_guide = () # HTML files that should be inserted before the pages created by sphinx. # The format is a list of tuples containing the path and title. #epub_pre_files = [] # HTML files shat should be inserted after the pages created by sphinx. # The format is a list of tuples containing the path and title. #epub_post_files = [] # A list of files that should not be packed into the epub file. epub_exclude_files = ['search.html'] # The depth of the table of contents in toc.ncx. #epub_tocdepth = 3 # Allow duplicate toc entries. #epub_tocdup = True # Choose between 'default' and 'includehidden'. #epub_tocscope = 'default' # Fix unsupported image types using the PIL. #epub_fix_images = False # Scale large images. #epub_max_image_width = 0 # How to display URL addresses: 'footnote', 'no', or 'inline'. #epub_show_urls = 'inline' # If false, no index is generated. #epub_use_index = True # When this is updated, you may also need to update the version and release # definitions listed above to stay up to date. rst_prolog = """ .. |imap_last_stable_version| replace:: 3.2.6 .. |imap_last_stable_branch| replace:: `cyrus-imapd-3.2` -.. |imap_current_stable_version| replace:: 3.4.0-beta3 +.. |imap_current_stable_version| replace:: 3.4.0-rc1 .. |imap_current_stable_branch| replace:: `cyrus-imapd-3.4` .. |imap_latest_development_version| replace:: 3.5.0-alpha0 .. |imap_latest_development_branch| replace:: master .. |imap_tikanga_stock_version| replace:: 2.3.7 .. |imap_santiago_stock_version| replace:: 2.3.16 .. |imap_maipo_stock_version| replace:: 2.4.17 .. |imap_precise_stock_version| replace:: 2.4.12-2 .. |imap_trusty_stock_version| replace:: 2.4.17+caldav~beta9-3 .. |imap_utopic_stock_version| replace:: 2.4.17+caldav~beta10-5 .. |imap_vivid_stock_version| replace:: 2.4.17+caldav~beta10-17 .. |imap_wily_stock_version| replace:: 2.4.17+caldav~beta10-17 .. |sasl_current_stable_version| replace:: 2.1.27 .. |imap_stable_release_notes| raw:: html - 3.4.0-beta3 + 3.4.0-rc1 .. |imap_development_release_notes| raw:: html 3.5.0-alpha0 """ rst_prolog += """ .. |git_cyrus_imapd_url| replace:: https://github.com/cyrusimap/cyrus-imapd.git """ # The version in which compatibility support for RFC 2086 (the 'c' and # 'd' rights) is dropped. rst_prolog += """ .. |imap_version_rfc2086_dropped| replace:: 3.0 """ # The version in which the altnamespace setting default changes (was # off). rst_prolog += """ .. |imap_version_altnamespace_default_on| replace:: 3.0 """ # The version in which the unixhierarchysep setting default changes (was # off). rst_prolog += """ .. |imap_version_unixhierarchysep_default_on| replace:: 3.0 """ # The version in which the master process was renamed to cyrus-master. # Except the rename never happened, so removing this for now as it's just confusing. ## rst_prolog += """ ## .. |imap_version_master_renamed| replace:: 3.0 ## """ # Bloilerplate configuration file texts. rst_prolog += """ .. |default-conf-text| replace:: reads its configuration options out of the :cyrusman:`imapd.conf(5)` file unless specified otherwise by **-C**. .. |cli-dash-c-text| replace:: Use the specified configuration file *config-file* rather than the default :cyrusman:`imapd.conf(5)`. .. |def-confdir-text| replace:: The *configdirectory* option in :cyrusman:`imapd.conf(5)` is used to determine the default location of the """ # New feature version disclaimer for 3.0 (big changes) rst_prolog += """ .. |v3-new-feature| replace:: This feature was introduced in version 3.0. .. |v3-new-command| replace:: This command was introduced in version 3.0. """ # New feature version disclaimer for master branch rst_prolog += """ .. |master-new-feature| replace:: This feature is only available on the master branch. .. |master-new-command| replace:: This command is only available on the master branch. """ rst_prolog += """ .. |AMS| replace:: :abbr:`AMS (Andrew Mail System)` .. |CMU| replace:: :abbr:`CMU (Carnegie Mellon University)` """ rst_prolog += """ .. |change-default-config| replace:: *This shows the default value: change it in imapd.conf to suit your needs.* """ # Uncomment this if you publish to, like, www.cyrusimap.org/~vanmeeuwen/ #rst_prolog += """ #.. WARNING:: #You are looking at documentation that is maintained by interval. #Please see https://www.cyrusimap.org/ for better maintained #documentation. #""" # Use this as :task:`18` # XXX would be really nice to be able to have 'github-tarball' and 'github-sig' # XXX handlers here, except that these urls require expanding the version string # XXX twice, and the sphinx extlinks thingy currently only supports a single %s extlinks = { 'draft':('https://tools.ietf.org/html/%s', ''), 'issue':('https://github.com/cyrusimap/cyrus-imapd/issues/%s', 'Issue #'), 'cyrus-2.5':('https://www.cyrusimap.org/2.5%s',None), 'cyrus-3.0':('https://www.cyrusimap.org/3.0%s',None), 'cyrus-3.2':('https://www.cyrusimap.org/3.2%s',None), 'cyrus-3.4':('https://www.cyrusimap.org/3.4%s',None), 'cyrus-dev':('https://www.cyrusimap.org/dev%s',None), 'cyrus-stable': ('https://www.cyrusimap.org%s',None), 'github-release': ('https://github.com/cyrusimap/cyrus-imapd/releases/tag/cyrus-imapd-%s', 'cyrus-imapd-'), } # Change this to whatever your output root is # If you're in a local build environment, this might be file://cyrus-imapd/doc/build/imap/admin/$num/$topic/$topic.html #cyrus_man_url_regex = "http://www.cyrusimap.org/imap/admin/$num/$topic.html"; diff --git a/docsrc/imap/download/release-notes/3.4/x/3.4.0-rc1.rst b/docsrc/imap/download/release-notes/3.4/x/3.4.0-rc1.rst new file mode 100644 index 000000000..001e7f3e3 --- /dev/null +++ b/docsrc/imap/download/release-notes/3.4/x/3.4.0-rc1.rst @@ -0,0 +1,109 @@ +:tocdepth: 3 + +==================================== +Cyrus IMAP 3.4.0-rc1 Release Notes +==================================== + +Download from GitHub: + + * https://github.com/cyrusimap/cyrus-imapd/releases/download/cyrus-imapd-3.4.0-rc1/cyrus-imapd-3.4.0-rc1.tar.gz + * https://github.com/cyrusimap/cyrus-imapd/releases/download/cyrus-imapd-3.4.0-rc1/cyrus-imapd-3.4.0-rc1.tar.gz.sig + +.. _relnotes-3.4.0-rc1-changes: + +Major changes since the 3.2 series +================================== + +* DAV improvements +* Improved performance for users with large folders +* LITERAL- maximum size is now honoured (:rfc:`7888`) +* Support for the ESORT (but not CONTEXT) extension from :rfc:`5267` +* Experimental :draft:`JMAP for Sieve Scripts ` + support + (requires `jmap_nonstandard_extensions: yes` in :cyrusman:`imapd.conf(5)`). +* Experimental :draft:`Handling Message Disposition Notification with JMAP + ` support + (requires `jmap_nonstandard_extensions: yes` in :cyrusman:`imapd.conf(5)`). +* Experimental JMAP Backup extension (requires + `jmap_nonstandard_extensions: yes` in :cyrusman:`imapd.conf(5)`). +* Experimental JMAP Notes extension (requires + `jmap_nonstandard_extensions: yes` in :cyrusman:`imapd.conf(5)`). +* Experimental JMAP Blob extension (requires + `jmap_nonstandard_extensions: yes` in :cyrusman:`imapd.conf(5)`). +* Experimental JMAP Mail extension (requires + `jmap_nonstandard_extensions: yes` in :cyrusman:`imapd.conf(5)`). +* New cyrus.index format v17 adds changes_epoch field, needed by JMAP Backups + extension +* New `reverseuniqueids` :cyrusman:`imapd.conf(5)` option (default on), which + improves performance for users with large mailboxes +* Further improvements to the `reverseacls` :cyrusman:`imapd.conf(5)` + performance option +* Improvements to replication reliability and performance +* Experimental vnd.cyrus.log and vnd.cyrus.jmapquery Sieve extensions +* Experimental Sieve Snooze extension based on + :draft:`draft-ietf-extra-sieve-snooze` +* Experimental Sieve mailboxid extension based on + :draft:`draft-ietf-extra-sieve-mailboxid` +* Improvements to conversations +* New `mailbox_maxmessages_addressbook`, `mailbox_maxmessages_calendar`, and + `mailbox_maxmessages_email` :cyrusman:`imapd.conf(5)` options for providing + server-wide limits on the amount of objects in any one mailbox, independently + of quotas. These default to `0` (unlimited) for backward compatibility, but + are highly recommended for protecting your server from misbehaving clients. +* New IMAP create/delete behaviour based on + :draft:`draft-ietf-extra-imap4rev2`: mailboxes containing child mailboxes + can no longer be deleted; and when creating mailboxes, ancestors will be + created as needed. +* CRC32 optimisations +* :cyrusman:`quota(8)` and :cyrusman:`cyr_expire(8)` arguments are now in + the admin namespace like other tools +* Support for per-language indexing and searching +* SNMP support has been removed, as it was broken and unmaintained +* New `sync_rightnow_channel` :cyrusman:`imapd.conf(5)` option to enable + real-time replication to the specified channel as writes occur. +* Caching of mailbox state for quicker replication turnaround. Configure + `sync_cache_db` and `sync_cache_db_path` in :cyrusman:`imapd.conf(5)` to + enable. +* New `search-fuzzy-always` annotation allows per-user override of the + `search_fuzzy_always` :cyrusman:`imapd.conf(5)` option +* New `lmtp_preparse` :cyrusman:`imapd.conf(5)` option for parsing incoming + messages before locking the mailbox. +* New `search_index_skip_users` and `search_index_skip_domains` + :cyrusman:`imapd.conf(5)` options for skipping indexing of particular + users/domains. +* The HTTP Admin module's Currently Running Services feature now works + on the major BSDs (thanks Felix J. Ogris) +* :cyrusman:`squatter(8)` once again supports the ``-s`` option to skip + reindexing mailboxes which were not modified since the last index + (Squat backend only) +* :cyrusman:`squatter(8)` now supports long options +* Improvements to search query normalisation performance + + +Updates to default configuration +================================ + +The :cyrusman:`cyr_info(8)` `conf`, `conf-all` and `conf-default` subcommands +accept an `-s ` argument to highlight :cyrusman:`imapd.conf(5)` +options that are new or whose behaviour has changed since the specified +version. We recommend using this when evaluating a new Cyrus version to +check which configuration options you will need to examine and maybe set or +change during the process. + +* The `annotation_definitions` file is now loaded case-insensitively +* Implementations may want to revisit their `search_normalisation_max` + settings, but its default value 1000 is a good conservative choice. Current + server-grade hardware may use 20000 or more. + +Security fixes +============== + +* None so far + +Significant bugfixes +==================== + +* Fixed: Sieve Editheader Extension (:rfc:`5293`) now works correctly with + respect to section 7, Interaction with Other Sieve Extensions. +* Fixed :issue:`2598`: indexed search now works correctly with Squat engine + again