{"id":13807615,"url":"https://github.com/rolinh/dfc","last_synced_at":"2025-03-17T01:31:28.957Z","repository":{"id":4449887,"uuid":"5588369","full_name":"rolinh/dfc","owner":"rolinh","description":"Report file system space usage information with style","archived":false,"fork":false,"pushed_at":"2022-08-09T07:12:57.000Z","size":841,"stargazers_count":103,"open_issues_count":13,"forks_count":10,"subscribers_count":7,"default_branch":"master","last_synced_at":"2024-04-24T00:44:21.065Z","etag":null,"topics":["cli","cross-platform","df","disk-space","filesystem","partitions"],"latest_commit_sha":null,"homepage":"","language":"C","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"bsd-3-clause","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/rolinh.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2012-08-28T16:03:51.000Z","updated_at":"2023-12-09T17:24:40.000Z","dependencies_parsed_at":"2022-07-30T12:38:04.848Z","dependency_job_id":null,"html_url":"https://github.com/rolinh/dfc","commit_stats":null,"previous_names":[],"tags_count":24,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rolinh%2Fdfc","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rolinh%2Fdfc/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rolinh%2Fdfc/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rolinh%2Fdfc/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/rolinh","download_url":"https://codeload.github.com/rolinh/dfc/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243836015,"owners_count":20355615,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["cli","cross-platform","df","disk-space","filesystem","partitions"],"created_at":"2024-08-04T01:01:27.627Z","updated_at":"2025-03-17T01:31:28.249Z","avatar_url":"https://github.com/rolinh.png","language":"C","funding_links":[],"categories":["C","\u003ca name=\"disk-analyzer\"\u003e\u003c/a\u003eDisk usage analyzers"],"sub_categories":[],"readme":"# README\n\n`dfc` is a tool to report file system space usage information. When the output\nis a terminal, it uses color and graphs by default. It has a lot of features\nsuch as HTML, JSON and CSV export, multiple filtering options, the ability to\nshow mount options and so on.\n\n![screenshot](res/screenshot.png)\n\n## BUILD\n\n`cmake` is required to build `dfc`. For convenience, a simple `Makefile` (which\ncalls `cmake` under the hood) is provided.\n\nI suggest you create a `build` directory in which you compile `dfc`. This is of\ncourse not required but it will prevent files from being created everywhere in\nthe source folder.\n\n### BUILD STEPS\n\nCreate the build directory:\n\n\tmkdir build\n\nNavigate into it:\n\n\tcd build\n\nRun the `cmake` command to generate a `Makefile` that works for your OS:\n\n\tcmake ..\n\nNow you can use the make command to build `dfc`:\n\n\tmake\n\nThe `dfc` binary will be placed into a `bin` sub-directory.\n\n### BUILD OPTIONS\n\nSeveral options can be tweaked before you compile `dfc`. To activate /\ndeactivate or change them, you need to do it at the `cmake` step. Note that you\nmay also use `ccmake` instead which gives you a `curses` interface to tweak the\noptions.\n\nBy default, translations are enabled. They require `gettext` to be installed on\nthe system. You can however easily disable them in which case no translations\nnor language translated configuration files will be installed.\n\n\tcmake .. -DNLS_ENABLED=false\n\n`dfc` has also the `LFS` option enabled by default. This option activates\ncompile flags in order to support listing of large file systems (over 4G) on\n32-bit hosts. This will not harm 64-bit systems if activated but if you feel the\nneed to deactivate it, use the following:\n\n    cmake .. -DLFS_ENABLED=false\n\nDifferent types of build are available. Most people will only care about\n`RELEASE` which is the build type that shall be used when distributing the\nsoftware as binary or installing it as it adds some optimization flags.\nTo enable `RELEASE` build use the following:\n\n    cmake .. -DCMAKE_BUILD_TYPE=RELEASE\n\nDevelopers might care about `DEBUG` build when debugging the program as it adds\ndebug flags such as `-g3`. Enable it like so:\n\n    cmake .. -DCMAKE_BUILD_TYPE=DEBUG\n\nNote that by default, `dfc` build with very strict compilers flags.\n\n## RUN\n\nOnce built, you can run `dfc` by typing:\n\n\t./dfc\n\nfrom within the directory where `dfc` is located.\n\nSee `./dfc -h` for quick options and usage overview or read the manual page.\n\n## INSTALL\n\nBy default, `dfc` binary will be installed in `/usr/local/bin`. As `root`, type:\n\n\tmake install\n\nYou can also choose some standards parameters like where the files need to be\ninstalled. This needs to be done when using the `cmake` command.\nExample (from the previously created build directory):\n\n\tcmake .. -DPREFIX=/usr -DSYSCONFDIR=/etc -DCMAKE_BUILD_TYPE=RELEASE\n\nThen run the `make install` and it will install `dfc` according to what you\nchose in the previous step.\n\n## CONFIGURATION FILE\n\nThe configuration file found in `conf/dfcrc` needs to be placed here if one\ndesires to use it:\n\n\t$XDG_CONFIG_HOME/dfc/dfcrc\n\nNote that if, for instance, French is the language you use, you should then use\nthe configuration file that has been translated into French\n(found in `conf/fr/dfcrc`) and so on for any language into which `dfc` has been\ntranslated.\n\nIf your operating system does not support `XDG Base Directory Specification` it\ncan then be placed in this directory:\n\n\t$HOME/.config/dfc/dfcrc\n\nOr, last choice, directly in `$HOME` (but the name has to be preceded by a dot):\n\n\t$HOME/.dfcrc\n\n## INFORMATION FOR PACKAGERS\n\nHere is the list of dependencies:\n\n  * standard C library\n\nYep, that should be it. :)\n\nPlease, note that `gettext` is required in order to build translations.\nIf you do not want to package `dfc` with translation support, use the option to\ndisable translation as explained in the build section.\n\nOf course, `cmake` is a build dependency.\n\n\u003c!-- vim: set filetype=markdown textwidth=80 --\u003e\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frolinh%2Fdfc","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Frolinh%2Fdfc","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frolinh%2Fdfc/lists"}