git.hungrycats.org Git - xscreensaver/blob - driver/xscreensaver-text.man

   1 .TH XScreenSaver 1 "20-Mar-2005 (4.21)" "X Version 11"
   2 .SH NAME
   3 xscreensaver\-text - prints some text to stdout, for use by screen savers.
   4 .SH SYNOPSIS
   5 .B xscreensaver\-text
   6 [\--verbose]
   7 [\--columns \fIN\fP]
   8 [\--text \fISTRING\fP]
   9 [\--file \fIPATH\fP]
  10 [\--program \fICMD\fP]
  11 [\--url \fIURL\fP]
  12 .SH DESCRIPTION
  13 The \fIxscreensaver\-text\fP script prints out some text for use by
  14 various screensavers, according to the options set in the ~/.xscreensaver
  15 file.  This may dump the contents of a file, run a program, or load a URL.
  16 .SH OPTIONS
  17 .I xscreensaver\-text
  18 accepts the following options:
  19 .TP 8
  20 .B \-\-columns \fIN\fP or \-\-cols \fIN\fP
  21 Where to wrap lines; default 72 columns.
  22 .TP 8
  23 .B \-\-verbose \fRor\fP \-v
  24 Print diagnostics to stderr.  Multiple \fI-v\fP switches increase the
  25 amount of output.
  26 .PP
  27 Command line options may be used to override the settings in the
  28 ~/.xscreensaver file:
  29 .TP 8
  30 .B \-\-string \fISTRING\fP
  31 Print the given string.  It may contain % escape sequences as per
  32 .BR strftime (2).
  33 .TP 8
  34 .B \-\-file \fIPATH\fP
  35 Print the contents of the given file.  If --cols is specified, re-wrap
  36 the lines; otherwise, print them as-is.
  37 .TP 8
  38 .B \-\-program \fICMD\fP
  39 Run the given program and print its output.  If --cols is specified,
  40 re-wrap the output.
  41 .TP 8
  42 .B \-\-url \fIHTTP-URL\fP
  43 Download and print the contents of the HTTP document.  If it contains
  44 HTML, RSS, or Atom, it will be converted to plain-text.
  45
  46 Note: this re-downloads the document every time it is run!  It might
  47 be considered abusive for you to point this at a web server that you
  48 do not control!
  49 .SH ENVIRONMENT
  50 .PP
  51 .TP 4
  52 .B HTTP_PROXY\fR or \fPhttp_proxy
  53 to get the default HTTP proxy host and port.
  54 .SH BUGS
  55 The RSS and Atom output is always ISO-8859-1, regardless of locale.
  56
  57 URLs should be cached, use "If-Modified-Since", and obey "Expires".
  58 .SH SEE ALSO
  59 .BR xscreensaver-demo (1),
  60 .BR xscreensaver (1),
  61 .BR fortune (1),
  62 .BR phosphor (MANSUFFIX),
  63 .BR apple2 (MANSUFFIX),
  64 .BR starwars (MANSUFFIX),
  65 .BR fontglide (MANSUFFIX),
  66 .BR dadadodo (1),
  67 .BR webcollage (MANSUFFIX),
  68 .I http://www.livejournal.com/stats/latest-rss.bml,
  69 .BR driftnet (1),
  70 .BR EtherPEG ,
  71 .BR EtherPeek
  72 .SH COPYRIGHT
  73 Copyright \(co 2005 by Jamie Zawinski.  Permission to use, copy, modify,
  74 distribute, and sell this software and its documentation for any purpose is
  75 hereby granted without fee, provided that the above copyright notice appear
  76 in all copies and that both that copyright notice and this permission notice
  77 appear in supporting documentation.  No representations are made about the
  78 suitability of this software for any purpose.  It is provided "as is" without
  79 express or implied warranty.
  80 .SH AUTHOR
  81 Jamie Zawinski <jwz@jwz.org>, 20-Mar-2005.