ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/rxvt-unicode/src/perl/background
(Generate patch)

Comparing rxvt-unicode/src/perl/background (file contents):
Revision 1.99 by sf-exg, Sat May 8 07:45:48 2021 UTC vs.
Revision 1.100 by root, Sat Jul 24 09:48:43 2021 UTC

259 259
260=head1 REFERENCE 260=head1 REFERENCE
261 261
262=head2 COMMAND LINE SWITCHES 262=head2 COMMAND LINE SWITCHES
263 263
264=over 4 264=over
265 265
266=item --background-expr perl-expression 266=item --background-expr perl-expression
267 267
268Specifies the Perl expression to evaluate. 268Specifies the Perl expression to evaluate.
269 269
310 310
311These functions provide an image, by loading it from disk, grabbing it 311These functions provide an image, by loading it from disk, grabbing it
312from the root screen or by simply generating it. They are used as starting 312from the root screen or by simply generating it. They are used as starting
313points to get an image you can play with. 313points to get an image you can play with.
314 314
315=over 4 315=over
316 316
317=item load $path 317=item load $path
318 318
319Loads the image at the given C<$path>. The image is set to plane tiling 319Loads the image at the given C<$path>. The image is set to plane tiling
320mode. 320mode.
439=head2 TILING MODES 439=head2 TILING MODES
440 440
441The following operators modify the tiling mode of an image, that is, the 441The following operators modify the tiling mode of an image, that is, the
442way that pixels outside the image area are painted when the image is used. 442way that pixels outside the image area are painted when the image is used.
443 443
444=over 4 444=over
445 445
446=item tile $img 446=item tile $img
447 447
448Tiles the whole plane with the image and returns this new image - or in 448Tiles the whole plane with the image and returns this new image - or in
449other words, it returns a copy of the image in plane tiling mode. 449other words, it returns a copy of the image in plane tiling mode.
524dimensions. They are not (Perl-) variables, they just return stuff that 524dimensions. They are not (Perl-) variables, they just return stuff that
525varies. Most of them make your expression sensitive to some events, for 525varies. Most of them make your expression sensitive to some events, for
526example using C<TW> (terminal width) means your expression is evaluated 526example using C<TW> (terminal width) means your expression is evaluated
527again when the terminal is resized. 527again when the terminal is resized.
528 528
529=over 4 529=over
530 530
531=item TX 531=item TX
532 532
533=item TY 533=item TY
534 534
627 627
628=head2 SHAPE CHANGING OPERATORS 628=head2 SHAPE CHANGING OPERATORS
629 629
630The following operators modify the shape, size or position of the image. 630The following operators modify the shape, size or position of the image.
631 631
632=over 4 632=over
633 633
634=item clip $img 634=item clip $img
635 635
636=item clip $width, $height, $img 636=item clip $width, $height, $img
637 637
824 824
825=head2 COLOUR MODIFICATIONS 825=head2 COLOUR MODIFICATIONS
826 826
827The following operators change the pixels of the image. 827The following operators change the pixels of the image.
828 828
829=over 4 829=over
830 830
831=item tint $color, $img 831=item tint $color, $img
832 832
833Tints the image in the given colour. 833Tints the image in the given colour.
834 834
999=head2 OTHER STUFF 999=head2 OTHER STUFF
1000 1000
1001Anything that didn't fit any of the other categories, even after applying 1001Anything that didn't fit any of the other categories, even after applying
1002force and closing our eyes. 1002force and closing our eyes.
1003 1003
1004=over 4 1004=over
1005 1005
1006=item keep { ... } 1006=item keep { ... }
1007 1007
1008This operator takes a code block as argument, that is, one or more 1008This operator takes a code block as argument, that is, one or more
1009statements enclosed by braces. 1009statements enclosed by braces.
1042OSC sequences for setting a background image. These settings are 1042OSC sequences for setting a background image. These settings are
1043B<deprecated> and will be removed in future versions. 1043B<deprecated> and will be removed in future versions.
1044 1044
1045=head2 OPTIONS AND RESOURCES 1045=head2 OPTIONS AND RESOURCES
1046 1046
1047=over 4 1047=over
1048 1048
1049=item B<-pixmap> I<file[;oplist]> 1049=item B<-pixmap> I<file[;oplist]>
1050 1050
1051=item B<backgroundPixmap:> I<file[;oplist]> 1051=item B<backgroundPixmap:> I<file[;oplist]>
1052 1052
1054optionally specify a colon separated list of operations to modify it. 1054optionally specify a colon separated list of operations to modify it.
1055Note that you may need to quote the C<;> character when using the 1055Note that you may need to quote the C<;> character when using the
1056command line option, as C<;> is usually a metacharacter in shells. 1056command line option, as C<;> is usually a metacharacter in shells.
1057Supported operations are: 1057Supported operations are:
1058 1058
1059=over 4 1059=over
1060 1060
1061=item B<WxH+X+Y> 1061=item B<WxH+X+Y>
1062 1062
1063sets scale and position. B<"W" / "H"> specify the horizontal/vertical 1063sets scale and position. B<"W" / "H"> specify the horizontal/vertical
1064scale (percent), and B<"X" / "Y"> locate the image centre (percent). A 1064scale (percent), and B<"X" / "Y"> locate the image centre (percent). A
1081 1081
1082The default scale and position setting is C<100x100+50+50>. 1082The default scale and position setting is C<100x100+50+50>.
1083Alternatively, a predefined set of templates can be used to achieve 1083Alternatively, a predefined set of templates can be used to achieve
1084the most common setups: 1084the most common setups:
1085 1085
1086=over 4 1086=over
1087 1087
1088=item B<style=tiled> 1088=item B<style=tiled>
1089 1089
1090the image is tiled with no scaling. Equivalent to 0x0+0+0:op=tile 1090the image is tiled with no scaling. Equivalent to 0x0+0+0:op=tile
1091 1091
1156so to make urxvt recognize them, you have to enable the C<background> 1156so to make urxvt recognize them, you have to enable the C<background>
1157extension. One way to achieve that is to use the C<--background-expr ''> 1157extension. One way to achieve that is to use the C<--background-expr ''>
1158command line argument or by specifying an empty C<URxvt.background.expr:>> 1158command line argument or by specifying an empty C<URxvt.background.expr:>>
1159resource. 1159resource.
1160 1160
1161=over 4 1161=over
1162 1162
1163=item B<< C<ESC ] 705 ; Pt ST> >> Change transparent background tint colour to B<< C<Pt> >>. 1163=item B<< C<ESC ] 705 ; Pt ST> >> Change transparent background tint colour to B<< C<Pt> >>.
1164 1164
1165=item B<< C<ESC ] 20 ; Pt ST> >> Change/Query background image 1165=item B<< C<ESC ] 20 ; Pt ST> >> Change/Query background image
1166parameters: the value of B<< C<Pt> >> can be one of the following 1166parameters: the value of B<< C<Pt> >> can be one of the following
1167commands: 1167commands:
1168 1168
1169=over 4 1169=over
1170 1170
1171=item B<< C<?> >> 1171=item B<< C<?> >>
1172 1172
1173display scale and position in the title 1173display scale and position in the title
1174 1174

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines