BList

Next: , Previous: , Up: (dir)   [Contents][Index]

BList

Display bookmarks in an Ibuffer way.

Copyright © 2021, 2022, 2023 Durand

Permission is granted to copy, distribute and/or modify this document under the terms of the GNU Free Documentation License, Version 1.3 or any later version published by the Free Software Foundation; with no Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts. A copy of the license is included in the section entitled “GNU Free Documentation License”.

A copy of the license is also available from the Free Software Foundation Web site at https://www.gnu.org/licenses/fdl.html.

The document was typeset with GNU Texinfo.

Table of Contents


Next: , Previous: , Up: BList   [Contents][Index]

1 About

The built-in library bookmark.el is useful for storing information that can be retrieved later. But I find the built-in mechanism to display the list of bookmarks not so satisfactory, so I wrote this little package to display the list of bookmarks in an Ibuffer way.


Next: , Previous: , Up: BList   [Contents][Index]

2 Dependency

This package is driven by another package: ilist. So make sure to install that before using this package. In fact, the package ilist was written as an abstraction of the mechanisms of this package.


Next: , Previous: , Up: BList   [Contents][Index]

3 Usage

After installing, one can call the function blist-list-bookmarks, or simply blist, to display the list of bookmarks. Of course, one can bind a key to that function for easier invocations.


Next: , Previous: , Up: Usage   [Contents][Index]

3.1 Screenshot

A picture says more about the package than a thousand words. Below is how the list of bookmarks looks like on my end:

scaled-screenshot1

Next: , Previous: , Up: Usage   [Contents][Index]

3.2 Example configuration

Some examples of configurations are included so that it is easier to begin configuring the package.

See the following subsections for more details.


3.2.1 Example of manual grouping

