# lscolors
```
usage: lscolors [-h] [-H] [-v] [-V] [--print-config] [--print-url]
[--completion [SHELL]]
COMMAND ...
Utilities for `dircolors(1)` and `dir_colors(5)`.
Specify one of:
COMMAND
chart Print color chart.
check Check database for required items.
configs Print path to sample configuration files.
docs Create documentation.
paint Paint dircolors.
report Print colorized database report.
samples Create directory of sample filesystem items.
sort Sort lines of database file by color.
General options:
-h, --help Show this help message and exit.
-H, --long-help Show help for all commands and exit.
-v, --verbose `-v` for detailed output and `-vv` for more detailed.
-V, --version Print version number and exit.
--print-config Print effective config and exit.
--print-url Print project url and exit.
--completion [SHELL] Print completion scripts for `SHELL` and exit
(default: `bash`).
See `lscolors COMMAND --help` for help on a specific command.
```
## lscolors chart
```
usage: lscolors chart [-h] [color ...]
Print color-chart.
positional arguments:
color Print color palette with given colors.
options:
-h, --help Show this help message and exit.
```
## lscolors check
```
usage: lscolors check [-h] [-q] [--config CONFIG] [DIR_COLORS]
Check database in `$LS_COLORS` for required items.
positional arguments:
DIR_COLORS Read file `DIR_COLORS` instead of `$LS_COLORS`.
options:
-h, --help Show this help message and exit.
-q, --quiet Suppress warning if default `CONFIG` cannot be found.
--config CONFIG Require filenames, directories and extensions specified in
`CONFIG` file.
Exit Status: zero indicates success, nonzero indicates failure.
```
## lscolors configs
```
usage: lscolors configs [-h]
Print path to sample `.lscolors.yml` and `.dircolors` configuration files.
options:
-h, --help Show this help message and exit.
```
## lscolors docs
```
usage: lscolors docs [-h] [-f] {ansi,md,txt} DIR
Create documentation files for this application.
positional arguments:
{ansi,md,txt} Output format.
DIR Create directory `DIR`. (default: './docs').
options:
-h, --help Show this help message and exit.
-f, --force Ok to clobber `DIR` if it exists.
This is an internal command used during the packaging process.
```
## lscolors paint
```
usage: lscolors paint [-h] [--encoding NAME] [--palettes-dir DIR]
[--palette-num NUMBER] [--palette-file FILE]
[--pick COLORNUM [COLORNUM ...]] [--add-samples]
[--group-color GROUP=COLOR [GROUP=COLOR ...]]
[DIR_COLORS]
Apply palette to dircolors.
positional arguments:
DIR_COLORS Read `DIR_COLORS` file.
options:
-h, --help Show this help message and exit.
--encoding NAME File encoding.
--palettes-dir DIR Directory of `coloors.co` palettes.
--palette-num NUMBER Id of `coloors.co` palette file to apply.
--palette-file FILE `coloors.co` palette file to apply.
--pick COLORNUM [COLORNUM ...]
Select and order colors by palette-`COLORNUM`.
--add-samples Add color samples.
--group-color GROUP=COLOR [GROUP=COLOR ...]
Paint `GROUP` with `COLOR`, where `GROUP` is one of
`archive`, `image`, `audio`, `data`, `source`,
`config`, `history`, `doc`, `NORMAL`, `FILE`, `RESET`,
`DIR`, `LINK`, `MULTIHARDLINK`, `FIFO`, `SOCK`,
`DOOR`, `BLK`, `CHR`, `ORPHAN`, `MISSING`, `SETUID`,
`SETGID`, `CAPABILITY`, `STICKY_OTHER_WRITABLE`,
`OTHER_WRITABLE`, `STICKY`, `EXEC`.
```
## lscolors report
```
usage: lscolors report [-h] [--left | --right] [DIR_COLORS]
Print colorized report for database in `$LS_COLORS`.
positional arguments:
DIR_COLORS Read file `DIR_COLORS` instead of `$LS_COLORS`.
options:
-h, --help Show this help message and exit.
--left Format report for display in left window.
--right Format report for display in right window.
A default format is produced when `--left/--right` is not given.
```
## lscolors samples
```
usage: lscolors samples [-h] [-q] [--config CONFIG] [--samplesdir DIR] [-f]
[DIR_COLORS]
Create directory and populate with sample files, directories, etc.,
for each item in `$LS_COLORS`, and all required items in
configuration file `CONFIG`.
positional arguments:
DIR_COLORS Read file `DIR_COLORS` instead of `$LS_COLORS`.
options:
-h, --help Show this help message and exit.
-q, --quiet Suppress warning if default `CONFIG` cannot be found.
--config CONFIG Require filenames, directories and extensions specified in
`CONFIG` file.
--samplesdir DIR Create directory `DIR`.
-f, --force Ok to clobber `DIR` if it exists.
```
## lscolors sort
```
usage: lscolors sort [-h]
Filter `stdin` to `stdout` sorting lines of a `DIR_COLORS` file
by color then filetype. Blank lines and comments are unsorted
and moved to the end.
options:
-h, --help Show this help message and exit.
```
Raw data
{
"_id": null,
"home_page": null,
"name": "lscolors",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.10",
"maintainer_email": null,
"keywords": "dircolors, xterm-256color, color-scheme, terminal, shell, ls, tree",
"author": null,
"author_email": "Russel Lane <russel@rlane.com>",
"download_url": "https://files.pythonhosted.org/packages/e1/4c/190a87c84b46e67890be1b574c671b8191a03e05329335d9f84cd5361afd/lscolors-1.0.3.tar.gz",
"platform": null,
"description": "# lscolors\n```\nusage: lscolors [-h] [-H] [-v] [-V] [--print-config] [--print-url]\n [--completion [SHELL]]\n COMMAND ...\n\nUtilities for `dircolors(1)` and `dir_colors(5)`.\n\nSpecify one of:\n COMMAND\n chart Print color chart.\n check Check database for required items.\n configs Print path to sample configuration files.\n docs Create documentation.\n paint Paint dircolors.\n report Print colorized database report.\n samples Create directory of sample filesystem items.\n sort Sort lines of database file by color.\n\nGeneral options:\n -h, --help Show this help message and exit.\n -H, --long-help Show help for all commands and exit.\n -v, --verbose `-v` for detailed output and `-vv` for more detailed.\n -V, --version Print version number and exit.\n --print-config Print effective config and exit.\n --print-url Print project url and exit.\n --completion [SHELL] Print completion scripts for `SHELL` and exit\n (default: `bash`).\n\nSee `lscolors COMMAND --help` for help on a specific command.\n```\n\n## lscolors chart\n```\nusage: lscolors chart [-h] [color ...]\n\nPrint color-chart.\n\npositional arguments:\n color Print color palette with given colors.\n\noptions:\n -h, --help Show this help message and exit.\n```\n\n## lscolors check\n```\nusage: lscolors check [-h] [-q] [--config CONFIG] [DIR_COLORS]\n\nCheck database in `$LS_COLORS` for required items.\n\npositional arguments:\n DIR_COLORS Read file `DIR_COLORS` instead of `$LS_COLORS`.\n\noptions:\n -h, --help Show this help message and exit.\n -q, --quiet Suppress warning if default `CONFIG` cannot be found.\n --config CONFIG Require filenames, directories and extensions specified in\n `CONFIG` file.\n\nExit Status: zero indicates success, nonzero indicates failure.\n```\n\n## lscolors configs\n```\nusage: lscolors configs [-h]\n\nPrint path to sample `.lscolors.yml` and `.dircolors` configuration files.\n\noptions:\n -h, --help Show this help message and exit.\n```\n\n## lscolors docs\n```\nusage: lscolors docs [-h] [-f] {ansi,md,txt} DIR\n\nCreate documentation files for this application.\n\npositional arguments:\n {ansi,md,txt} Output format.\n DIR Create directory `DIR`. (default: './docs').\n\noptions:\n -h, --help Show this help message and exit.\n -f, --force Ok to clobber `DIR` if it exists.\n\nThis is an internal command used during the packaging process.\n```\n\n## lscolors paint\n```\nusage: lscolors paint [-h] [--encoding NAME] [--palettes-dir DIR]\n [--palette-num NUMBER] [--palette-file FILE]\n [--pick COLORNUM [COLORNUM ...]] [--add-samples]\n [--group-color GROUP=COLOR [GROUP=COLOR ...]]\n [DIR_COLORS]\n\nApply palette to dircolors.\n\npositional arguments:\n DIR_COLORS Read `DIR_COLORS` file.\n\noptions:\n -h, --help Show this help message and exit.\n --encoding NAME File encoding.\n --palettes-dir DIR Directory of `coloors.co` palettes.\n --palette-num NUMBER Id of `coloors.co` palette file to apply.\n --palette-file FILE `coloors.co` palette file to apply.\n --pick COLORNUM [COLORNUM ...]\n Select and order colors by palette-`COLORNUM`.\n --add-samples Add color samples.\n --group-color GROUP=COLOR [GROUP=COLOR ...]\n Paint `GROUP` with `COLOR`, where `GROUP` is one of\n `archive`, `image`, `audio`, `data`, `source`,\n `config`, `history`, `doc`, `NORMAL`, `FILE`, `RESET`,\n `DIR`, `LINK`, `MULTIHARDLINK`, `FIFO`, `SOCK`,\n `DOOR`, `BLK`, `CHR`, `ORPHAN`, `MISSING`, `SETUID`,\n `SETGID`, `CAPABILITY`, `STICKY_OTHER_WRITABLE`,\n `OTHER_WRITABLE`, `STICKY`, `EXEC`.\n```\n\n## lscolors report\n```\nusage: lscolors report [-h] [--left | --right] [DIR_COLORS]\n\nPrint colorized report for database in `$LS_COLORS`.\n\npositional arguments:\n DIR_COLORS Read file `DIR_COLORS` instead of `$LS_COLORS`.\n\noptions:\n -h, --help Show this help message and exit.\n --left Format report for display in left window.\n --right Format report for display in right window.\n\nA default format is produced when `--left/--right` is not given.\n```\n\n## lscolors samples\n```\nusage: lscolors samples [-h] [-q] [--config CONFIG] [--samplesdir DIR] [-f]\n [DIR_COLORS]\n\nCreate directory and populate with sample files, directories, etc.,\nfor each item in `$LS_COLORS`, and all required items in\nconfiguration file `CONFIG`.\n\npositional arguments:\n DIR_COLORS Read file `DIR_COLORS` instead of `$LS_COLORS`.\n\noptions:\n -h, --help Show this help message and exit.\n -q, --quiet Suppress warning if default `CONFIG` cannot be found.\n --config CONFIG Require filenames, directories and extensions specified in\n `CONFIG` file.\n --samplesdir DIR Create directory `DIR`.\n -f, --force Ok to clobber `DIR` if it exists.\n```\n\n## lscolors sort\n```\nusage: lscolors sort [-h]\n\nFilter `stdin` to `stdout` sorting lines of a `DIR_COLORS` file\nby color then filetype. Blank lines and comments are unsorted\nand moved to the end.\n\noptions:\n -h, --help Show this help message and exit.\n```\n\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "dircolors utilities",
"version": "1.0.3",
"project_urls": {
"Homepage": "https://github.com/russellane/lscolors"
},
"split_keywords": [
"dircolors",
" xterm-256color",
" color-scheme",
" terminal",
" shell",
" ls",
" tree"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "4b6810bf398ecc0334c4b968a6a3d48b322fe4a4c58f98180f370da98c65074b",
"md5": "e7de58b16331ad356bfd740fb642208b",
"sha256": "dc0160495858775d7b1bb641def6b82f7eaf5eb3cc7a272ac0886a40be3d04f7"
},
"downloads": -1,
"filename": "lscolors-1.0.3-py3-none-any.whl",
"has_sig": false,
"md5_digest": "e7de58b16331ad356bfd740fb642208b",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10",
"size": 31957,
"upload_time": "2024-11-17T18:07:33",
"upload_time_iso_8601": "2024-11-17T18:07:33.697028Z",
"url": "https://files.pythonhosted.org/packages/4b/68/10bf398ecc0334c4b968a6a3d48b322fe4a4c58f98180f370da98c65074b/lscolors-1.0.3-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "e14c190a87c84b46e67890be1b574c671b8191a03e05329335d9f84cd5361afd",
"md5": "7235e228d41134703dcbd45e8421358f",
"sha256": "0bf451f9573540b924d42361055810cd030c0aaff8e69635dc2c5d1ee3678533"
},
"downloads": -1,
"filename": "lscolors-1.0.3.tar.gz",
"has_sig": false,
"md5_digest": "7235e228d41134703dcbd45e8421358f",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10",
"size": 26015,
"upload_time": "2024-11-17T18:07:35",
"upload_time_iso_8601": "2024-11-17T18:07:35.488583Z",
"url": "https://files.pythonhosted.org/packages/e1/4c/190a87c84b46e67890be1b574c671b8191a03e05329335d9f84cd5361afd/lscolors-1.0.3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-11-17 18:07:35",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "russellane",
"github_project": "lscolors",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "lscolors"
}
JSON
