File: wordcloud_cli.1

package info (click to toggle)
python-wordcloud 1.9.3%2Bdfsg-2
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 288 kB
  • sloc: python: 1,429; sh: 46; makefile: 14
file content (127 lines) | stat: -rw-r--r-- 3,508 bytes parent folder | download | duplicates (3)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
.\" DO NOT MODIFY THIS FILE!  It was generated by help2man 1.47.16.
.TH WORDCLOUD_CLI "1" "November 2020" "wordcloud_cli 1.8.1" "User Commands"
.SH NAME
wordcloud_cli \- little word cloud generator in Python
.SH DESCRIPTION
usage: wordcloud_cli [\-h] [\-\-text file] [\-\-regexp regexp] [\-\-stopwords file]
.TP
[\-\-imagefile file] [\-\-fontfile path] [\-\-mask file]
[\-\-colormask file] [\-\-contour_width width]
[\-\-contour_color color] [\-\-relative_scaling rs]
[\-\-margin width] [\-\-width width] [\-\-height height]
[\-\-color color] [\-\-background color] [\-\-no_collocations]
[\-\-include_numbers] [\-\-min_word_length min_word_length]
[\-\-prefer_horizontal ratio] [\-\-scale scale]
[\-\-colormap map] [\-\-mode mode] [\-\-max_words N]
[\-\-min_font_size size] [\-\-max_font_size size]
[\-\-font_step step] [\-\-random_state seed]
[\-\-no_normalize_plurals] [\-\-repeat] [\-\-version]
.PP
A simple command line interface for wordcloud module.
.SS "optional arguments:"
.TP
\fB\-h\fR, \fB\-\-help\fR
show this help message and exit
.TP
\fB\-\-text\fR file
specify file of words to build the word cloud
(default: stdin)
.TP
\fB\-\-regexp\fR regexp
override the regular expression defining what
constitutes a word
.TP
\fB\-\-stopwords\fR file
specify file of stopwords (containing one word per
line) to remove from the given text after parsing
.TP
\fB\-\-imagefile\fR file
file the completed PNG image should be written to
(default: stdout)
.TP
\fB\-\-fontfile\fR path
path to font file you wish to use (default:
DroidSansMono)
.TP
\fB\-\-mask\fR file
mask to use for the image form
.TP
\fB\-\-colormask\fR file
color mask to use for image coloring
.TP
\fB\-\-contour_width\fR width
if greater than 0, draw mask contour (default: 0)
.TP
\fB\-\-contour_color\fR color
use given color as mask contour color \- accepts any
value from PIL.ImageColor.getcolor
.TP
\fB\-\-relative_scaling\fR rs
scaling of words by frequency (0 \- 1)
.TP
\fB\-\-margin\fR width
spacing to leave around words
.TP
\fB\-\-width\fR width
define output image width
.TP
\fB\-\-height\fR height
define output image height
.TP
\fB\-\-color\fR color
use given color as coloring for the image \- accepts
any value from PIL.ImageColor.getcolor
.TP
\fB\-\-background\fR color
use given color as background color for the image \-
accepts any value from PIL.ImageColor.getcolor
.TP
\fB\-\-no_collocations\fR
do not add collocations (bigrams) to word cloud
(default: add unigrams and bigrams)
.TP
\fB\-\-include_numbers\fR
include numbers in wordcloud?
.TP
\fB\-\-min_word_length\fR min_word_length
only include words with more than X letters
.TP
\fB\-\-prefer_horizontal\fR ratio
ratio of times to try horizontal fitting as opposed to
vertical
.TP
\fB\-\-scale\fR scale
scaling between computation and drawing
.TP
\fB\-\-colormap\fR map
matplotlib colormap name
.TP
\fB\-\-mode\fR mode
use RGB or RGBA for transparent background
.TP
\fB\-\-max_words\fR N
maximum number of words
.TP
\fB\-\-min_font_size\fR size
smallest font size to use
.TP
\fB\-\-max_font_size\fR size
maximum font size for the largest word
.TP
\fB\-\-font_step\fR step
step size for the font
.TP
\fB\-\-random_state\fR seed
random seed
.TP
\fB\-\-no_normalize_plurals\fR
whether to remove trailing 's' from words
.TP
\fB\-\-repeat\fR
whether to repeat words and phrases
.TP
\fB\-\-version\fR
show program's version number and exit
.SH AUTHOR
 This manpage was written by Nilesh Patra for the Debian distribution and
 can be used for any other usage of the program.