License under GPL-3.0-or-later

Add LICENSE, ship it in release archives, and declare the licence in
the nfpm packages and Homebrew formula.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>

CHANGELOG.md

@@ -1,11 +1,18 @@
 # Changelog
 
-## Unreleased
+## 1.0.0 — 2026-10-02
+
+First stable release. The snapshot format (version 1) is now stable: later
+1.x releases will keep reading version 1 snapshots.
+
+### Engine
 - Bounded concurrent scanner with incremental aggregation, cancellation,
   hard-link and symlink-loop handling, error accounting.
 - Non-interactive reports: `--top`, `--largest-files`, `--json`, `--csv`,
   `--duplicates`, `--no-ui`.
 - Versioned, checksummed snapshot format; `--compare`.
+
+### Interface
 - Interactive TUI (Bubble Tea v2): live squarified treemap with nested
   previews and level-of-detail grouping, spatial arrow navigation, zoom,
   breadcrumbs, responsive layouts, info/help/confirm/save modals, mouse.
@@ -16,3 +23,22 @@
   perceptual 256-colour quantizer, NO_COLOR support.
 - Move to trash (freedesktop / macOS / Windows), `--read-only`.
 - `treegen` synthetic tree generator; benchmarks in PERFORMANCE.md.
+
+### Packaging and documentation
+- `mapsize(1)` manual page; `make install` installs binary and man page.
+- `make release`: archives for Linux, macOS, Windows and the BSDs, plus
+  .deb, .rpm, .apk and Arch packages (with the man page) and SHA256SUMS.
+- Version stamped into release builds.
+- Homebrew formula template and `make brew-formula`.
+
+### Hardening
+- Snapshot loader rejects over-deep trees, decompression bombs and
+  out-of-range sizes; aggregates saturate instead of overflowing.
+- Exclusion patterns from snapshot metadata are sanitised in reports.
+- Duplicate, trash and filter results belonging to a replaced tree (after
+  a rescan) are discarded.
+- Linux trash refuses symlinked or foreign trash directories on shared
+  filesystems and never overwrites an earlier trashed item.
+- Symlinks are not followed on platforms without inode identity; the
+  unscanned-directory count and post-cancel errors are reported correctly.
+- Path filters evaluate incrementally (2× faster on 1M entries).

DEVELOPMENT.md