(setq blist-filter-groups
      (list
       (cons "Eshell" #'blist-eshell-p)
       (cons "ELisp" #'blist-elisp-p)
       (cons "PDF" #'blist-pdf-p)
       (cons "Info" #'blist-info-p)
       (cons "Default" #'blist-default-p)))

;; Whether one wants to use the header line or not
(setq blist-use-header-p nil)

;; Just use manual filter groups for this example
(setq blist-filter-features (list 'manual))

;; Eshell and Default are defined in the package by default

(blist-define-criterion "elisp" "ELisp"
  (string-match-p
   "\\.el$"
   (bookmark-get-filename bookmark)))

(blist-define-criterion "pdf" "PDF"
  (eq (bookmark-get-handler bookmark)
      #'pdf-view-bookmark-jump))

(blist-define-criterion "info" "Info"
  (eq (bookmark-get-handler bookmark)
      #'Info-bookmark-jump))

3.2.2 Example of automatic grouping

(setq blist-filter-features (list 'auto))

;; This falls back to use file names to determine the type.
(setq blist-automatic-filter-groups
      #'ilist-automatic-group-blist-default)

;; This only considers the types of bookmarks.
(setq blist-automatic-filter-groups
      #'ilist-automatic-group-blist-type-only)

;; Or define ones own grouping function

3.2.3 Example of combining the two groupings

;; The order matters not.
(setq blist-filter-features (list 'manual 'auto))

;; We can use manual groups to place certain important categories of
;; bookmarks at the top of the list.
;;
;; Make sure not to include a default group, otherwise tha automatic
;; grouping functions would have no chance of being run.
(setq blist-filter-groups
      (list
       (cons "Eshell" #'blist-eshell-p)
       (cons "ELisp" #'blist-elisp-p)
       (cons "PDF" #'blist-pdf-p)
       (cons "Info" #'blist-info-p)))

;; Either this
(setq blist-automatic-filter-groups
      #'ilist-automatic-group-blist-default)

;; Or this
(setq blist-automatic-filter-groups
      #'ilist-automatic-group-blist-type-only)

;; Or define ones own grouping function

Next: , Previous: , Up: Usage   [Contents][Index]

3.4 Columns

As one can see, the display has two columns: a name column and a location column. The name column shows the names of the bookmarks, while the location column shows the locations, which are either the filename or the location attributes of the bookmarks.

The variable blist-display-location-p controls whether to display the locations or not. Also, one can toggle the display of the locations interactively by blist-toggle-location.

The variable blist-maximal-name-len determines the maximal length of the name column. And the variable blist-elide-string determines how to elide the name, when it gets too long.

If one feels like so, then one can play with the function blist-name-column to control the name column.


Next: , Previous: , Up: Usage   [Contents][Index]

3.5 Groups

An important feature of this package is the filter groups. They are criteria that group bookmarks together under various sections. So one can find all bookmarks of, say, Eshell buffers in one section.

There are two types of filter groups: the fixed filter groups and the automatic filter groups.


Next: , Previous: , Up: Groups   [Contents][Index]

3.5.1 Fixed filter groups

The fixed filter groups are stored in the variable blist-filter-groups. One can add or remove filter groups to that variable. That variable is a list of filter groups, while each filter group is a cons cell of the form (NAME . FUN), where NAME is a string which will be displayed as the section header, and FUN is a function that accepts a bookmark as its argument, and returns non-nil when and only when that bookmark belongs to the group.

Since defining the group functions might be tedious, the package also provides a convenient macro blist-define-criterion for the users to define filter groups easily. See the documentation string of that macro for details.

Also, the order of the filter groups matters: the filter groups that occur earlier on the list have higher priority. So if an item belongs to multiple groups, it will be classified under the group that is the earliest on the list.

Note that the default filter group, which always returns t for every bookmark, is not needed. If a bookmark does not belong to any filter group, it will be grouped into a default group, whose name is given by blist-filter-default-label.

Note that this is a feature of “blist”, and not of “ilist”: you can display a list without default groups.


3.5.2 Automatic filter groups

An automatic filter group is a function that can give labels to elements in a list. These labels will be used to group elements automatically: the elements with the same label will be grouped together. Besides, an automatic filter group is also responsible for sorting group labels, and for giving a default label, if no default labels are specified.

To be precise, an automatic filter group is a function with the signature: (ELEMENT &optional TYPE). The optional argument TYPE says what the caller wants from the function:

nil

If it is omitted or nil, the function should just return the label for ELEMENT.

default

If it is the symbol default, the function should return a default label.

sorter

If it is the symbol sorter, the function should return a function with two arguments, X and Y. This returned function should return a non-nil value if and only if group X should be placed earlier than group Y.

The automatic filter group to use is stored in the variable blist-automatic-filter-groups. Its default value is blist-automatic-filter-groups-default.

If you want to define your own automatic filter group, then the macro ilist-define-automatic-group, or ilist-dag, defined in “ilist”, might come in handy. The default automatic filter group is defined by that macro, for your information.


3.5.3 Two default automatic groups

There are two pre-defined automatic groups in the package: the default one and the type-only one.


3.5.3.1 Default group

In Emacs 29 or later, if a bookmark handler function symbol has a property called bookmark-handler-type, it will be recognized as the type of the bookmark, which can be retrieved by the function bookmark-type-from-full-record.

The default group will use the type of a bookmark as the group header, if the type is available, otherwise it falls back to use file name extensions.


3.5.3.2 Type-only group

This automatic group only uses the type of a bookmark as the group header. If the type is not available, it always uses the default group.


3.5.4 Combine fixed and automatic filter groups

What if one wants to use both the fixed filter groups and the automatic filter group to group elements? Then one can set the variable blist-filter-features. This variable should be a list of featuers to use. Currently there are two features: manual and auto. If one adds manual to the list of features, then the fixed filter groups will be used; if one adds auto to the list of features, then the automatic filter groups will be used.

Further, if one adds both manual and auto to the list of features, then both filter groups will be used. The elements will first go through the fixed filter groups to see if it belongs to some fixed filter group. If an element belongs to none of the fixed filter groups, then the automatic filter group will be used to find the label for the element. If a poor element is given no labels, then the default label blist-filter-default-label will be used.

Wait, one asks, what if the list contains no features? Don’t worry, it is not the end of blist. In this case all elements will be considered as belonging to the default group blist-filter-default-label.


Next: , Previous: , Up: Usage   [Contents][Index]

3.6 Calling convention(s)

For the ease and brevity of writing, let’s establish a convention for describing the interactive arguments of functions.

In this document, the phrase XYZ-convention should be understood as a specification of how the arguments to a function are supposed to be obtained when called interactively. Here the letters XYZ have special meanings:

Note: It is implied that the bookmarks in the folded groups are not operated upon by user commands.

M

Use marked bookmarks.

R

Use the bookmarks in the region, if the region is active.

G

Use the bookmarks of a group, if the point is at the heading of that group.

0

Use the 0-th bookmark, that is, the bookmark at point, if any.

C

Use use completing-read to let the user choose a bookmark.

P

Use the ARG next bookmarks, where ARG is the prefix argument.


Next: , Previous: , Up: Usage   [Contents][Index]

3.8 Marking

The following is a list of default key-bindings to mark bookmarks and to operate on the bookmarks.

Unless stated otherwise, they all follow the P-convention.

m

Mark the bookmark with the default mark (blist-default-mark) and advance.

d
k

Mark for deletion and advance.

C-d

Mark for deletion and go backwards.

x

Delete all bookmarks that are marked for deletion.

D

Delete the bookmark immediately (the MRG0-convention).

u

Unmark the bookmark and advance.

DEL

Unmark the bookmark and go backwards.

U

Unmark all bookmarks.

M-DEL
* *

prompt for a mark and unmark all boomarks that are marked with the entered mark (using read-char).

% n

Mark bookmarks whose name matches a regular expression.

% l

Mark bookmarks whose location matches a regular expression.

* c

Change the marks from OLD to NEW (using read-char)

t

Toggle marks: an item is going to be marked if and only if it is currently not marked.


Next: , Previous: , Up: Usage   [Contents][Index]

3.9 Jump to bookmarks

The following lists the default key-bindings for jumping to, or opening bookmarks. Except for v, they operate on the bookmark (or group) at point.

RET

Either open the bookmark in this window or toggle the group at point.

o

Open the bookmark in another window.

v

Select the bookmarks (the MG0-convention). How multiple bookmarks are opened is controlled by the variable blist-select-manner. See its documentation for details.


Next: , Previous: , Up: Usage   [Contents][Index]

3.10 Annotations

The following lists the default key-bindings for operating on the annotations of bookmarks.

a

View the annotations of bookmarks (the MGC-convention).

A

View the annotations of all bookmarks.

e

Edit the annotation of the bookmark at point. If called with universal-argument, prompt for the bookmark to edit with completion.


Previous: , Up: Usage   [Contents][Index]

3.11 Others

R

Relocate the bookmark.

r

Rename the bookmark.

l

Load bookmarks from a file, and prepend these bookmarks to the front of the bookmarks list.

S-RET

Toggle all other groups than the group at which the cursor sits. This creates a kind of narrowing effect, and is fun to apply on different groups successively.

Some functions are too minor to record here. Use describe-mode in the list of bookmarks to see all available key-bindings.


Next: , Previous: , Up: BList   [Contents][Index]

Appendix A Copying This Manual

Version 1.3, 3 November 2008
Copyright © 2000, 2001, 2002, 2007, 2008 Free Software Foundation, Inc.
https://fsf.org/

Everyone is permitted to copy and distribute verbatim copies
of this license document, but changing it is not allowed.
  1. PREAMBLE

    The purpose of this License is to make a manual, textbook, or other functional and useful document free in the sense of freedom: to assure everyone the effective freedom to copy and redistribute it, with or without modifying it, either commercially or noncommercially. Secondarily, this License preserves for the author and publisher a way to get credit for their work, while not being considered responsible for modifications made by others.

    This License is a kind of “copyleft”, which means that derivative works of the document must themselves be free in the same sense. It complements the GNU General Public License, which is a copyleft license designed for free software.

    We have designed this License in order to use it for manuals for free software, because free software needs free documentation: a free program should come with manuals providing the same freedoms that the software does. But this License is not limited to software manuals; it can be used for any textual work, regardless of subject matter or whether it is published as a printed book. We recommend this License principally for works whose purpose is instruction or reference.

  2. APPLICABILITY AND DEFINITIONS

    This License applies to any manual or other work, in any medium, that contains a notice placed by the copyright holder saying it can be distributed under the terms of this License. Such a notice grants a world-wide, royalty-free license, unlimited in duration, to use that work under the conditions stated herein. The “Document”, below, refers to any such manual or work. Any member of the public is a licensee, and is addressed as “you”. You accept the license if you copy, modify or distribute the work in a way requiring permission under copyright law.

    A “Modified Version” of the Document means any work containing the Document or a portion of it, either copied verbatim, or with modifications and/or translated into another language.

    A “Secondary Section” is a named appendix or a front-matter section of the Document that deals exclusively with the relationship of the publishers or authors of the Document to the Document’s overall subject (or to related matters) and contains nothing that could fall directly within that overall subject. (Thus, if the Document is in part a textbook of mathematics, a Secondary Section may not explain any mathematics.) The relationship could be a matter of historical connection with the subject or with related matters, or of legal, commercial, philosophical, ethical or political position regarding them.

    The “Invariant Sections” are certain Secondary Sections whose titles are designated, as being those of Invariant Sections, in the notice that says that the Document is released under this License. If a section does not fit the above definition of Secondary then it is not allowed to be designated as Invariant. The Document may contain zero Invariant Sections. If the Document does not identify any Invariant Sections then there are none.

    The “Cover Texts” are certain short passages of text that are listed, as Front-Cover Texts or Back-Cover Texts, in the notice that says that the Document is released under this License. A Front-Cover Text may be at most 5 words, and a Back-Cover Text may be at most 25 words.

    A “Transparent” copy of the Document means a machine-readable copy, represented in a format whose specification is available to the general public, that is suitable for revising the document straightforwardly with generic text editors or (for images composed of pixels) generic paint programs or (for drawings) some widely available drawing editor, and that is suitable for input to text formatters or for automatic translation to a variety of formats suitable for input to text formatters. A copy made in an otherwise Transparent file format whose markup, or absence of markup, has been arranged to thwart or discourage subsequent modification by readers is not Transparent. An image format is not Transparent if used for any substantial amount of text. A copy that is not “Transparent” is called “Opaque”.

    Examples of suitable formats for Transparent copies include plain ASCII without markup, Texinfo input format, LaTeX input format, SGML or XML using a publicly available DTD, and standard-conforming simple HTML, PostScript or PDF designed for human modification. Examples of transparent image formats include PNG, XCF and JPG. Opaque formats include proprietary formats that can be read and edited only by proprietary word processors, SGML or XML for which the DTD and/or processing tools are not generally available, and the machine-generated HTML, PostScript or PDF produced by some word processors for output purposes only.

    The “Title Page” means, for a printed book, the title page itself, plus such following pages as are needed to hold, legibly, the material this License requires to appear in the title page. For works in formats which do not have any title page as such, “Title Page” means the text near the most prominent appearance of the work’s title, preceding the beginning of the body of the text.

    The “publisher” means any person or entity that distributes copies of the Document to the public.

    A section “Entitled XYZ” means a named subunit of the Document whose title either is precisely XYZ or contains XYZ in parentheses following text that translates XYZ in another language. (Here XYZ stands for a specific section name mentioned below, such as “Acknowledgements”, “Dedications”, “Endorsements”, or “History”.) To “Preserve the Title” of such a section when you modify the Document means that it remains a section “Entitled XYZ” according to this definition.

    The Document may include Warranty Disclaimers next to the notice which states that this License applies to the Document. These Warranty Disclaimers are considered to be included by reference in this License, but only as regards disclaiming warranties: any other implication that these Warranty Disclaimers may have is void and has no effect on the meaning of this License.

  3. VERBATIM COPYING

    You may copy and distribute the Document in any medium, either commercially or noncommercially, provided that this License, the copyright notices, and the license notice saying this License applies to the Document are reproduced in all copies, and that you add no other conditions whatsoever to those of this License. You may not use technical measures to obstruct or control the reading or further copying of the copies you make or distribute. However, you may accept compensation in exchange for copies. If you distribute a large enough number of copies you must also follow the conditions in section 3.

    You may also lend copies, under the same conditions stated above, and you may publicly display copies.

  4. COPYING IN QUANTITY

    If you publish printed copies (or copies in media that commonly have printed covers) of the Document, numbering more than 100, and the Document’s license notice requires Cover Texts, you must enclose the copies in covers that carry, clearly and legibly, all these Cover Texts: Front-Cover Texts on the front cover, and Back-Cover Texts on the back cover. Both covers must also clearly and legibly identify you as the publisher of these copies. The front cover must present the full title with all words of the title equally prominent and visible. You may add other material on the covers in addition. Copying with changes limited to the covers, as long as they preserve the title of the Document and satisfy these conditions, can be treated as verbatim copying in other respects.

    If the required texts for either cover are too voluminous to fit legibly, you should put the first ones listed (as many as fit reasonably) on the actual cover, and continue the rest onto adjacent pages.

    If you publish or distribute Opaque copies of the Document numbering more than 100, you must either include a machine-readable Transparent copy along with each Opaque copy, or state in or with each Opaque copy a computer-network location from which the general network-using public has access to download using public-standard network protocols a complete Transparent copy of the Document, free of added material. If you use the latter option, you must take reasonably prudent steps, when you begin distribution of Opaque copies in quantity, to ensure that this Transparent copy will remain thus accessible at the stated location until at least one year after the last time you distribute an Opaque copy (directly or through your agents or retailers) of that edition to the public.

    It is requested, but not required, that you contact the authors of the Document well before redistributing any large number of copies, to give them a chance to provide you with an updated version of the Document.

  5. MODIFICATIONS

    You may copy and distribute a Modified Version of the Document under the conditions of sections 2 and 3 above, provided that you release the Modified Version under precisely this License, with the Modified Version filling the role of the Document, thus licensing distribution and modification of the Modified Version to whoever possesses a copy of it. In addition, you must do these things in the Modified Version:

    1. Use in the Title Page (and on the covers, if any) a title distinct from that of the Document, and from those of previous versions (which should, if there were any, be listed in the History section of the Document). You may use the same title as a previous version if the original publisher of that version gives permission.
    2. List on the Title Page, as authors, one or more persons or entities responsible for authorship of the modifications in the Modified Version, together with at least five of the principal authors of the Document (all of its principal authors, if it has fewer than five), unless they release you from this requirement.
    3. State on the Title page the name of the publisher of the Modified Version, as the publisher.
    4. Preserve all the copyright notices of the Document.
    5. Add an appropriate copyright notice for your modifications adjacent to the other copyright notices.
    6. Include, immediately after the copyright notices, a license notice giving the public permission to use the Modified Version under the terms of this License, in the form shown in the Addendum below.
    7. Preserve in that license notice the full lists of Invariant Sections and required Cover Texts given in the Document’s license notice.
    8. Include an unaltered copy of this License.
    9. Preserve the section Entitled “History”, Preserve its Title, and add to it an item stating at least the title, year, new authors, and publisher of the Modified Version as given on the Title Page. If there is no section Entitled “History” in the Document, create one stating the title, year, authors, and publisher of the Document as given on its Title Page, then add an item describing the Modified Version as stated in the previous sentence.
    10. Preserve the network location, if any, given in the Document for public access to a Transparent copy of the Document, and likewise the network locations given in the Document for previous versions it was based on. These may be placed in the “History” section. You may omit a network location for a work that was published at least four years before the Document itself, or if the original publisher of the version it refers to gives permission.
    11. For any section Entitled “Acknowledgements” or “Dedications”, Preserve the Title of the section, and preserve in the section all the substance and tone of each of the contributor acknowledgements and/or dedications given therein.
    12. Preserve all the Invariant Sections of the Document, unaltered in their text and in their titles. Section numbers or the equivalent are not considered part of the section titles.
    13. Delete any section Entitled “Endorsements”. Such a section may not be included in the Modified Version.
    14. Do not retitle any existing section to be Entitled “Endorsements” or to conflict in title with any Invariant Section.
    15. Preserve any Warranty Disclaimers.

    If the Modified Version includes new front-matter sections or appendices that qualify as Secondary Sections and contain no material copied from the Document, you may at your option designate some or all of these sections as invariant. To do this, add their titles to the list of Invariant Sections in the Modified Version’s license notice. These titles must be distinct from any other section titles.

    You may add a section Entitled “Endorsements”, provided it contains nothing but endorsements of your Modified Version by various parties—for example, statements of peer review or that the text has been approved by an organization as the authoritative definition of a standard.

    You may add a passage of up to five words as a Front-Cover Text, and a passage of up to 25 words as a Back-Cover Text, to the end of the list of Cover Texts in the Modified Version. Only one passage of Front-Cover Text and one of Back-Cover Text may be added by (or through arrangements made by) any one entity. If the Document already includes a cover text for the same cover, previously added by you or by arrangement made by the same entity you are acting on behalf of, you may not add another; but you may replace the old one, on explicit permission from the previous publisher that added the old one.

    The author(s) and publisher(s) of the Document do not by this License give permission to use their names for publicity for or to assert or imply endorsement of any Modified Version.

  6. COMBINING DOCUMENTS

    You may combine the Document with other documents released under this License, under the terms defined in section 4 above for modified versions, provided that you include in the combination all of the Invariant Sections of all of the original documents, unmodified, and list them all as Invariant Sections of your combined work in its license notice, and that you preserve all their Warranty Disclaimers.

    The combined work need only contain one copy of this License, and multiple identical Invariant Sections may be replaced with a single copy. If there are multiple Invariant Sections with the same name but different contents, make the title of each such section unique by adding at the end of it, in parentheses, the name of the original author or publisher of that section if known, or else a unique number. Make the same adjustment to the section titles in the list of Invariant Sections in the license notice of the combined work.

    In the combination, you must combine any sections Entitled “History” in the various original documents, forming one section Entitled “History”; likewise combine any sections Entitled “Acknowledgements”, and any sections Entitled “Dedications”. You must delete all sections Entitled “Endorsements.”

  7. COLLECTIONS OF DOCUMENTS

    You may make a collection consisting of the Document and other documents released under this License, and replace the individual copies of this License in the various documents with a single copy that is included in the collection, provided that you follow the rules of this License for verbatim copying of each of the documents in all other respects.

    You may extract a single document from such a collection, and distribute it individually under this License, provided you insert a copy of this License into the extracted document, and follow this License in all other respects regarding verbatim copying of that document.

  8. AGGREGATION WITH INDEPENDENT WORKS

    A compilation of the Document or its derivatives with other separate and independent documents or works, in or on a volume of a storage or distribution medium, is called an “aggregate” if the copyright resulting from the compilation is not used to limit the legal rights of the compilation’s users beyond what the individual works permit. When the Document is included in an aggregate, this License does not apply to the other works in the aggregate which are not themselves derivative works of the Document.

    If the Cover Text requirement of section 3 is applicable to these copies of the Document, then if the Document is less than one half of the entire aggregate, the Document’s Cover Texts may be placed on covers that bracket the Document within the aggregate, or the electronic equivalent of covers if the Document is in electronic form. Otherwise they must appear on printed covers that bracket the whole aggregate.

  9. TRANSLATION

    Translation is considered a kind of modification, so you may distribute translations of the Document under the terms of section 4. Replacing Invariant Sections with translations requires special permission from their copyright holders, but you may include translations of some or all Invariant Sections in addition to the original versions of these Invariant Sections. You may include a translation of this License, and all the license notices in the Document, and any Warranty Disclaimers, provided that you also include the original English version of this License and the original versions of those notices and disclaimers. In case of a disagreement between the translation and the original version of this License or a notice or disclaimer, the original version will prevail.

    If a section in the Document is Entitled “Acknowledgements”, “Dedications”, or “History”, the requirement (section 4) to Preserve its Title (section 1) will typically require changing the actual title.

  10. TERMINATION

    You may not copy, modify, sublicense, or distribute the Document except as expressly provided under this License. Any attempt otherwise to copy, modify, sublicense, or distribute it is void, and will automatically terminate your rights under this License.

    However, if you cease all violation of this License, then your license from a particular copyright holder is reinstated (a) provisionally, unless and until the copyright holder explicitly and finally terminates your license, and (b) permanently, if the copyright holder fails to notify you of the violation by some reasonable means prior to 60 days after the cessation.

    Moreover, your license from a particular copyright holder is reinstated permanently if the copyright holder notifies you of the violation by some reasonable means, this is the first time you have received notice of violation of this License (for any work) from that copyright holder, and you cure the violation prior to 30 days after your receipt of the notice.

    Termination of your rights under this section does not terminate the licenses of parties who have received copies or rights from you under this License. If your rights have been terminated and not permanently reinstated, receipt of a copy of some or all of the same material does not give you any rights to use it.

  11. FUTURE REVISIONS OF THIS LICENSE

    The Free Software Foundation may publish new, revised versions of the GNU Free Documentation License from time to time. Such new versions will be similar in spirit to the present version, but may differ in detail to address new problems or concerns. See https://www.gnu.org/licenses/.

    Each version of the License is given a distinguishing version number. If the Document specifies that a particular numbered version of this License “or any later version” applies to it, you have the option of following the terms and conditions either of that specified version or of any later version that has been published (not as a draft) by the Free Software Foundation. If the Document does not specify a version number of this License, you may choose any version ever published (not as a draft) by the Free Software Foundation. If the Document specifies that a proxy can decide which future versions of this License can be used, that proxy’s public statement of acceptance of a version permanently authorizes you to choose that version for the Document.

  12. RELICENSING

    “Massive Multiauthor Collaboration Site” (or “MMC Site”) means any World Wide Web server that publishes copyrightable works and also provides prominent facilities for anybody to edit those works. A public wiki that anybody can edit is an example of such a server. A “Massive Multiauthor Collaboration” (or “MMC”) contained in the site means any set of copyrightable works thus published on the MMC site.

    “CC-BY-SA” means the Creative Commons Attribution-Share Alike 3.0 license published by Creative Commons Corporation, a not-for-profit corporation with a principal place of business in San Francisco, California, as well as future copyleft versions of that license published by that same organization.

    “Incorporate” means to publish or republish a Document, in whole or in part, as part of another Document.

    An MMC is “eligible for relicensing” if it is licensed under this License, and if all works that were first published under this License somewhere other than this MMC, and subsequently incorporated in whole or in part into the MMC, (1) had no cover texts or invariant sections, and (2) were thus incorporated prior to November 1, 2008.

    The operator of an MMC Site may republish an MMC contained in the site under CC-BY-SA on the same site at any time before August 1, 2009, provided the MMC is eligible for relicensing.

ADDENDUM: How to use this License for your documents

To use this License in a document you have written, include a copy of the License in the document and put the following copyright and license notices just after the title page:

  Copyright (C)  year  your name.
  Permission is granted to copy, distribute and/or modify this document
  under the terms of the GNU Free Documentation License, Version 1.3
  or any later version published by the Free Software Foundation;
  with no Invariant Sections, no Front-Cover Texts, and no Back-Cover
  Texts.  A copy of the license is included in the section entitled ``GNU
  Free Documentation License''.

If you have Invariant Sections, Front-Cover Texts and Back-Cover Texts, replace the “with…Texts.” line with this:

    with the Invariant Sections being list their titles, with
    the Front-Cover Texts being list, and with the Back-Cover Texts
    being list.

If you have Invariant Sections without Cover Texts, or some other combination of the three, merge those two alternatives to suit the situation.

If your document contains nontrivial examples of program code, we recommend releasing these examples in parallel under your choice of free software license, such as the GNU General Public License, to permit their use in free software.


Next: , Previous: , Up: BList   [Contents][Index]

Appendix B Index

Jump to:   A   B   C   D   E   F   H   I   J   L   M   N   P   R   S   T  
Index Entry  Section

A
Always display column names: Header
annotations: Annotations
automatic filter groups: Example of automatic grouping
automatic filter groups, mechanism: Automatic filter groups
automatic filter groups, types: Automatic filter groups

B
blist: Usage
blist-automatic-filter-groups: Example of automatic grouping
blist-automatic-filter-groups: Example of combining the two groupings
blist-automatic-filter-groups: Automatic filter groups
blist-automatic-filter-groups-default: Automatic filter groups
blist-default-mark: Marking
blist-define-criterion: Example of manual grouping
blist-define-criterion: Fixed filter groups
blist-display-location-p: Columns
blist-elide-string: Columns
blist-elisp-p: Example of combining the two groupings
blist-eshell-p: Example of combining the two groupings
blist-filter-default-label: Fixed filter groups
blist-filter-default-label: Combine fixed and automatic filter groups
blist-filter-features: Example of manual grouping
blist-filter-features: Example of automatic grouping
blist-filter-features: Example of combining the two groupings
blist-filter-features: Combine fixed and automatic filter groups
blist-filter-groups: Example of manual grouping
blist-filter-groups: Example of combining the two groupings
blist-filter-groups: Fixed filter groups
blist-filter-groups: Fixed filter groups
blist-filter-groups: Combine fixed and automatic filter groups
blist-info-p: Example of combining the two groupings
blist-list-bookmarks: Usage
blist-maximal-name-len: Columns
blist-movement-cycle: Navigations
blist-name-column: Columns
blist-pdf-p: Example of combining the two groupings
blist-select-manner: Jump to bookmarks
blist-toggle-location: Columns
blist-use-header-p: Example of manual grouping
blist-use-header-p: Header

C
calling conventions: Calling convention(s)
column function: Columns
columns: Columns
combined filter groups: Example of combining the two groupings
command: Navigations
config: Example configuration
custom automatic filter groups: Automatic filter groups

D
decorations: Annotations
default automatic groups: Two default automatic groups
display locations, toggle: Columns

E
Emacs 29: Default group
Emacs 29: Type-only group
engine: Dependency
example: Example configuration

F
filter groups: Groups
filter groups, combine: Combine fixed and automatic filter groups
fixed filter groups: Example of manual grouping
fixed filter groups, default: Fixed filter groups
fixed filter groups, format: Fixed filter groups
fixed filter groups, order: Fixed filter groups
flexibility: Fixed filter groups

H
How to use: Usage

I
ilist: Dependency
ilist-automatic-group-blist-default: Example of automatic grouping
ilist-automatic-group-blist-default: Example of combining the two groupings
ilist-automatic-group-blist-type-only: Example of automatic grouping
ilist-automatic-group-blist-type-only: Example of combining the two groupings
ilist-dag: Automatic filter groups
ilist-define-automatic-group: Automatic filter groups

J
jumping: Jump to bookmarks

L
load: Others
locations: Columns

M
marks: Marking
miscellaneous: Others
motivation: About
move, moving: Navigations

N
navigations: Navigations

P
picture: Screenshot

R
relocate: Others
rename: Others

S
sections: Groups

T
toggle: Marking
toggle: Others

Jump to:   A   B   C   D   E   F   H   I   J   L   M   N   P   R   S   T  

Previous: , Up: BList   [Contents][Index]

Appendix C Key Index

The list of keys.

Jump to:   %   (   )   *  
A   C   D   E   J   K   L   M   N   O   P   R   S   T   U   V   X  
Index Entry  Section

%
% l: Marking
% n: Marking

(
(: Navigations

)
): Navigations

*
* *: Marking
* c: Marking

A
a: Annotations
A: Annotations

C
C-d: Marking

D
d: Marking
D: Marking
DEL: Marking

E
e: Annotations

J
j: Navigations
J: Navigations

K
k: Marking

L
l: Others

M
m: Marking
M-DEL: Marking
M-g: Navigations
M-G: Navigations
M-j: Navigations
M-n: Navigations
M-p: Navigations
M-{: Navigations
M-}: Navigations

N
n: Navigations
N: Navigations

O
o: Jump to bookmarks

P
p: Navigations
P: Navigations

R
R: Others
r: Others
RET: Jump to bookmarks

S
S-RET: Others

T
t: Marking

U
u: Marking
U: Marking

V
v: Jump to bookmarks
v: Jump to bookmarks

X
x: Marking

Jump to:   %   (   )   *  
A   C   D   E   J   K   L   M   N   O   P   R   S   T   U   V   X