├── .github └── PULL_REQUEST_TEMPLATE.md ├── COPYING ├── disk-usage-by-types.png ├── disk-usage-pkg.el ├── disk-usage.el ├── disk-usage.png └── readme.org /.github/PULL_REQUEST_TEMPLATE.md: -------------------------------------------------------------------------------- 1 | :warning: This repo is a read-only mirror. Please submit changes upstream instead :warning: 2 | -------------------------------------------------------------------------------- /COPYING: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | 635 | Copyright (C) 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | Copyright (C) 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | -------------------------------------------------------------------------------- /disk-usage-by-types.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/emacs-straight/disk-usage/5afb1bb8e1d92af03fe0b22686478991dd7c8cef/disk-usage-by-types.png -------------------------------------------------------------------------------- /disk-usage-pkg.el: -------------------------------------------------------------------------------- 1 | ;; Generated package description from disk-usage.el -*- no-byte-compile: t -*- 2 | (define-package "disk-usage" "1.3.3.0.20230920.164444" "Sort and browse disk usage listings" '((emacs "26.1")) :commit "b0d803f2cec3afc2937840f9ba66e3f903d6c415" :authors '(("Pierre Neidhardt" . "mail@ambrevar.xyz")) :maintainer '("Pierre Neidhardt" . "mail@ambrevar.xyz") :keywords '("files" "convenience" "tools") :url "https://gitlab.com/Ambrevar/emacs-disk-usage") 3 | -------------------------------------------------------------------------------- /disk-usage.el: -------------------------------------------------------------------------------- 1 | ;;; disk-usage.el --- Sort and browse disk usage listings -*- lexical-binding: t -*- 2 | 3 | ;; Copyright (C) 2019 Free Software Foundation, Inc. 4 | 5 | ;; Author: Pierre Neidhardt 6 | ;; Maintainer: Pierre Neidhardt 7 | ;; URL: https://gitlab.com/Ambrevar/emacs-disk-usage 8 | ;; Version: 1.3.3 9 | ;; Package-Requires: ((emacs "26.1")) 10 | ;; Keywords: files, convenience, tools 11 | 12 | ;; This file is not part of GNU Emacs. 13 | 14 | ;; This program is free software; you can redistribute it and/or modify 15 | ;; it under the terms of the GNU General Public License as published by 16 | ;; the Free Software Foundation, either version 3 of the License, or 17 | ;; (at your option) any later version. 18 | ;; 19 | ;; This program is distributed in the hope that it will be useful, 20 | ;; but WITHOUT ANY WARRANTY; without even the implied warranty of 21 | ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 22 | ;; GNU General Public License for more details. 23 | ;; 24 | ;; You should have received a copy of the GNU General Public License 25 | ;; along with this program. If not, see . 26 | 27 | ;;; Commentary: 28 | ;; 29 | ;; Warning: BSD and macOS users need `gdu`, the "GNU du" from the "GNU 30 | ;; coreutils". 31 | ;; 32 | ;; Disk Usage is a file system analyzer: it offers a tabulated view of file 33 | ;; listings sorted by size. Directory sizes are computed recursively. The results 34 | ;; are cached for speed. 35 | ;; 36 | ;; Run `disk-usage' or `disk-usage-here' to display a listing. 37 | ;; See `describe-mode' for additional bindings, such as 38 | ;; `disk-usage-dired-at-point' to open a `dired' buffer for the current 39 | ;; directory. 40 | ;; 41 | ;; Instead of displaying only the current folder, `disk-usage' can also display 42 | ;; files in all subfolders recursively with `disk-usage-toggle-recursive'. 43 | ;; 44 | ;; Marked files can be trashed with `disk-usage-delete-marked-files'. When 45 | ;; called with a prefix argument, files are deleted permanently. 46 | ;; 47 | ;; Run `disk-usage-by-types' to display statistics of disk usage by file 48 | ;; extensions. 49 | ;; 50 | ;; With a prefix argument, cache is updated when reverting the buffer. 51 | ;; 52 | ;; With `disk-usage-add-filters' you can filter out files with arbitrary 53 | ;; predicates, e.g. files bigger than some size or older than a certain number 54 | ;; of days. 55 | ;; 56 | ;; You can customize options in the 'disk-usage group. 57 | 58 | 59 | ;;; Code: 60 | (require 'tabulated-list) 61 | (require 'seq) 62 | (eval-when-compile (require 'cl-lib)) 63 | 64 | ;; TODO: Can we factor `disk-usage-files' into filters? 65 | 66 | ;; TODO: Use file-notify library to watch file system changes and auto-update. 67 | ;; Also see https://github.com/Alexander-Miller/treemacs#filewatch-mode. 68 | 69 | ;; TODO: Apparent size? Not obvious, because Emacs file-attributes does not support it. 70 | ;; TODO: Helm-FF does not work when file-name-nondirectory is on. 71 | ;; TODO: Add support for charts? 72 | 73 | (defgroup disk-usage nil 74 | "Predefined configurations for `disk-usage'." 75 | :group 'files) 76 | 77 | (defcustom disk-usage-discard-previous-buffer t 78 | "Whether to kill the current `disk-usage' buffer before moving directory." 79 | :type 'boolean) 80 | 81 | (defvaralias 'disk-usage--du-command 'disk-usage-du-command) 82 | (defcustom disk-usage-du-command (if (member system-type '(gnu gnu/linux gnu/kfreebsd)) 83 | "du" 84 | "gdu") 85 | "Non-GNU users need GNU's `du' for the `-b' flag. See `disk-usage-du-args'." 86 | :type 'string) 87 | 88 | (defvaralias 'disk-usage--du-args 'disk-usage-du-args) 89 | (defcustom disk-usage-du-args "-s -b" 90 | "Non-GNU users need GNU's `du' for the `-b' flag. See `disk-usage-du-command'." 91 | :type 'string) 92 | 93 | (defvaralias 'disk-usage--find-command 'disk-usage-find-command) 94 | (defcustom disk-usage-find-command "find" 95 | "The `find' executable. This is required for recursive listings." 96 | :type 'string) 97 | 98 | (defvaralias 'disk-usage--directory-size-function 'disk-usage-directory-size-function) 99 | (defcustom disk-usage-directory-size-function 100 | (if (executable-find disk-usage-du-command) 101 | #'disk-usage-directory-size-with-du 102 | #'disk-usage-directory-size-with-emacs) 103 | "Function that returns the total disk usage of the directory passed as argument." 104 | :type '(choice (function :tag "Native (slow)" disk-usage-directory-size-with-emacs) 105 | (function :tag "System \"du\"" disk-usage-directory-size-with-du))) 106 | 107 | (defface disk-usage-inaccessible 108 | '((t :inherit error 109 | :underline t)) 110 | "Face for inaccessible folders.") 111 | 112 | (defface disk-usage-symlink 113 | '((t :inherit warning)) 114 | "Face for symlinks.") 115 | 116 | (defface disk-usage-symlink-directory 117 | '((t :inherit disk-usage-symlink 118 | :underline t)) 119 | "Face for symlinked directories.") 120 | 121 | (defface disk-usage-size 122 | '((t :inherit default)) 123 | "Face for sizes.") 124 | 125 | (defface disk-usage-percent 126 | '((t :inherit default)) 127 | "Face for the percent column.") 128 | 129 | (defface disk-usage-children 130 | '((t :inherit default)) 131 | "Face for the children column.") 132 | 133 | (defvar disk-usage-mode-map 134 | (let ((map (make-sparse-keymap))) 135 | (set-keymap-parent map tabulated-list-mode-map) 136 | (define-key map (kbd "S-") #'disk-usage-find-file-at-point) 137 | (define-key map (kbd "") #'disk-usage-up) 138 | (define-key map "^" #'disk-usage-up) 139 | (define-key map "a" #'disk-usage-add-filters) 140 | (define-key map "A" #'disk-usage-remove-filters) 141 | (define-key map "d" #'disk-usage-dired-at-point) 142 | (define-key map "e" #'disk-usage-eshell-at-point) 143 | (define-key map "h" #'disk-usage-toggle-human-readable) 144 | (define-key map "f" #'disk-usage-toggle-full-path) 145 | (define-key map "R" #'disk-usage-toggle-recursive) 146 | (define-key map "m" #'disk-usage-mark) 147 | (define-key map "u" #'disk-usage-unmark) 148 | (define-key map "x" #'disk-usage-delete-marked-files) 149 | map) 150 | "Local keymap for `disk-usage-mode' buffers.") 151 | 152 | (defvar disk-usage--cache nil) 153 | 154 | (cl-defstruct (disk-usage--file-info 155 | (:constructor nil) 156 | (:constructor disk-usage--file-info-make)) 157 | size 158 | name 159 | (device 0) ; Used to identify hard links. 160 | (inode 0) ; Used to identify hard links. 161 | (children 0) 162 | (marked nil)) 163 | 164 | (defun disk-usage-reset-cache () 165 | (interactive) 166 | (clrhash disk-usage--cache)) 167 | 168 | (defun disk-usage-filter-1-hour> (_path attributes &optional seconds) 169 | "Discard regular files older than 1 hour." 170 | (if (null (file-attribute-type attributes)) 171 | ;; Regular files 172 | (time-less-p 173 | (time-since 174 | (file-attribute-modification-time attributes)) 175 | (seconds-to-time (or seconds (* 60 60)))) 176 | ;; Always keep directories and symlinks. 177 | t)) 178 | 179 | (defun disk-usage-filter-1-day> (_path attributes &optional days) 180 | "Discard regular files older than 1 day." 181 | (if (null (file-attribute-type attributes)) 182 | ;; Regular files 183 | (time-less-p 184 | (time-since 185 | (file-attribute-modification-time attributes)) 186 | (days-to-time (or days 1))) 187 | ;; Always keep directories and symlinks. 188 | t)) 189 | 190 | (defun disk-usage-filter-1-week> (path attributes) 191 | (disk-usage-filter-1-day> path attributes 7)) 192 | 193 | (defun disk-usage-filter-4-weeks> (path attributes) 194 | (disk-usage-filter-1-day> path attributes 28)) 195 | 196 | (defun disk-usage-filter-1-MiB> (_path attributes &optional size) 197 | "Discard regular files bigger than 1 MiB." 198 | (if (null (file-attribute-type attributes)) 199 | ;; Regular files 200 | (< (file-attribute-size attributes) (or size (* 1024 1024))) 201 | ;; Always keep directories and symlinks. 202 | t)) 203 | 204 | (defun disk-usage-filter-10-MiB> (path attributes) 205 | (disk-usage-filter-1-MiB> path attributes (* 10 1024 1024))) 206 | 207 | (defun disk-usage-filter-100-MiB> (path attributes) 208 | (disk-usage-filter-1-MiB> path attributes (* 100 1024 1024))) 209 | 210 | (defun disk-usage-filter-1-GiB> (path attributes) 211 | (disk-usage-filter-1-MiB> path attributes (* 1024 1024 1024))) 212 | 213 | (defcustom disk-usage-available-filters '(disk-usage-filter-1-hour> 214 | disk-usage-filter-1-day> 215 | disk-usage-filter-1-week> 216 | disk-usage-filter-4-weeks> 217 | disk-usage-filter-1-MiB> 218 | disk-usage-filter-10-MiB> 219 | disk-usage-filter-100-MiB> 220 | disk-usage-filter-1-GiB>) 221 | "Filters can be used to leave out files from the listing. 222 | 223 | A filter is a function that takes a path and file attributes and 224 | return nil to exclude a file or non-nil to include it. 225 | A file must pass all the filters to be included. 226 | See `disk-usage-add-filters' and `disk-usage-remove-filters'. 227 | 228 | You can add custom filters to this list." 229 | :type '(repeat symbol)) 230 | 231 | (defcustom disk-usage-default-filters '() 232 | "Filters to enable in new `disk-usage' buffers." 233 | :type '(repeat symbol)) 234 | 235 | (defvar-local disk-usage-filters nil 236 | "List of `disk-usage' filters in current buffer. 237 | See `disk-usage-add-filters' and `disk-usage-remove-filters'.") 238 | 239 | (defun disk-usage-add-filters () 240 | (interactive) 241 | (let ((filters (completing-read-multiple "Filters: " 242 | disk-usage-available-filters 243 | nil 244 | t))) 245 | (dolist (filter filters) 246 | (add-to-list 'disk-usage-filters (intern filter))) 247 | (tabulated-list-revert))) 248 | 249 | (defun disk-usage-remove-filters () 250 | (interactive) 251 | (if (null disk-usage-filters) 252 | (message "No filters in this buffer.") 253 | (let ((filters (completing-read-multiple "Filters: " 254 | disk-usage-filters 255 | nil 256 | t))) 257 | (setq disk-usage-filters 258 | (seq-difference disk-usage-filters 259 | (mapcar #'intern filters))) 260 | (tabulated-list-revert)))) 261 | 262 | (defun disk-usage--list (directory &optional listing) 263 | (setq directory (or directory default-directory)) 264 | (let ((listing (or listing 265 | (and (file-accessible-directory-p directory) 266 | (directory-files-and-attributes 267 | directory 268 | 'full directory-files-no-dot-files-regexp 'nosort))))) 269 | (or (cl-loop for l in listing 270 | for attributes = (cl-rest l) 271 | for path = (cl-first l) 272 | if (cl-loop for filter in disk-usage-filters 273 | always (funcall filter path attributes)) 274 | ;; Files 275 | if (null (file-attribute-type attributes)) 276 | collect (disk-usage--file-info-make 277 | :name path 278 | :inode (file-attribute-inode-number attributes) 279 | :device (file-attribute-device-number attributes) 280 | :size (file-attribute-size attributes)) 281 | ;; Symlinks 282 | else if (stringp (file-attribute-type attributes)) 283 | collect (disk-usage--file-info-make 284 | :name path 285 | :size (file-attribute-size attributes)) 286 | ;; Folders 287 | else if (eq t (file-attribute-type attributes)) 288 | collect 289 | (disk-usage--file-info-make 290 | :name path 291 | :size (disk-usage--directory-size path) 292 | :children (if (file-accessible-directory-p path) 293 | (- (length (directory-files path)) 2) 294 | 0))) 295 | (list (disk-usage--file-info-make :size 0 :name directory))))) 296 | 297 | (defun disk-usage--list-recursively (directory) 298 | "This is the equivalent of running the shell command 299 | $ find . -type f -exec du -sb {} +" 300 | (setq directory (or directory default-directory)) 301 | (let* ((default-directory directory) 302 | ;; Note: Cannot use `process-lines' if we want to work on remote hosts. 303 | (subdirs (split-string 304 | (with-temp-buffer 305 | (process-file disk-usage-find-command nil '(t nil) nil 306 | (file-local-name directory) 307 | "-type" "d") 308 | (buffer-string)) 309 | "\n" 'omit-nulls)) 310 | (remote-subdirs (mapcar (lambda (item) 311 | (concat (file-remote-p directory) item)) 312 | subdirs))) 313 | (cl-loop for dir in remote-subdirs 314 | append (cl-loop for file in (directory-files-and-attributes dir 315 | 'full 316 | directory-files-no-dot-files-regexp 317 | 'nosort) 318 | for name = (car file) 319 | for attributes = (cdr file) 320 | do (message "FILE %s" file) 321 | when (and attributes 322 | (not (file-attribute-type attributes)) ; We discard non-files. 323 | (cl-loop for filter in disk-usage-filters 324 | always (funcall filter name attributes))) 325 | collect (disk-usage--file-info-make 326 | :name name 327 | :inode (file-attribute-inode-number attributes) 328 | :device (file-attribute-device-number attributes) 329 | :size (file-attribute-size attributes)))))) 330 | 331 | (defcustom disk-usage-list-function #'disk-usage--list 332 | "Function that returns a list of `disk-usage--file-info'. 333 | It takes the directory to scan as argument." 334 | :type '(choice (function :tag "Hierarchical" disk-usage--list) 335 | (function :tag "Flat (recursive)" disk-usage--list-recursively))) 336 | (make-variable-buffer-local 'disk-usage-list-function) 337 | 338 | (defun disk-usage-toggle-recursive () 339 | "Toggle between hierarchical and flat view." 340 | (interactive) 341 | (setq disk-usage-list-function 342 | (if (eq disk-usage-list-function #'disk-usage--list) 343 | #'disk-usage--list-recursively 344 | #'disk-usage--list)) 345 | (tabulated-list-revert)) 346 | 347 | (defun disk-usage--total (listing) 348 | "Return the total size of all files in LISTING. 349 | Hard-links are taken into account." 350 | (cl-loop with map = (make-hash-table :test #'equal) 351 | for file in listing 352 | for index = (and (/= 0 (disk-usage--file-info-inode file)) 353 | (list (disk-usage--file-info-inode file) 354 | (disk-usage--file-info-device file))) 355 | unless (gethash index map) 356 | sum (disk-usage--file-info-size file) 357 | when index 358 | do (puthash index t map))) 359 | 360 | (defun disk-usage--directory-size (path) 361 | (let ((size (unless current-prefix-arg 362 | (gethash path disk-usage--cache)))) 363 | (unless size 364 | ;; TODO: Add progress "bar"? But can we get progress for "du"? 365 | ;; Maybe just print progress when using `disk-usage-directory-size-with-emacs'. 366 | (message "Computing disk usage for %S..." path) 367 | (setq size (funcall disk-usage-directory-size-function path)) 368 | (puthash path size disk-usage--cache)) 369 | size)) 370 | 371 | (defun disk-usage-directory-size-with-emacs (path) 372 | "Return the total disk usage of directory PATH as a number. 373 | This is slow but does not require any external process. 374 | Hard-links are taken into account." 375 | ;; `disk-usage--list' won't do since we need to detect hard-links across 376 | ;; subdirectories. This is unfortunately slower, but since we have the fast 377 | ;; `disk-usage-directory-size-with-du' it's not worth optimizing. 378 | (disk-usage--total (disk-usage--list-recursively path))) 379 | (defalias 'disk-usage--directory-size-with-emacs 'disk-usage-directory-size-with-emacs) 380 | 381 | (defun disk-usage-directory-size-with-du (path) 382 | "See `disk-usage-directory-size-function'." 383 | (or (ignore-errors (string-to-number 384 | (cl-first 385 | (split-string 386 | (with-temp-buffer 387 | (with-output-to-string 388 | (message "%S" (append (split-string disk-usage-du-args) (list (file-local-name path)))) 389 | (apply #'process-file disk-usage-du-command 390 | nil '(t nil) nil 391 | (append (split-string disk-usage-du-args) (list (file-local-name path))))) 392 | (buffer-string)))))) 393 | 0)) 394 | (defalias 'disk-usage--directory-size-with-du 'disk-usage-directory-size-with-du) 395 | 396 | (defun disk-usage--sort-by-size (a b) 397 | (< (disk-usage--file-info-size (car a)) 398 | (disk-usage--file-info-size (car b)))) 399 | 400 | (defun disk-usage--sort-by-children (a b) 401 | (< (disk-usage--file-info-children (car a)) 402 | (disk-usage--file-info-children (car b)))) 403 | 404 | (defcustom disk-usage-size-format-function #'file-size-human-readable 405 | "How to print size. 406 | Takes a number and returns a string." 407 | :type '(choice (function :tag "Human readable" file-size-human-readable) 408 | (function :tag "In bytes" number-to-string))) 409 | 410 | (defun disk-usage--set-tabulated-list-format (&optional total-size) 411 | (setq tabulated-list-format 412 | `[("Size" 413 | ,(if (eq disk-usage-size-format-function #'file-size-human-readable) 414 | 8 415 | 12) 416 | disk-usage--sort-by-size . (:right-align t)) 417 | ("%%" 6 disk-usage--sort-by-size . (:right-align t)) 418 | ("Children" 8 disk-usage--sort-by-children . (:right-align t)) 419 | (,(format "Files %sin '%s'" 420 | (if total-size 421 | (format "totalling %sB (%s) " 422 | total-size 423 | (file-size-human-readable total-size)) 424 | "") 425 | default-directory) 426 | 0 t)])) 427 | 428 | (defun disk-usage--refresh (&optional directory) 429 | (setq directory (or directory default-directory)) 430 | (let* ((listing (funcall disk-usage-list-function directory)) 431 | (total-size (disk-usage--directory-size directory))) 432 | (disk-usage--set-tabulated-list-format total-size) 433 | (tabulated-list-init-header) 434 | (setq tabulated-list-entries 435 | (mapcar 436 | (lambda (file-info) 437 | (list file-info 438 | (vector 439 | (number-to-string (disk-usage--file-info-size file-info)) 440 | (format "%.1f%%" 441 | (* 100 (/ (float (disk-usage--file-info-size file-info)) 442 | total-size))) 443 | (number-to-string (disk-usage--file-info-children file-info)) 444 | (let ((name (disk-usage--file-info-name file-info))) 445 | (if (file-directory-p name) 446 | ;; Make button. 447 | (cons name 448 | (list 'action 449 | (lambda (_) 450 | (disk-usage name)))) 451 | name))))) 452 | listing)))) 453 | 454 | (defvar disk-usage--format-files #'identity 455 | "How to print files. 456 | Takes a string and returns a string. 457 | `identity' and `file-name-nondirectory' are good candidates.") 458 | 459 | (defun disk-usage-toggle-human-readable () 460 | "Toggle between printing size in bytes or in more readable units." 461 | (interactive) 462 | (setq disk-usage-size-format-function 463 | (if (eq disk-usage-size-format-function #'file-size-human-readable) 464 | #'number-to-string 465 | #'file-size-human-readable)) 466 | (tabulated-list-revert)) 467 | 468 | (defun disk-usage-toggle-full-path () 469 | "Toggle between displaying the full paths or the base names." 470 | (interactive) 471 | (setq disk-usage--format-files 472 | (if (eq disk-usage--format-files #'identity) 473 | #'file-name-nondirectory 474 | #'identity)) 475 | (tabulated-list-revert)) 476 | 477 | (defun disk-usage--print-file-col (file-entry) 478 | "Call `disk-usage--format-file' on FILE-ENTRY. 479 | FILE-ENTRY may be a string or a button." 480 | (let* ((filename (if (listp file-entry) 481 | (cl-first file-entry) 482 | file-entry)) 483 | (formatted-filename 484 | (cond 485 | ;; Symlinks 486 | ((stringp (file-attribute-type (file-attributes filename))) 487 | (concat (propertize (funcall disk-usage--format-files filename) 488 | 'face (if (file-directory-p filename) 489 | 'disk-usage-symlink-directory 490 | 'disk-usage-symlink)) 491 | " -> " (file-attribute-type (file-attributes filename)))) 492 | ;; Directories 493 | ((and (not (null (file-attribute-type (file-attributes filename)))) 494 | (not (file-accessible-directory-p filename))) 495 | (propertize (funcall disk-usage--format-files filename) 496 | 'face 'disk-usage-inaccessible)) 497 | ;; Regular files 498 | (t (funcall disk-usage--format-files filename))))) 499 | (if (listp file-entry) 500 | (let ((copy (cl-copy-list file-entry))) 501 | (setcar copy formatted-filename) 502 | copy) 503 | formatted-filename))) 504 | 505 | ;; TODO: We could avoid defining our own `disk-usage--print-entry' by settings 506 | ;; `tabulated-list-entries' to a closure over the listing calling 507 | ;; `disk-usage-size-format-function' to generate the columns. 508 | (defun disk-usage--print-entry (id cols) 509 | "Like `tabulated-list-print-entry' but formats size for human beings." 510 | (let ((beg (point)) 511 | (x (max tabulated-list-padding 0)) 512 | (ncols (length tabulated-list-format)) 513 | (inhibit-read-only t)) 514 | (if (> tabulated-list-padding 0) 515 | (insert (make-string x ?\s))) 516 | ;; FIXME: External packages shouldn't (have to) refer to this internal var. 517 | (defvar tabulated-list--near-rows) 518 | (let ((tabulated-list--near-rows ; Bind it if not bound yet (Bug#25506). 519 | (or (bound-and-true-p tabulated-list--near-rows) 520 | (list (or (tabulated-list-get-entry (line-beginning-position 0)) 521 | cols) 522 | cols)))) 523 | (setq x (tabulated-list-print-col 0 524 | (propertize 525 | (funcall disk-usage-size-format-function 526 | (string-to-number (aref cols 0))) 527 | 'face 'disk-usage-size) 528 | x)) 529 | (setq x (tabulated-list-print-col 1 (propertize (aref cols 1) 'face 'disk-usage-percent) x)) 530 | (setq x (tabulated-list-print-col 2 (propertize (aref cols 2) 'face 'disk-usage-children) x)) 531 | (setq x (tabulated-list-print-col 3 (disk-usage--print-file-col (aref cols 3)) x)) 532 | (cl-loop for i from 4 below ncols 533 | do (setq x (tabulated-list-print-col i (aref cols i) x)))) 534 | (insert ?\n) 535 | ;; Ever so slightly faster than calling `put-text-property' twice. 536 | (add-text-properties 537 | beg (point) 538 | `(tabulated-list-id ,id tabulated-list-entry ,cols 539 | ;; WARNING: The following is a workaround for Helm so that 540 | ;; (helm-find-files-input 541 | ;; (helm-ffap-guesser) 542 | ;; (thing-at-point 'filename)) 543 | ;; guesses the right file. 544 | help-echo ,(aref cols 1))))) 545 | 546 | (define-derived-mode disk-usage-mode tabulated-list-mode "Disk Usage" 547 | "Mode to display disk usage. 548 | With a prefix argument, cache is updated when reverting the buffer. 549 | 550 | Also see `disk-usage-by-types-mode'." 551 | ;; TODO: Option to display extra attributes and default column to sort. 552 | (hl-line-mode) 553 | (setq tabulated-list-padding 2) 554 | (setq tabulated-list-sort-key (cons "Size" 'flip)) 555 | (setq tabulated-list-printer #'disk-usage--print-entry) 556 | (add-hook 'tabulated-list-revert-hook 'disk-usage--refresh nil t)) 557 | 558 | (defvar disk-usage-buffer-name "disk-usage") 559 | 560 | ;;;###autoload 561 | (defun disk-usage (&optional directory) 562 | "Display listing of files in DIRECTORY with their size. 563 | If DIRECTORY is nil, use current directory." 564 | (interactive "DDirectory name: ") 565 | (unless (and (stringp directory) (file-accessible-directory-p directory)) 566 | (error "Directory cannot be opened: %S" directory)) 567 | (unless disk-usage--cache 568 | (setq disk-usage--cache (make-hash-table :test #'equal))) 569 | (setq directory (file-truename (or (and (file-directory-p directory) 570 | directory) 571 | default-directory))) 572 | (switch-to-buffer 573 | (get-buffer-create (format "*%s<%s>*" disk-usage-buffer-name 574 | (directory-file-name directory)))) 575 | (disk-usage-mode) 576 | (setq disk-usage-filters disk-usage-default-filters) 577 | (setq default-directory directory) 578 | (tabulated-list-revert)) 579 | 580 | ;;;###autoload 581 | (defun disk-usage-here () 582 | "Run `disk-usage' in current directory." 583 | (interactive) 584 | (disk-usage default-directory)) 585 | 586 | (defun disk-usage-up (&optional toggle-discard-previous-buffer) 587 | "Run `disk-usage' in the parent directory. 588 | If `disk-usage-discard-previous-buffer' is non-nil, 589 | the current buffer is discarded before switched. 590 | With TOGGLE-DISCARD-PREVIOUS-BUFFER or prefix argument, this behaviour is 591 | reversed." 592 | (interactive "p") 593 | (let ((directory default-directory)) 594 | (when (and (or (and (not toggle-discard-previous-buffer) 595 | disk-usage-discard-previous-buffer) 596 | (and toggle-discard-previous-buffer 597 | (not disk-usage-discard-previous-buffer))) 598 | (eq major-mode 'disk-usage-mode)) 599 | (kill-this-buffer)) 600 | (disk-usage (expand-file-name ".." directory)))) 601 | 602 | (defun disk-usage--file-name-at-point () 603 | (let ((file-info (tabulated-list-get-id (point)))) 604 | (disk-usage--file-info-name file-info))) 605 | 606 | (defun disk-usage--directory-at-point () 607 | (let ((path (disk-usage--file-name-at-point))) 608 | (if (file-directory-p path) 609 | path 610 | (setq path (file-name-directory path))))) 611 | 612 | (defun disk-usage-mark-at-point (&optional count mark) 613 | "Mark entry at point. 614 | See `disk-usage-mark' and `disk-usage-unmark'." 615 | (interactive "p") 616 | (let ((step (if (> count 0) 1 -1))) 617 | (setq count (abs count) 618 | mark (or mark "*")) 619 | (dotimes (_ count) 620 | (let ((file-info (tabulated-list-get-id (point)))) 621 | (setf (disk-usage--file-info-marked file-info) (not (string= mark "")))) 622 | (tabulated-list-put-tag mark) 623 | (forward-line step)))) 624 | 625 | (defun disk-usage-mark (&optional count mark) 626 | "Mark files for deletion with `disk-usage-delete-marked-files'. 627 | With numeric argument, mark that many times. 628 | With negative numeric argument, move upward. 629 | When region is active, mark all entries in region." 630 | (interactive "p") 631 | (if (region-active-p) 632 | (let ((count (count-lines 633 | (region-beginning) 634 | (region-end)))) 635 | (save-mark-and-excursion 636 | (goto-char (region-beginning)) 637 | (disk-usage-mark-at-point count mark))) 638 | (disk-usage-mark-at-point count mark))) 639 | 640 | (defun disk-usage-unmark (&optional count) 641 | "Unmark files marked with `disk-usage-mark'. 642 | With numeric argument, unmark that many times. 643 | With negative numeric argument, move upward. 644 | When region is active, unmark all entries in region." 645 | (interactive "p") 646 | (disk-usage-mark count "")) 647 | 648 | (defun disk-usage-delete-marked-files (&optional permanently) 649 | "Delete marked files. 650 | By default, files are moved to trash unless PERMANENTLY is 651 | non-nil or with prefix argument." 652 | (interactive "P") 653 | (when (yes-or-no-p (format "%s marked files?" (if permanently 654 | "Delete" "Trash"))) 655 | (cl-loop for entry in tabulated-list-entries 656 | if (disk-usage--file-info-marked (car entry)) 657 | do (let ((delete-by-moving-to-trash (not permanently)) 658 | (file (disk-usage--file-info-name (car entry)))) 659 | (if (file-directory-p file) 660 | (delete-directory file 661 | 'recursive 662 | delete-by-moving-to-trash) 663 | (delete-file file delete-by-moving-to-trash)))) 664 | (tabulated-list-revert))) 665 | 666 | (defun disk-usage-find-file-at-point () 667 | "Find file at point in Emacs." 668 | (interactive) 669 | (find-file (disk-usage--file-name-at-point))) 670 | 671 | (defun disk-usage-dired-at-point () 672 | (interactive) 673 | (dired (disk-usage--directory-at-point))) 674 | 675 | (defun disk-usage-eshell-at-point () 676 | "Run a new `eshell' from the folder at point." 677 | (interactive) 678 | (let ((default-directory (disk-usage--directory-at-point))) 679 | (eshell 'new-session))) 680 | 681 | (defun disk-usage-shell-at-point () 682 | "Run a new `shell' from the folder at point." 683 | (interactive) 684 | (let ((default-directory (disk-usage--directory-at-point))) 685 | (shell (get-buffer-create (generate-new-buffer-name "*shell*"))))) 686 | 687 | ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; 688 | (cl-defstruct (disk-usage--type-info 689 | (:constructor nil) 690 | (:constructor disk-usage--type-info-make)) 691 | names 692 | size 693 | (count 1)) 694 | 695 | (defun disk-usage-by-types--list (directory) 696 | "Return a hash table of (TYPE DISK-USAGE-TYPE-INFO). 697 | TYPE is the file extension (lower case)." 698 | (setq directory (or directory default-directory)) 699 | (let ((listing (disk-usage--list-recursively directory)) 700 | (table (make-hash-table :test #'equal))) 701 | (dolist (file-info listing) 702 | (let* ((ext (downcase (or (file-name-extension 703 | (disk-usage--file-info-name file-info)) 704 | ""))) 705 | (size (disk-usage--file-info-size file-info)) 706 | (type (gethash ext table))) 707 | (puthash ext 708 | (if (not type) 709 | (disk-usage--type-info-make 710 | :names (list (disk-usage--file-info-name file-info)) 711 | :size size) 712 | (setf 713 | (disk-usage--type-info-names type) 714 | (cons (disk-usage--file-info-name file-info) 715 | (disk-usage--type-info-names type))) 716 | (setf (disk-usage--type-info-count type) 717 | (1+ (disk-usage--type-info-count type))) 718 | (setf (disk-usage--type-info-size type) 719 | (+ size (disk-usage--type-info-size type))) 720 | type) 721 | table))) 722 | table)) 723 | 724 | (defun disk-usage--type-average-size (type) 725 | (/ (float (disk-usage--type-info-size type)) 726 | (disk-usage--type-info-count type))) 727 | 728 | (defun disk-usage-by-types--sort-by-count (a b) 729 | (< (disk-usage--type-info-count (car a)) 730 | (disk-usage--type-info-count (car b)))) 731 | 732 | (defun disk-usage-by-types--sort-by-size (a b) 733 | (< (disk-usage--type-info-size (car a)) 734 | (disk-usage--type-info-size (car b)))) 735 | 736 | (defun disk-usage-by-types--sort-by-average (a b) 737 | (< (disk-usage--type-average-size (car a)) 738 | (disk-usage--type-average-size (car b)))) 739 | 740 | (defun disk-usage-by-types--set-tabulated-list-format () 741 | (setq tabulated-list-format 742 | `[("Extension" 12 t) 743 | ("Count" 12 disk-usage-by-types--sort-by-count) 744 | ("%%" 6 disk-usage-by-types--sort-by-size . (:right-align t)) 745 | ("Total size" 12 disk-usage-by-types--sort-by-size . (:right-align t)) 746 | ("Average size" 15 747 | disk-usage-by-types--sort-by-average . (:right-align t))])) 748 | 749 | (defun disk-usage-by-types--refresh (&optional directory) 750 | (setq directory (or directory default-directory)) 751 | (let ((listing (disk-usage-by-types--list directory))) 752 | (disk-usage-by-types--set-tabulated-list-format) 753 | (tabulated-list-init-header) 754 | (let ((total-size (cl-loop for e being the hash-values of listing 755 | sum (disk-usage--type-info-size e)))) 756 | (setq tabulated-list-entries 757 | (cl-loop for e being the hash-values of listing using (hash-keys ext) 758 | collect 759 | (list 760 | e 761 | (vector 762 | ext 763 | (number-to-string (disk-usage--type-info-count e)) 764 | (format "%.1f%%" 765 | (* 100 (/ (float (disk-usage--type-info-size e)) 766 | total-size))) 767 | (funcall disk-usage-size-format-function 768 | (disk-usage--type-info-size e)) 769 | (funcall disk-usage-size-format-function 770 | (string-to-number 771 | (format "%.2f" 772 | (disk-usage--type-average-size e))))))))))) 773 | 774 | (defvar disk-usage-by-types-mode-map 775 | (let ((map (make-sparse-keymap))) 776 | (set-keymap-parent map tabulated-list-mode-map) 777 | (define-key map "h" #'disk-usage-toggle-human-readable) 778 | (define-key map "a" #'disk-usage-add-filters) 779 | (define-key map "A" #'disk-usage-remove-filters) 780 | ;; Don't use "" since that doesn't work in a tty. 781 | (define-key map (kbd "RET") #'disk-usage-files) 782 | map) 783 | "Local keymap for `disk-usage-by-types-mode' buffers.") 784 | 785 | (define-derived-mode disk-usage-by-types-mode tabulated-list-mode "Disk Usage By Types" 786 | "Mode to display disk usage by file types. 787 | Also see `disk-usage-mode'." 788 | (hl-line-mode) 789 | (setq tabulated-list-sort-key (cons "Total size" 'flip)) 790 | (add-hook 'tabulated-list-revert-hook 'disk-usage-by-types--refresh nil t)) 791 | 792 | (defvar disk-usage-by-types-buffer-name "disk-usage-by-types") 793 | 794 | ;;;###autoload 795 | (defun disk-usage-by-types (&optional directory) 796 | (interactive "DDirectory name: ") 797 | (setq directory (file-truename (or (and (file-directory-p directory) 798 | directory) 799 | default-directory))) 800 | (switch-to-buffer 801 | (get-buffer-create (format "*%s<%s>*" disk-usage-by-types-buffer-name 802 | (directory-file-name directory)))) 803 | (disk-usage-by-types-mode) 804 | (setq default-directory directory) 805 | (tabulated-list-revert)) 806 | 807 | ;;;###autoload 808 | (defun disk-usage-by-types-here () 809 | "Run `disk-usage-by-types' in current directory." 810 | (interactive) 811 | (disk-usage-by-types default-directory)) 812 | 813 | (defvar disk-usage-files-buffer-name "disk-usage-files") 814 | 815 | (defun disk-usage-files (&optional listing) 816 | "Run `disk-usage' over LISTING. 817 | If nil, LISTING is taken from the entry in the 818 | `disk-usage-by-types' buffer." 819 | (interactive) 820 | (unless (eq major-mode 'disk-usage-by-types-mode) 821 | (error "Must be in a disk-usage-by-types buffer")) 822 | (setq listing (or listing 823 | (disk-usage--type-info-names (tabulated-list-get-id)))) 824 | (let ((listing-with-attributes (cl-loop for l in listing 825 | collect (cons l (file-attributes l))))) 826 | (switch-to-buffer 827 | (get-buffer-create (format "*%s*" disk-usage-files-buffer-name))) 828 | (disk-usage-mode) 829 | (setq disk-usage-filters disk-usage-default-filters) 830 | (set (make-local-variable 'disk-usage-list-function) 831 | (lambda (_) (disk-usage--list nil listing-with-attributes))) 832 | (tabulated-list-revert))) 833 | 834 | (provide 'disk-usage) 835 | ;;; disk-usage.el ends here 836 | -------------------------------------------------------------------------------- /disk-usage.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/emacs-straight/disk-usage/5afb1bb8e1d92af03fe0b22686478991dd7c8cef/disk-usage.png -------------------------------------------------------------------------------- /readme.org: -------------------------------------------------------------------------------- 1 | #+TITLE: disk-usage.el 2 | 3 | Disk Usage is a file system analyzer: it offers a tabulated view of file 4 | listings sorted by size. Directory sizes are computed recursively. The results 5 | are cached for speed. 6 | 7 | This package answers the shortcomings of ~dired-du~ (notably that it's not able 8 | to sort by size, see [[https://github.com/calancha/dired-du/issues/2]]). It also 9 | aims at replacing other, more limited disk analyzers such as =ncdu=. 10 | 11 | * Installation 12 | 13 | Get the package, either from [[https://guix.info][Guix]] or ELPA: 14 | 15 | : M-x package-install RET disk-usage RET 16 | 17 | Or clone / download this repository and modify your ~load-path~. 18 | 19 | : (add-to-list 'load-path (expand-file-name "/path/to/this-package/" user-emacs-directory)) 20 | 21 | Load the package with 22 | 23 | : (require 'disk-usage) 24 | 25 | Warning: BSD and macOS users need `gdu`, the "GNU du" from the "GNU coreutils". 26 | 27 | * Features 28 | 29 | Run ~disk-usage~ or ~disk-usage-here~ to display a listing. See ~describe-mode~ 30 | to display additional bindings, such as ~disk-usage-dired-at-point~ to open a 31 | ~dired~ buffer for the current directory. 32 | 33 | Instead of displaying only the current folder, ~disk-usage~ can also display 34 | files in all subfolders recursively with ~disk-usage-toggle-recursive~. 35 | 36 | Marked files can be trashed with `disk-usage-delete-marked-files'. When called 37 | with a prefix argument, files are deleted permanently. 38 | 39 | Run ~disk-usage-by-types~ to display statistics of disk usage by file 40 | extensions. 41 | 42 | With a prefix argument, cache is updated when reverting the buffer. 43 | 44 | With ~disk-usage-add-filters~ you can filter out files with arbitrary 45 | predicates, e.g. files bigger than some size or older than a certain number of 46 | days. 47 | 48 | ~disk-usage~ also works with TRAMP, i.e. in folders with restricted-acess like 49 | =/sudo::/root= or on remote machines. 50 | 51 | You can customize options in the =disk-usage= group. 52 | 53 | * Screenshots 54 | 55 | - Hierarchical disk usage display: 56 | #+ATTR_HTML: :width 800px 57 | [[./disk-usage.png]] 58 | - Disk usage by file extensions: 59 | #+ATTR_HTML: :width 800px 60 | [[./disk-usage-by-types.png]] 61 | --------------------------------------------------------------------------------