@@ -12,6 +12,36 @@ make fuzz       # short fuzz runs of snapshot / treemap / filter
 make release    # cross-compiled binaries in bin/release
 ```
 
+## Releasing
+
+```sh
+git tag -a v1.0.0 -m "mapsize 1.0.0"
+make release          # bin/release: archives, .deb/.rpm/.apk/Arch, SHA256SUMS
+```
+
+The version comes from `git describe` and is stamped into
+`brand.Version`; untagged builds report the fallback in
+`internal/brand/brand.go`. Packages need network access the first time
+(`nfpm` is fetched with `go run`). Bump the version in `docs/mapsize.1` and
+`brand.go` and add a CHANGELOG section before tagging.
+
+### Homebrew
+
+After pushing the tag:
+
+```sh
+make brew-formula     # → bin/homebrew/mapsize.rb with the tarball's sha256
+```
+
+Copy the result to `Formula/mapsize.rb` in the tap repository
+`github.com/andydixon/homebrew-tap`; users then run
+`brew install andydixon/tap/mapsize`. The formula builds from source with
+Go, stamps the version and installs the man page. Template:
+`packaging/homebrew/mapsize.rb.in`.
+
+The snapshot format is stable at version 1: a format change must bump
+`snapshot.Version` and keep the reader for version 1.
+
 ## Test data
 
 `treegen` creates synthetic trees:

LICENSE

@@ -0,0 +1,675 @@
+                    GNU GENERAL PUBLIC LICENSE
+                       Version 3, 29 June 2007
+
+ Copyright (C) 2007 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.
+
+                            Preamble
+
+  The GNU General Public License is a free, copyleft license for
+software and other kinds of works.
+
+  The licenses for most software and other practical works are designed
+to take away your freedom to share and change the works.  By contrast,
+the GNU General Public License is intended to guarantee your freedom to
+share and change all versions of a program--to make sure it remains free
+software for all its users.  We, the Free Software Foundation, use the
+GNU General Public License for most of our software; it applies also to
+any other work released this way by its authors.  You can apply it to
+your programs, too.
+
+  When we speak of free software, we are referring to freedom, not
+price.  Our General Public Licenses are designed to make sure that you
+have the freedom to distribute copies of free software (and charge for
+them if you wish), that you receive source code or can get it if you
+want it, that you can change the software or use pieces of it in new
+free programs, and that you know you can do these things.
+
+  To protect your rights, we need to prevent others from denying you
+these rights or asking you to surrender the rights.  Therefore, you have
+certain responsibilities if you distribute copies of the software, or if
+you modify it: responsibilities to respect the freedom of others.
+
+  For example, if you distribute copies of such a program, whether
+gratis or for a fee, you must pass on to the recipients the same
+freedoms that you received.  You must make sure that they, too, receive
+or can get the source code.  And you must show them these terms so they
+know their rights.
+
+  Developers that use the GNU GPL protect your rights with two steps:
+(1) assert copyright on the software, and (2) offer you this License
+giving you legal permission to copy, distribute and/or modify it.
+
+  For the developers' and authors' protection, the GPL clearly explains
+that there is no warranty for this free software.  For both users' and
+authors' sake, the GPL requires that modified versions be marked as
+changed, so that their problems will not be attributed erroneously to
+authors of previous versions.
+
+  Some devices are designed to deny users access to install or run
+modified versions of the software inside them, although the manufacturer
+can do so.  This is fundamentally incompatible with the aim of
+protecting users' freedom to change the software.  The systematic
+pattern of such abuse occurs in the area of products for individuals to
+use, which is precisely where it is most unacceptable.  Therefore, we
+have designed this version of the GPL to prohibit the practice for those
+products.  If such problems arise substantially in other domains, we
+stand ready to extend this provision to those domains in future versions
+of the GPL, as needed to protect the freedom of users.
+
+  Finally, every program is threatened constantly by software patents.
+States should not allow patents to restrict development and use of
+software on general-purpose computers, but in those that do, we wish to
+avoid the special danger that patents applied to a free program could
+make it effectively proprietary.  To prevent this, the GPL assures that
+patents cannot be used to render the program non-free.
+
+  The precise terms and conditions for copying, distribution and
+modification follow.
+
+                       TERMS AND CONDITIONS
+
+  0. Definitions.
+
+  "This License" refers to version 3 of the GNU General Public License.
+
+  "Copyright" also means copyright-like laws that apply to other kinds of
+works, such as semiconductor masks.
+
+  "The Program" refers to any copyrightable work licensed under this
+License.  Each licensee is addressed as "you".  "Licensees" and
+"recipients" may be individuals or organizations.
+
+  To "modify" a work means to copy from or adapt all or part of the work
+in a fashion requiring copyright permission, other than the making of an
+exact copy.  The resulting work is called a "modified version" of the
+earlier work or a work "based on" the earlier work.
+
+  A "covered work" means either the unmodified Program or a work based
+on the Program.
+
+  To "propagate" a work means to do anything with it that, without
+permission, would make you directly or secondarily liable for
+infringement under applicable copyright law, except executing it on a
+computer or modifying a private copy.  Propagation includes copying,
+distribution (with or without modification), making available to the
+public, and in some countries other activities as well.
+
+  To "convey" a work means any kind of propagation that enables other
+parties to make or receive copies.  Mere interaction with a user through
+a computer network, with no transfer of a copy, is not conveying.
+
+  An interactive user interface displays "Appropriate Legal Notices"
+to the extent that it includes a convenient and prominently visible
+feature that (1) displays an appropriate copyright notice, and (2)
+tells the user that there is no warranty for the work (except to the
+extent that warranties are provided), that licensees may convey the
+work under this License, and how to view a copy of this License.  If
+the interface presents a list of user commands or options, such as a
+menu, a prominent item in the list meets this criterion.
+
+  1. Source Code.
+
+  The "source code" for a work means the preferred form of the work
+for making modifications to it.  "Object code" means any non-source
+form of a work.
+
+  A "Standard Interface" means an interface that either is an official
+standard defined by a recognized standards body, or, in the case of
+interfaces specified for a particular programming language, one that
+is widely used among developers working in that language.
+
+  The "System Libraries" of an executable work include anything, other
+than the work as a whole, that (a) is included in the normal form of
+packaging a Major Component, but which is not part of that Major
+Component, and (b) serves only to enable use of the work with that
+Major Component, or to implement a Standard Interface for which an
+implementation is available to the public in source code form.  A
+"Major Component", in this context, means a major essential component
+(kernel, window system, and so on) of the specific operating system
+(if any) on which the executable work runs, or a compiler used to
+produce the work, or an object code interpreter used to run it.
+
+  The "Corresponding Source" for a work in object code form means all
+the source code needed to generate, install, and (for an executable
+work) run the object code and to modify the work, including scripts to
+control those activities.  However, it does not include the work's
+System Libraries, or general-purpose tools or generally available free
+programs which are used unmodified in performing those activities but
+which are not part of the work.  For example, Corresponding Source
+includes interface definition files associated with source files for
+the work, and the source code for shared libraries and dynamically
+linked subprograms that the work is specifically designed to require,
+such as by intimate data communication or control flow between those
+subprograms and other parts of the work.
+
+  The Corresponding Source need not include anything that users
+can regenerate automatically from other parts of the Corresponding
+Source.
+
+  The Corresponding Source for a work in source code form is that
+same work.
+
+  2. Basic Permissions.
+
+  All rights granted under this License are granted for the term of
+copyright on the Program, and are irrevocable provided the stated
+conditions are met.  This License explicitly affirms your unlimited
+permission to run the unmodified Program.  The output from running a
+covered work is covered by this License only if the output, given its
+content, constitutes a covered work.  This License acknowledges your
+rights of fair use or other equivalent, as provided by copyright law.
+
+  You may make, run and propagate covered works that you do not
+convey, without conditions so long as your license otherwise remains
+in force.  You may convey covered works to others for the sole purpose
+of having them make modifications exclusively for you, or provide you
+with facilities for running those works, provided that you comply with
+the terms of this License in conveying all material for which you do
+not control copyright.  Those thus making or running the covered works
+for you must do so exclusively on your behalf, under your direction
+and control, on terms that prohibit them from making any copies of
+your copyrighted material outside their relationship with you.
+
+  Conveying under any other circumstances is permitted solely under
+the conditions stated below.  Sublicensing is not allowed; section 10
+makes it unnecessary.
+
+  3. Protecting Users' Legal Rights From Anti-Circumvention Law.
+
+  No covered work shall be deemed part of an effective technological
+measure under any applicable law fulfilling obligations under article
+11 of the WIPO copyright treaty adopted on 20 December 1996, or
+similar laws prohibiting or restricting circumvention of such
+measures.
+
+  When you convey a covered work, you waive any legal power to forbid
+circumvention of technological measures to the extent such circumvention
+is effected by exercising rights under this License with respect to
+the covered work, and you disclaim any intention to limit operation or
+modification of the work as a means of enforcing, against the work's
+users, your or third parties' legal rights to forbid circumvention of
+technological measures.
+
+  4. Conveying Verbatim Copies.
+
+  You may convey verbatim copies of the Program's source code as you
+receive it, in any medium, provided that you conspicuously and
+appropriately publish on each copy an appropriate copyright notice;
+keep intact all notices stating that this License and any
+non-permissive terms added in accord with section 7 apply to the code;
+keep intact all notices of the absence of any warranty; and give all
+recipients a copy of this License along with the Program.
+
+  You may charge any price or no price for each copy that you convey,
+and you may offer support or warranty protection for a fee.
+
+  5. Conveying Modified Source Versions.
+
+  You may convey a work based on the Program, or the modifications to
+produce it from the Program, in the form of source code under the
+terms of section 4, provided that you also meet all of these conditions:
+
+    a) The work must carry prominent notices stating that you modified
+    it, and giving a relevant date.
+
+    b) The work must carry prominent notices stating that it is
+    released under this License and any conditions added under section
+    7.  This requirement modifies the requirement in section 4 to
+    "keep intact all notices".
+
+    c) You must license the entire work, as a whole, under this
+    License to anyone who comes into possession of a copy.  This
+    License will therefore apply, along with any applicable section 7
+    additional terms, to the whole of the work, and all its parts,
+    regardless of how they are packaged.  This License gives no
+    permission to license the work in any other way, but it does not
+    invalidate such permission if you have separately received it.
+
+    d) If the work has interactive user interfaces, each must display
+    Appropriate Legal Notices; however, if the Program has interactive
+    interfaces that do not display Appropriate Legal Notices, your
+    work need not make them do so.
+
+  A compilation of a covered work with other separate and independent
+works, which are not by their nature extensions of the covered work,
+and which are not combined with it such as to form a larger program,
+in or on a volume of a storage or distribution medium, is called an
+"aggregate" if the compilation and its resulting copyright are not
+used to limit the access or legal rights of the compilation's users
+beyond what the individual works permit.  Inclusion of a covered work
+in an aggregate does not cause this License to apply to the other
+parts of the aggregate.
+
+  6. Conveying Non-Source Forms.
+
+  You may convey a covered work in object code form under the terms
+of sections 4 and 5, provided that you also convey the
+machine-readable Corresponding Source under the terms of this License,
+in one of these ways:
+
+    a) Convey the object code in, or embodied in, a physical product
+    (including a physical distribution medium), accompanied by the
+    Corresponding Source fixed on a durable physical medium
+    customarily used for software interchange.
+
+    b) Convey the object code in, or embodied in, a physical product
+    (including a physical distribution medium), accompanied by a
+    written offer, valid for at least three years and valid for as
+    long as you offer spare parts or customer support for that product
+    model, to give anyone who possesses the object code either (1) a
+    copy of the Corresponding Source for all the software in the
+    product that is covered by this License, on a durable physical
+    medium customarily used for software interchange, for a price no
+    more than your reasonable cost of physically performing this
+    conveying of source, or (2) access to copy the
+    Corresponding Source from a network server at no charge.
+
+    c) Convey individual copies of the object code with a copy of the
+    written offer to provide the Corresponding Source.  This
+    alternative is allowed only occasionally and noncommercially, and
+    only if you received the object code with such an offer, in accord
+    with subsection 6b.
+
+    d) Convey the object code by offering access from a designated
+    place (gratis or for a charge), and offer equivalent access to the
+    Corresponding Source in the same way through the same place at no
+    further charge.  You need not require recipients to copy the
+    Corresponding Source along with the object code.  If the place to
+    copy the object code is a network server, the Corresponding Source
+    may be on a different server (operated by you or a third party)
+    that supports equivalent copying facilities, provided you maintain
+    clear directions next to the object code saying where to find the
+    Corresponding Source.  Regardless of what server hosts the
+    Corresponding Source, you remain obligated to ensure that it is
+    available for as long as needed to satisfy these requirements.
+
+    e) Convey the object code using peer-to-peer transmission, provided
+    you inform other peers where the object code and Corresponding
+    Source of the work are being offered to the general public at no
+    charge under subsection 6d.
+
+  A separable portion of the object code, whose source code is excluded
+from the Corresponding Source as a System Library, need not be
+included in conveying the object code work.
+
+  A "User Product" is either (1) a "consumer product", which means any
+tangible personal property which is normally used for personal, family,
+or household purposes, or (2) anything designed or sold for incorporation
+into a dwelling.  In determining whether a product is a consumer product,
+doubtful cases shall be resolved in favor of coverage.  For a particular
+product received by a particular user, "normally used" refers to a
+typical or common use of that class of product, regardless of the status
+of the particular user or of the way in which the particular user
+actually uses, or expects or is expected to use, the product.  A product
+is a consumer product regardless of whether the product has substantial
+commercial, industrial or non-consumer uses, unless such uses represent
+the only significant mode of use of the product.
+
+  "Installation Information" for a User Product means any methods,
+procedures, authorization keys, or other information required to install
+and execute modified versions of a covered work in that User Product from
+a modified version of its Corresponding Source.  The information must
+suffice to ensure that the continued functioning of the modified object
+code is in no case prevented or interfered with solely because
+modification has been made.
+
+  If you convey an object code work under this section in, or with, or
+specifically for use in, a User Product, and the conveying occurs as
+part of a transaction in which the right of possession and use of the
+User Product is transferred to the recipient in perpetuity or for a
+fixed term (regardless of how the transaction is characterized), the
+Corresponding Source conveyed under this section must be accompanied
+by the Installation Information.  But this requirement does not apply
+if neither you nor any third party retains the ability to install
+modified object code on the User Product (for example, the work has
+been installed in ROM).
+
+  The requirement to provide Installation Information does not include a
+requirement to continue to provide support service, warranty, or updates
+for a work that has been modified or installed by the recipient, or for
+the User Product in which it has been modified or installed.  Access to a
+network may be denied when the modification itself materially and
+adversely affects the operation of the network or violates the rules and
+protocols for communication across the network.
+
+  Corresponding Source conveyed, and Installation Information provided,
+in accord with this section must be in a format that is publicly
+documented (and with an implementation available to the public in
+source code form), and must require no special password or key for
+unpacking, reading or copying.
+
+  7. Additional Terms.
+
+  "Additional permissions" are terms that supplement the terms of this
+License by making exceptions from one or more of its conditions.
+Additional permissions that are applicable to the entire Program shall
+be treated as though they were included in this License, to the extent
+that they are valid under applicable law.  If additional permissions
+apply only to part of the Program, that part may be used separately
+under those permissions, but the entire Program remains governed by
+this License without regard to the additional permissions.
+
+  When you convey a copy of a covered work, you may at your option
+remove any additional permissions from that copy, or from any part of
+it.  (Additional permissions may be written to require their own
+removal in certain cases when you modify the work.)  You may place
+additional permissions on material, added by you to a covered work,
+for which you have or can give appropriate copyright permission.
+
+  Notwithstanding any other provision of this License, for material you
+add to a covered work, you may (if authorized by the copyright holders of
+that material) supplement the terms of this License with terms:
+
+    a) Disclaiming warranty or limiting liability differently from the
+    terms of sections 15 and 16 of this License; or
+
+    b) Requiring preservation of specified reasonable legal notices or
+    author attributions in that material or in the Appropriate Legal
+    Notices displayed by works containing it; or
+
+    c) Prohibiting misrepresentation of the origin of that material, or
+    requiring that modified versions of such material be marked in
+    reasonable ways as different from the original version; or
+
+    d) Limiting the use for publicity purposes of names of licensors or
+    authors of the material; or
+
+    e) Declining to grant rights under trademark law for use of some
+    trade names, trademarks, or service marks; or
+
+    f) Requiring indemnification of licensors and authors of that
+    material by anyone who conveys the material (or modified versions of
+    it) with contractual assumptions of liability to the recipient, for
+    any liability that these contractual assumptions directly impose on
+    those licensors and authors.
+
+  All other non-permissive additional terms are considered "further
+restrictions" within the meaning of section 10.  If the Program as you
+received it, or any part of it, contains a notice stating that it is
+governed by this License along with a term that is a further
+restriction, you may remove that term.  If a license document contains
+a further restriction but permits relicensing or conveying under this
+License, you may add to a covered work material governed by the terms
+of that license document, provided that the further restriction does
+not survive such relicensing or conveying.
+
+  If you add terms to a covered work in accord with this section, you
+must place, in the relevant source files, a statement of the
+additional terms that apply to those files, or a notice indicating
+where to find the applicable terms.
+
+  Additional terms, permissive or non-permissive, may be stated in the
+form of a separately written license, or stated as exceptions;
+the above requirements apply either way.
+
+  8. Termination.
+
+  You may not propagate or modify a covered work except as expressly
+provided under this License.  Any attempt otherwise to propagate or
+modify it is void, and will automatically terminate your rights under
+this License (including any patent licenses granted under the third
+paragraph of section 11).
+
+  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, you do not qualify to receive new licenses for the same
+material under section 10.
+
+  9. Acceptance Not Required for Having Copies.
+
+  You are not required to accept this License in order to receive or
+run a copy of the Program.  Ancillary propagation of a covered work
+occurring solely as a consequence of using peer-to-peer transmission
+to receive a copy likewise does not require acceptance.  However,
+nothing other than this License grants you permission to propagate or
+modify any covered work.  These actions infringe copyright if you do
+not accept this License.  Therefore, by modifying or propagating a
+covered work, you indicate your acceptance of this License to do so.
+
+  10. Automatic Licensing of Downstream Recipients.
+
+  Each time you convey a covered work, the recipient automatically
+receives a license from the original licensors, to run, modify and
+propagate that work, subject to this License.  You are not responsible
+for enforcing compliance by third parties with this License.
+
+  An "entity transaction" is a transaction transferring control of an
+organization, or substantially all assets of one, or subdividing an
+organization, or merging organizations.  If propagation of a covered
+work results from an entity transaction, each party to that
+transaction who receives a copy of the work also receives whatever
+licenses to the work the party's predecessor in interest had or could
+give under the previous paragraph, plus a right to possession of the
+Corresponding Source of the work from the predecessor in interest, if
+the predecessor has it or can get it with reasonable efforts.
+
+  You may not impose any further restrictions on the exercise of the
+rights granted or affirmed under this License.  For example, you may
+not impose a license fee, royalty, or other charge for exercise of
+rights granted under this License, and you may not initiate litigation
+(including a cross-claim or counterclaim in a lawsuit) alleging that
+any patent claim is infringed by making, using, selling, offering for
+sale, or importing the Program or any portion of it.
+
+  11. Patents.
+
+  A "contributor" is a copyright holder who authorizes use under this
+License of the Program or a work on which the Program is based.  The
+work thus licensed is called the contributor's "contributor version".
+
+  A contributor's "essential patent claims" are all patent claims
+owned or controlled by the contributor, whether already acquired or
+hereafter acquired, that would be infringed by some manner, permitted
+by this License, of making, using, or selling its contributor version,
+but do not include claims that would be infringed only as a
+consequence of further modification of the contributor version.  For
+purposes of this definition, "control" includes the right to grant
+patent sublicenses in a manner consistent with the requirements of
+this License.
+
+  Each contributor grants you a non-exclusive, worldwide, royalty-free
+patent license under the contributor's essential patent claims, to
+make, use, sell, offer for sale, import and otherwise run, modify and
+propagate the contents of its contributor version.
+
+  In the following three paragraphs, a "patent license" is any express
+agreement or commitment, however denominated, not to enforce a patent
+(such as an express permission to practice a patent or covenant not to
+sue for patent infringement).  To "grant" such a patent license to a
+party means to make such an agreement or commitment not to enforce a
+patent against the party.
+
+  If you convey a covered work, knowingly relying on a patent license,
+and the Corresponding Source of the work is not available for anyone
+to copy, free of charge and under the terms of this License, through a
+publicly available network server or other readily accessible means,
+then you must either (1) cause the Corresponding Source to be so
+available, or (2) arrange to deprive yourself of the benefit of the
+patent license for this particular work, or (3) arrange, in a manner
+consistent with the requirements of this License, to extend the patent
+license to downstream recipients.  "Knowingly relying" means you have
+actual knowledge that, but for the patent license, your conveying the
+covered work in a country, or your recipient's use of the covered work
+in a country, would infringe one or more identifiable patents in that
+country that you have reason to believe are valid.
+
+  If, pursuant to or in connection with a single transaction or
+arrangement, you convey, or propagate by procuring conveyance of, a
+covered work, and grant a patent license to some of the parties
+receiving the covered work authorizing them to use, propagate, modify
+or convey a specific copy of the covered work, then the patent license
+you grant is automatically extended to all recipients of the covered
+work and works based on it.
+
+  A patent license is "discriminatory" if it does not include within
+the scope of its coverage, prohibits the exercise of, or is
+conditioned on the non-exercise of one or more of the rights that are
+specifically granted under this License.  You may not convey a covered
+work if you are a party to an arrangement with a third party that is
+in the business of distributing software, under which you make payment
+to the third party based on the extent of your activity of conveying
+the work, and under which the third party grants, to any of the
+parties who would receive the covered work from you, a discriminatory
+patent license (a) in connection with copies of the covered work
+conveyed by you (or copies made from those copies), or (b) primarily
+for and in connection with specific products or compilations that
+contain the covered work, unless you entered into that arrangement,
+or that patent license was granted, prior to 28 March 2007.
+
+  Nothing in this License shall be construed as excluding or limiting
+any implied license or other defenses to infringement that may
+otherwise be available to you under applicable patent law.
+
+  12. No Surrender of Others' Freedom.
+
+  If conditions are imposed on you (whether by court order, agreement or
+otherwise) that contradict the conditions of this License, they do not
+excuse you from the conditions of this License.  If you cannot convey a
+covered work so as to satisfy simultaneously your obligations under this
+License and any other pertinent obligations, then as a consequence you may
+not convey it at all.  For example, if you agree to terms that obligate you
+to collect a royalty for further conveying from those to whom you convey
+the Program, the only way you could satisfy both those terms and this
+License would be to refrain entirely from conveying the Program.
+
+  13. Use with the GNU Affero General Public License.
+
+  Notwithstanding any other provision of this License, you have
+permission to link or combine any covered work with a work licensed
+under version 3 of the GNU Affero General Public License into a single
+combined work, and to convey the resulting work.  The terms of this
+License will continue to apply to the part which is the covered work,
+but the special requirements of the GNU Affero General Public License,
+section 13, concerning interaction through a network will apply to the
+combination as such.
+
+  14. Revised Versions of this License.
+
+  The Free Software Foundation may publish revised and/or new versions of
+the GNU General Public 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.
+
+  Each version is given a distinguishing version number.  If the
+Program specifies that a certain numbered version of the GNU General
+Public License "or any later version" applies to it, you have the
+option of following the terms and conditions either of that numbered
+version or of any later version published by the Free Software
+Foundation.  If the Program does not specify a version number of the
+GNU General Public License, you may choose any version ever published
+by the Free Software Foundation.
+
+  If the Program specifies that a proxy can decide which future
+versions of the GNU General Public License can be used, that proxy's
+public statement of acceptance of a version permanently authorizes you
+to choose that version for the Program.
+
+  Later license versions may give you additional or different
+permissions.  However, no additional obligations are imposed on any
+author or copyright holder as a result of your choosing to follow a
+later version.
+
+  15. Disclaimer of Warranty.
+
+  THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
+APPLICABLE LAW.  EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
+HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
+OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
+THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+PURPOSE.  THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
+IS WITH YOU.  SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
+ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
+
+  16. Limitation of Liability.
+
+  IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
+WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
+THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
+GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
+USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
+DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
+PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
+EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
+SUCH DAMAGES.
+
+  17. Interpretation of Sections 15 and 16.
+
+  If the disclaimer of warranty and limitation of liability provided
+above cannot be given local legal effect according to their terms,
+reviewing courts shall apply local law that most closely approximates
+an absolute waiver of all civil liability in connection with the
+Program, unless a warranty or assumption of liability accompanies a
+copy of the Program in return for a fee.
+
+                     END OF TERMS AND CONDITIONS
+
+            How to Apply These Terms to Your New Programs
+
+  If you develop a new program, and you want it to be of the greatest
+possible use to the public, the best way to achieve this is to make it
+free software which everyone can redistribute and change under these terms.
+
+  To do so, attach the following notices to the program.  It is safest
+to attach them to the start of each source file to most effectively
+state the exclusion of warranty; and each file should have at least
+the "copyright" line and a pointer to where the full notice is found.
+
+    <one line to give the program's name and a brief idea of what it does.>
+    Copyright (C) <year>  <name of author>
+
+    This program is free software: you can redistribute it and/or modify
+    it under the terms of the GNU General Public License as published by
+    the Free Software Foundation, either version 3 of the License, or
+    (at your option) any later version.
+
+    This program is distributed in the hope that it will be useful,
+    but WITHOUT ANY WARRANTY; without even the implied warranty of
+    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+    GNU General Public License for more details.
+
+    You should have received a copy of the GNU General Public License
+    along with this program.  If not, see <https://www.gnu.org/licenses/>.
+
+Also add information on how to contact you by electronic and paper mail.
+
+  If the program does terminal interaction, make it output a short
+notice like this when it starts in an interactive mode:
+
+    <program>  Copyright (C) <year>  <name of author>
+    This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
+    This is free software, and you are welcome to redistribute it
+    under certain conditions; type `show c' for details.
+
+The hypothetical commands `show w' and `show c' should show the appropriate
+parts of the General Public License.  Of course, your program's commands
+might be different; for a GUI interface, you would use an "about box".
+
+  You should also get your employer (if you work as a programmer) or school,
+if any, to sign a "copyright disclaimer" for the program, if necessary.
+For more information on this, and how to apply and follow the GNU GPL, see
+<https://www.gnu.org/licenses/>.
+
+  The GNU General Public License does not permit incorporating your program
+into proprietary programs.  If your program is a subroutine library, you
+may consider it more useful to permit linking proprietary applications with
+the library.  If this is what you want to do, use the GNU Lesser General
+Public License instead of this License.  But first, please read
+<https://www.gnu.org/licenses/why-not-lgpl.html>.
+

