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