Makefile

@@ -2,13 +2,21 @@ BIN     := bin
 PKG     := ./...
 VERSION ?= $(shell git describe --tags --always --dirty 2>/dev/null || echo dev)
 LDFLAGS := -s -w
+PREFIX  ?= /usr/local
 
-.PHONY: build test race vet fmt fmt-check benchmark fuzz release clean treegen
+.PHONY: build install man brew-formula test race vet fmt fmt-check benchmark fuzz release clean treegen
 
 build:
 	go build -trimpath -ldflags '$(LDFLAGS)' -o $(BIN)/mapsize ./cmd/mapsize
 	go build -trimpath -ldflags '$(LDFLAGS)' -o $(BIN)/treegen ./cmd/treegen
 
+install: build
+	install -Dm755 $(BIN)/mapsize $(DESTDIR)$(PREFIX)/bin/mapsize
+	install -Dm644 docs/mapsize.1 $(DESTDIR)$(PREFIX)/share/man/man1/mapsize.1
+
+man:
+	man -l docs/mapsize.1
+
 test:
 	go test $(PKG)
 
@@ -32,13 +40,41 @@ fuzz:
 	go test -run=NONE -fuzz=FuzzSquarify -fuzztime=30s ./internal/treemap
 	go test -run=NONE -fuzz=FuzzParse -fuzztime=30s ./internal/filter
 
+# Cross-built archives plus .deb/.rpm/.apk/Arch packages in $(BIN)/release.
+REL     := $(BIN)/release
+NFPM    := go run github.com/goreleaser/nfpm/v2/cmd/nfpm@v2.41.1
 release:
-	@for t in linux/amd64 linux/arm64 darwin/amd64 darwin/arm64 windows/amd64 windows/arm64; do \
+	rm -rf $(REL) && mkdir -p $(REL)
+	@set -e; v=$(VERSION); v=$${v#v}; \
+	for t in linux/amd64 linux/arm64 linux/386 linux/arm darwin/amd64 darwin/arm64 \
+	         windows/amd64 windows/arm64 freebsd/amd64 freebsd/arm64 openbsd/amd64 netbsd/amd64; do \
 		os=$${t%/*}; arch=$${t#*/}; ext=; [ $$os = windows ] && ext=.exe; \
-		echo "$$os/$$arch"; \
+		name=mapsize-$$v-$$os-$$arch; d=$(REL)/$$name; echo "$$os/$$arch"; mkdir -p $$d; \
-		CGO_ENABLED=0 GOOS=$$os GOARCH=$$arch go build -trimpath -ldflags '$(LDFLAGS)' \
+		CGO_ENABLED=0 GOOS=$$os GOARCH=$$arch GOARM=7 go build -trimpath \
-			-o $(BIN)/release/mapsize-$(VERSION)-$$os-$$arch$$ext ./cmd/mapsize || exit 1; \
+			-ldflags '$(LDFLAGS) -X github.com/andydixon/mapsize/internal/brand.Version='$$v \
-	done
+			-o $$d/mapsize$$ext ./cmd/mapsize; \
+		cp README.md CHANGELOG.md LICENSE docs/mapsize.1 $$d/; \
+		if [ $$os = windows ]; then (cd $(REL) && zip -qr $$name.zip $$name); \
+		else tar -C $(REL) -czf $(REL)/$$name.tar.gz $$name; fi; \
+		if [ $$os = linux ]; then mkdir -p $(REL)/pkg && cp $$d/mapsize $(REL)/pkg/; \
+			a=$$arch; [ $$a = arm ] && a=arm7; \
+			for f in deb rpm apk archlinux; do \
+			VERSION=$$v ARCH=$$a $(NFPM) pkg -f nfpm.yaml -p $$f -t $(REL)/; done; rm -rf $(REL)/pkg; fi; \
+		rm -rf $$d; \
+	done; \
+	cd $(REL) && sha256sum * > SHA256SUMS
+
+# Homebrew formula for the tagged release. The tag must already be pushed:
+# the checksum is of GitHub's source tarball for that tag.
+BREW_REPO := https://github.com/andydixon/mapsize
+brew-formula:
+	@set -e; v=$(VERSION); v=$${v#v}; \
+	case $$v in *-*) echo "brew-formula: HEAD is not exactly a release tag ($$v)"; exit 1;; esac; \
+	url=$(BREW_REPO)/archive/refs/tags/v$$v.tar.gz; \
+	sum=$$(curl -fsSL "$$url" | sha256sum | cut -d' ' -f1) || { echo "cannot fetch $$url (tag pushed?)"; exit 1; }; \
+	mkdir -p $(BIN)/homebrew; \
+	sed -e "s/@VERSION@/$$v/g" -e "s/@SHA256@/$$sum/" packaging/homebrew/mapsize.rb.in > $(BIN)/homebrew/mapsize.rb; \
+	echo "wrote $(BIN)/homebrew/mapsize.rb (v$$v, sha256 $$sum)"
 
 clean:
 	rm -rf $(BIN)

README.md

@@ -8,9 +8,10 @@ runs over SSH.
 
 ## Status
 
-Milestones 0.1–0.8 are implemented; 0.9 (hardening) is in progress. See
+Version 1.0. See [CHANGELOG.md](CHANGELOG.md), [ROADMAP.md](ROADMAP.md) for
-[ROADMAP.md](ROADMAP.md) for detail and [PERFORMANCE.md](PERFORMANCE.md) for
+what comes next, and [PERFORMANCE.md](PERFORMANCE.md) for measured numbers.
-measured numbers.
+Tested on Linux; macOS and Windows builds are produced but trash and
+file-manager integration have not yet been tested there.
 
 ## What it does
 
@@ -69,11 +70,18 @@ the map or scrolls lists. Everything works without a mouse (`--no-mouse`).
 ## Install
 
 ```sh
-go install github.com/andydixon/mapsize/cmd/mapsize@latest
+go install github.com/andydixon/mapsize/cmd/mapsize@v1.0.0
 # or
 make build   # → bin/mapsize
+sudo make install   # binary + man page under /usr/local (PREFIX=… to change)
+
+# Homebrew (macOS and Linux), once the tap is published
+brew install andydixon/tap/mapsize
 ```
 
+Full reference: `man mapsize` after installing, or `make man` /
+`man -l docs/mapsize.1` from the source tree.
+
 ## Usage
 
 ```sh
@@ -154,6 +162,11 @@ read-only mode.
 
 ## Documentation
 
+* [docs/mapsize.1](docs/mapsize.1) — manual page
 * [ARCHITECTURE.md](ARCHITECTURE.md) — design and invariants
 * [DEVELOPMENT.md](DEVELOPMENT.md) — building, testing, profiling
 * [PERFORMANCE.md](PERFORMANCE.md) — measured results
+
+## License
+
+GPL-3.0-or-later. See [LICENSE](LICENSE).

ROADMAP.md

@@ -37,7 +37,7 @@ Status markers: `[x]` done, `[~]` partial, `[ ]` not started.
 - [x] read-only mode, JSON/CSV export
 - [x] move-to-trash: freedesktop trash (tested on Linux); macOS ~/.Trash and Windows Recycle Bin implemented but not yet tested on those systems
 
-## 0.9 — hardening (ongoing)
+## 0.9 — hardening
 - [~] profiling & benchmarks (warm-cache only so far) (see PERFORMANCE.md)
 - [ ] memory reduction (name arena) if profiles justify it
 - [ ] Windows allocated-size via GetCompressedFileSizeW (opt-in)
@@ -46,5 +46,12 @@ Status markers: `[x]` done, `[~]` partial, `[ ]` not started.
 - [x] incremental path-predicate evaluation for filters
 - [ ] permanent deletion (deliberately not offered yet; trash only)
 
-## 1.0
+## 1.0 (released 2026-10-02)
-- [ ] stable snapshot format v1 guarantee, packaged releases
+- [x] stable snapshot format v1 guarantee
+- [x] packaged releases (`make release`: archives, deb/rpm/apk/Arch, checksums)
+- [x] manual page
+
+## After 1.0
+Unchecked items above carry over; candidates for 1.1 are cold-cache
+benchmarks, configurable keybindings and testing trash/reveal on macOS and
+Windows.

docs/mapsize.1

@@ -0,0 +1,452 @@
+.\" Manual page for mapsize. View with: man -l docs/mapsize.1
+.TH MAPSIZE 1 "October 2026" "mapsize 1.0.0" "User Commands"
+.SH NAME
+mapsize \- interactive terminal disk usage analyser with a navigable treemap
+.SH SYNOPSIS
+.B mapsize
+[\fIOPTIONS\fR] [\fIPATH\fR]
+.br
+.B mapsize
+[\fIOPTIONS\fR] \fISNAPSHOT\fR.msz
+.br
+.B mapsize
+\fB\-\-compare\fR [\fIOPTIONS\fR] \fIOLD\fR.msz \fINEW\fR.msz
+.br
+.B mapsize
+\fIPATH\fR {\fB\-\-top\fR \fIN\fR | \fB\-\-largest\-files\fR \fIN\fR | \fB\-\-json\fR | \fB\-\-csv\fR | \fB\-\-no\-ui\fR} [\fIOPTIONS\fR]
+.SH DESCRIPTION
+.B mapsize
+scans a directory tree and shows its disk usage as a live, space-filling
+treemap that fills the terminal. Each rectangle's area is proportional to the
+size of a file or directory; colours show file categories. The display
+populates while the scan runs and stays interactive throughout.
+.PP
+Arrow keys move spatially between rectangles, Enter shows details, Space
+zooms into a directory and Backspace zooms out. Other views list directory
+contents, file types, top-N lists, scan errors, duplicate files and snapshot
+differences. A query language filters the treemap to matching data.
+.PP
+With no \fIPATH\fR the current directory is scanned. If \fIPATH\fR is a
+snapshot file written by
+.BR mapsize ,
+it is opened instead of scanning. Options may appear before or after
+positional arguments.
+.PP
+When any report option (\fB\-\-no\-ui\fR, \fB\-\-json\fR, \fB\-\-csv\fR,
+\fB\-\-top\fR, \fB\-\-largest\-files\fR, \fB\-\-duplicates\fR) is given,
+.B mapsize
+runs non-interactively and writes to standard output, which makes it
+suitable for scripts, cron jobs and SSH sessions without a full terminal.
+Progress is written to standard error when it is a terminal.
+.SH OPTIONS
+.SS Scanning
+.TP
+.BI \-\-workers " MODE"
+Number of concurrent directory readers:
+.BR conservative " (2), " balanced " (default; min(8, 2\(mu CPUs)), " aggressive
+(min(64, 8\(mu CPUs)), or a number from 1 to 1024. More is not always faster:
+on rotational disks 2\(en4 workers are often best.
+.TP
+.BI \-\-follow\-symlinks " MODE"
+.B none
+(default) treats symbolic links as leaves.
+.B same\-filesystem
+follows links to directories on the same filesystem;
+.B all
+follows every directory link. Loops are detected and nothing is counted
+twice. Ignored (forced to \fBnone\fR) on platforms without inode identity,
+such as Windows.
+.TP
+.BR \-\-one\-file\-system ", " \-x
+Do not descend into directories on a different filesystem than the scan
+root. Without it, other filesystems are scanned (as
+.BR du (1)
+does) and marked as mount points; Linux virtual filesystems (proc, sysfs,
+cgroup, debugfs, \&...) are never scanned.
+.TP
+.BI \-\-exclude " PATTERN"
+Skip matching entries. A pattern containing a path separator matches the
+absolute path (relative patterns are resolved against the working
+directory) and everything beneath it; otherwise it is a shell glob matched
+against the entry name. May be repeated. Exclusions are always shown in the
+interface and reports.
+.TP
+.BI \-\-scan " PATH"
+Path to scan; an alternative to the positional argument.
+.SS Display
+.TP
+.B \-\-apparent
+Size by logical (apparent) size instead of allocated disk usage.
+.TP
+.B \-\-si
+Use SI units (kB, MB, GB; powers of 1000) instead of the default IEC units
+(KiB, MiB, GiB; powers of 1024). The two are never mixed.
+.TP
+.BI \-\-theme " NAME"
+Colour theme:
+.BR default ", " dark ", " high\-contrast " or " mono .
+.TP
+.BI \-\-color " DEPTH"
+Override colour detection:
+.BR auto " (default), " truecolor ", " 256 ", " 16 " or " none .
+Useful over SSH, where \fBCOLORTERM\fR is often not forwarded.
+.TP
+.B \-\-no\-mouse
+Disable mouse support. Everything works from the keyboard.
+.TP
+.B \-\-read\-only
+Disable every action that modifies the filesystem (moving to trash) and
+show \fBREAD ONLY\fR in the header. Saving a snapshot file is still
+allowed. This does not make
+.B mapsize
+a forensic acquisition tool: scanning uses ordinary filesystem calls, and
+duplicate detection reads file contents, which may update access times.
+.SS Reports
+.TP
+.B \-\-no\-ui
+Scan without the interactive interface and print a summary.
+.TP
+.BI \-\-top " N"
+Print the \fIN\fR largest entries directly under the root.
+.TP
+.BI \-\-largest\-files " N"
+Print the \fIN\fR largest files anywhere in the tree.
+.TP
+.B \-\-json
+Print the inventory as nested JSON, with scan metadata and error counts.
+.TP
+.B \-\-csv
+Print one CSV row per entry: path, type, size, allocated, files, dirs,
+errors, modified, flags. Paths are escaped so the output is safe to print
+to a terminal.
+.TP
+.BI \-\-depth " N"
+Limit \fB\-\-json\fR and \fB\-\-csv\fR to \fIN\fR levels (default \-1,
+unlimited).
+.TP
+.B \-\-duplicates
+Find files with identical content and print verified groups (see
+\fBDUPLICATES\fR).
+.SS Snapshots
+.TP
+.BI \-\-save " FILE" "\fR, \fP\-\-snapshot " FILE
+Save a snapshot when the scan completes (not if it was cancelled).
+.TP
+.BI \-\-load " FILE"
+Open a snapshot instead of scanning.
+.TP
+.B \-\-compare
+Compare two snapshots given as positional arguments, \fIOLD\fR then
+\fINEW\fR. Opens the interface (read-only) with growth and shrinkage
+colouring, or prints the most significant changes with \fB\-\-no\-ui\fR
+(\fB\-\-top\fR sets how many; default 30).
+.SS Diagnostics
+.TP
+.BI \-\-log " FILE"
+Append a log to \fIFILE\fR without disturbing the interface. Full paths are
+logged only at \fBdebug\fR level and above.
+.TP
+.BI \-\-log\-level " LEVEL"
+.BR error ", " warn ", " info " (default), " debug " or " trace .
+.TP
+.BI \-\-cpuprofile " FILE"
+Write a Go CPU profile.
+.TP
+.BI \-\-memprofile " FILE"
+Write a Go heap profile on exit.
+.TP
+.B \-\-version
+Print the version and exit.
+.TP
+.BR \-h ", " \-\-help
+Print usage and exit.
+.SH KEYS
+.SS Navigation
+.TP 18
+.BR "\(ua \(da \(<- \(->" ", " "h j k l"
+Move to the neighbouring rectangle in that direction (lists: move the
+cursor).
+.TP
+.B Enter
+Show item information: path, logical and allocated size, type, category,
+times, mode, owner, group, hard links, sparseness, and for directories file
+and directory counts, share of parent and scan, largest child and errors
+beneath.
+.TP
+.BR Space ", " \(->
+Zoom into the selected directory (lists: enter it).
+.TP
+.BR Backspace ", " \(<-
+Zoom out one level.
+.TP
+.B Home
+Return to the scan root.
+.TP
+.B Esc
+Clear the filter, otherwise zoom out; closes any open window.
+.SS Views
+.TP 18
+.BR Tab ", " Shift+Tab
+Next / previous view.
+.TP
+.BR 1 \(en 7
+Jump to a view:
+.BR Map ", " List ", " Types ", " Top ", " Scan ,
+then \fBChanges\fR (compare mode) and \fBDups\fR (after a duplicate
+search).
+.TP
+.B x
+File types: count and size per extension. Enter filters the map by that
+extension.
+.TP
+.B g
+Top lists: largest files, largest directories by own files, oldest and
+newest large files, directories with most entries, sparse files, hard-linked
+files. \(<- and \(-> switch lists; Enter shows details; Space jumps to the item
+in the map.
+.TP
+.B e
+Scan information and the error list.
+.TP
+.B D
+Find duplicate files (asks first).
+.SS Actions
+.TP 18
+.B /
+Search or filter (see \fBFILTER LANGUAGE\fR). Enter keeps the filter, Esc
+clears it.
+.TP
+.B a
+Toggle allocated / logical size.
+.TP
+.B c
+Copy the selected path to the clipboard (OSC 52; terminal support varies).
+.TP
+.B o
+Reveal the selected item in the desktop file manager.
+.TP
+.BR d ", " Delete
+Move the selected item to the trash after confirmation. Disabled with
+\fB\-\-read\-only\fR, for snapshots, and while scanning.
+.TP
+.B s
+Save a snapshot.
+.TP
+.B r
+Rescan, returning to the same directory when it is found again.
+.TP
+.B T
+Cycle colour themes.
+.TP
+.BR ? ", " F1
+Help.
+.TP
+.B Ctrl+C
+Cancel a running scan; press again to quit.
+.TP
+.B q
+Quit (in a window: close it).
+.SS Mouse
+Click selects a rectangle or row; double-click zooms into a directory or
+shows file details; right-click shows details; the wheel zooms the map or
+scrolls lists and windows. Clicking a breadcrumb or tab activates it.
+Clicking outside a window closes it.
+.SH DISPLAY
+Directories are drawn with a border, their name on the top edge and their
+size and share on the bottom edge; large directories show nested previews of
+their contents. The selected rectangle has a double border and a highlighted
+title, so it remains visible without colour.
+.PP
+A terminal has few cells, so entries too small to draw usefully are merged
+into one hatched \fI"N smaller items"\fR block. Enter lists them; zooming in
+or enlarging the terminal reveals them individually.
+.PP
+Layouts adapt to the terminal size: a side panel with a category breakdown
+appears in large terminals, smaller ones get a compact layout, and below
+40\(mu10 a short message is shown instead. Every resize recomputes the
+layout for the new size while keeping the selection, zoom and filter.
+.PP
+Categories are: Image, Video, Audio, Archive, Disk image, Database, Source
+code, Document, Executable, Log, Cache and Other. Directories take the colour
+of the category using most of their space. In compare mode colours show
+change instead: red grew, green shrank, blue new, grey unchanged.
+.SH FILTER LANGUAGE
+A query is one or more conditions combined with
+.BR AND ,
+.B OR
+and
+.B NOT
+(also
+.BR && ", " || ", " ! ),
+with parentheses for grouping. Conditions written side by side are joined
+with AND. Keywords and string comparisons are case-insensitive.
+.PP
+A bare word matches names containing it; a word with \fB*\fR, \fB?\fR or
+\fB[\fR is a glob on the name. Otherwise a condition is
+\fIfield operator value\fR:
+.TP 12
+.B Fields
+.BR name ", " path ", " ext ", " type " (file, dir, symlink, other), " category ,
+.BR size ", " allocated ", " age ", " modified ", " owner ", " group ,
+.BR files " (entries beneath a directory), " flag
+(sparse, hardlink, error, mount, incomplete, followed, broken).
+.TP
+.B Operators
+.BR = ", " != ", " > ", " >= ", " < ", " <= ", " contains ", " matches
+(regular expression; also \fB~\fR) and
+.B in
+with a parenthesised list: \fBext IN (iso,qcow2)\fR.
+.TP
+.B Sizes
+.BR kB ", " MB ", " GB ", " TB
+are SI (1000);
+.BR KiB ", " MiB ", " GiB ", " TiB
+are IEC (1024); bare
+.BR K ", " M ", " G ", " T
+follow the display units.
+.TP
+.B Ages
+.BR s ", " min ", " h ", " d " (default), " w ", " mo " (30 days), " y
+(365 days).
+.B modified
+also accepts dates such as 2024\-01\-31.
+.PP
+A matching directory contributes its whole contents. Examples:
+.PP
+.RS
+.nf
+ubuntu
+*.iso
+size > 5GB
+size > 500MB AND ext IN (iso,qcow2,vmdk)
+path contains cache AND NOT type = dir
+age > 365d AND size > 100MiB
+owner = andy OR flag = sparse
+.fi
+.RE
+.SH SIZES
+By default sizes are \fIallocated\fR (blocks actually used on disk, like
+.BR du (1));
+\fB\-\-apparent\fR or \fBa\fR switches to \fIlogical\fR size. Both appear in
+the information window. Files whose allocated size is at least 4 KiB smaller
+than their logical size are flagged sparse (this also covers filesystem
+compression). On Windows allocated size is not available and logical size is
+used.
+.PP
+Hard links: the first path seen for an inode is counted; later paths add
+nothing to totals and are marked. Which path counts first depends on scan
+order. Windows does not report link counts during enumeration, so hard links
+are not deduplicated there.
+.PP
+Totals are marked incomplete whenever something could not be read
+(permission denied, I/O error, files vanishing during the scan, a cancelled
+scan). Every error is listed in the Scan view.
+.SH DUPLICATES
+Duplicate detection never relies on names or sizes alone. Files are grouped
+by exact size, then three 16 KiB samples (start, middle, end) are hashed,
+and remaining candidates are hashed completely with SHA-256. Only files with
+identical SHA-256 digests are reported as duplicates. Hard links to the same
+inode are not reported. Files that change size or cannot be read during the
+search are skipped and counted.
+.SH SNAPSHOTS
+A snapshot stores the whole inventory in a versioned, gzip-compressed binary
+format with a SHA-256 checksum; it reloads far faster than a rescan of a
+large or slow filesystem. Snapshot files are treated as untrusted: corrupt
+or malicious files are rejected, sizes are bounded, decompressed size is
+limited to 64 times the file size, and aggregates are recomputed rather than
+read. Comparison matches entries by path.
+.SH FILES
+.TP
+.I $XDG_CONFIG_HOME/mapsize/config.json
+Optional settings (default \fI~/.config/mapsize/config.json\fR on Linux,
+\fI~/Library/Application Support/mapsize/config.json\fR on macOS,
+\fI%AppData%\(rsmapsize\(rsconfig.json\fR on Windows). Command-line options
+override it. Keys:
+.BR workers ", " follow_symlinks ", " one_file_system ", " units " (iec or si), "
+.BR size_mode " (allocated or logical), " theme ", " mouse ", " excludes " (list), "
+.BR category_colors " and " extension_colors " (maps to \(dq#rrggbb\(dq), " refresh_hz .
+.PP
+.RS
+.nf
+{
+  "workers": "balanced",
+  "theme": "dark",
+  "excludes": ["/proc", "*.tmp"],
+  "extension_colors": {"qcow2": "#c678dd"}
+}
+.fi
+.RE
+.TP
+.I ~/.local/share/Trash
+Where \fBd\fR moves items on Linux (freedesktop.org trash; items on other
+filesystems go to \fI.Trash\-UID\fR at that filesystem's top). macOS uses
+\fI~/.Trash\fR; Windows uses the Recycle Bin.
+.SH ENVIRONMENT
+.TP
+.B NO_COLOR
+If set, use the \fBmono\fR theme (attributes and glyphs only).
+.TP
+.BR COLORTERM ", " TERM
+Used for colour detection. On \fBTERM=linux\fR box drawing falls back to
+ASCII.
+.TP
+.B MAPSIZE_ASCII
+If set, draw with ASCII characters only.
+.TP
+.B MAPSIZE_DEBUG_PANIC
+Developer aid: \fBui\fR or \fBscanner\fR deliberately crashes to verify that
+the terminal is restored.
+.SH EXIT STATUS
+.TP
+.B 0
+Success, including a scan cancelled from the interface.
+.TP
+.B 1
+An error occurred (for example the path does not exist, a snapshot is
+invalid, or an internal error).
+.TP
+.B 2
+Invalid command-line usage.
+.SH EXAMPLES
+.TP
+.B mapsize /srv
+Explore /srv interactively.
+.TP
+.B mapsize \-x /
+Explore the root filesystem without crossing into other mounts.
+.TP
+.B mapsize \-\-read\-only \-\-color 256 /mnt/evidence
+Investigate without any modifying actions, forcing 256 colours.
+.TP
+.B mapsize /srv \-\-no\-ui \-\-save srv\-$(date +%F).msz
+Nightly snapshot from cron.
+.TP
+.B mapsize \-\-compare srv\-2026\-10\-01.msz srv\-2026\-10\-02.msz
+See what grew overnight.
+.TP
+.B mapsize /home \-\-top 20 \-\-exclude \(aq*.tmp\(aq
+Print the 20 largest entries under /home.
+.TP
+.B mapsize /data \-\-json \-\-depth 2 | jq .tree.children[0]
+Machine-readable output.
+.SH SECURITY
+Filenames are untrusted. Control characters, escape sequences, bidirectional
+overrides and invalid UTF-8 in names are displayed in escaped form (for
+example \fB\(rsx1b\fR) and are never sent to the terminal; the real names are
+kept for file operations. No shell is ever invoked: opening the file manager
+and moving to the trash use direct program execution or native APIs.
+.SH BUGS
+Trash and file-manager integration have been tested on Linux only. Hard-link
+deduplication, allocated sizes and symlink following are unavailable on
+Windows. Keybindings are not configurable.
+.PP
+Report bugs to the author.
+.SH AUTHOR
+Andy Dixon <mapsize@dixon.cx>
+.br
+https://dixon.cx
+.SH SEE ALSO
+.BR du (1),
+.BR df (1),
+.BR ncdu (1),
+.BR find (1)

internal/brand/brand.go

@@ -5,5 +5,7 @@ const (
 	Name          = "mapsize"
 	SnapshotExt   = ".msz"
 	SnapshotMagic = "MAPSIZE\x00"
-	Version       = "0.9.0-dev"
 )
+
+// Version is stamped at release time via -ldflags -X.
+var Version = "1.0.0"

nfpm.yaml

@@ -0,0 +1,14 @@
+name: mapsize
+arch: ${ARCH}
+version: ${VERSION}
+maintainer: Andy Dixon <andy@dixon.cx>
+description: Interactive full-terminal disk usage analyser with a live treemap.
+homepage: https://github.com/andydixon/mapsize
+license: GPL-3.0-or-later
+contents:
+  - src: bin/release/pkg/mapsize
+    dst: /usr/bin/mapsize
+  - src: docs/mapsize.1
+    dst: /usr/share/man/man1/mapsize.1
+    file_info:
+      mode: 0644

packaging/homebrew/mapsize.rb.in

@@ -0,0 +1,26 @@
+# Homebrew formula template for mapsize. `make brew-formula` fills in the
+# version and the checksum of the GitHub source tarball and writes the
+# result to bin/homebrew/mapsize.rb; copy that into your tap
+# (github.com/andydixon/homebrew-tap, Formula/mapsize.rb).
+class Mapsize < Formula
+  desc "Interactive terminal disk usage analyser with a navigable treemap"
+  homepage "https://dixon.cx"
+  license "GPL-3.0-or-later"
+  url "https://github.com/andydixon/mapsize/archive/refs/tags/v@VERSION@.tar.gz"
+  sha256 "@SHA256@"
+  head "https://github.com/andydixon/mapsize.git", branch: "master"
+
+  depends_on "go" => :build
+
+  def install
+    ldflags = "-s -w -X github.com/andydixon/mapsize/internal/brand.Version=#{version}"
+    system "go", "build", *std_go_args(ldflags:), "./cmd/mapsize"
+    man1.install "docs/mapsize.1"
+  end
+
+  test do
+    assert_match version.to_s, shell_output("#{bin}/mapsize --version")
+    (testpath/"data/file.txt").write "hello"
+    assert_match "Files", shell_output("#{bin}/mapsize --no-ui #{testpath}/data")
+  end
+end