doc/logjam.1

   1 .\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.3
   2 .\"
   3 .\" Standard preamble:
   4 .\" ========================================================================
   5 .de Sh \" Subsection heading
   6 .br
   7 .if t .Sp
   8 .ne 5
   9 .PP
  10 \fB\\$1\fR
  11 .PP
  12 ..
  13 .de Sp \" Vertical space (when we can't use .PP)
  14 .if t .sp .5v
  15 .if n .sp
  16 ..
  17 .de Vb \" Begin verbatim text
  18 .ft CW
  19 .nf
  20 .ne \\$1
  21 ..
  22 .de Ve \" End verbatim text
  23 .ft R
  24 .fi
  25 ..
  26 .\" Set up some character translations and predefined strings.  \*(-- will
  27 .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
  28 .\" double quote, and \*(R" will give a right double quote.  | will give a
  29 .\" real vertical bar.  \*(C+ will give a nicer C++.  Capital omega is used to
  30 .\" do unbreakable dashes and therefore won't be available.  \*(C` and \*(C'
  31 .\" expand to `' in nroff, nothing in troff, for use with C<>.
  32 .tr \(*W-|\(bv\*(Tr
  33 .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
  34 .ie n \{\
  35 .    ds -- \(*W-
  36 .    ds PI pi
  37 .    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
  38 .    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
  39 .    ds L" ""
  40 .    ds R" ""
  41 .    ds C` ""
  42 .    ds C' ""
  43 'br\}
  44 .el\{\
  45 .    ds -- \|\(em\|
  46 .    ds PI \(*p
  47 .    ds L" ``
  48 .    ds R" ''
  49 'br\}
  50 .\"
  51 .\" If the F register is turned on, we'll generate index entries on stderr for
  52 .\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index
  53 .\" entries marked with X<> in POD.  Of course, you'll have to process the
  54 .\" output yourself in some meaningful fashion.
  55 .if \nF \{\
  56 .    de IX
  57 .    tm Index:\\$1\t\\n%\t"\\$2"
  58 ..
  59 .    nr % 0
  60 .    rr F
  61 .\}
  62 .\"
  63 .\" For nroff, turn off justification.  Always turn off hyphenation; it makes
  64 .\" way too many mistakes in technical documents.
  65 .hy 0
  66 .if n .na
  67 .\"
  68 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
  69 .\" Fear.  Run.  Save yourself.  No user-serviceable parts.
  70 .    \" fudge factors for nroff and troff
  71 .if n \{\
  72 .    ds #H 0
  73 .    ds #V .8m
  74 .    ds #F .3m
  75 .    ds #[ \f1
  76 .    ds #] \fP
  77 .\}
  78 .if t \{\
  79 .    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
  80 .    ds #V .6m
  81 .    ds #F 0
  82 .    ds #[ \&
  83 .    ds #] \&
  84 .\}
  85 .    \" simple accents for nroff and troff
  86 .if n \{\
  87 .    ds ' \&
  88 .    ds ` \&
  89 .    ds ^ \&
  90 .    ds , \&
  91 .    ds ~ ~
  92 .    ds /
  93 .\}
  94 .if t \{\
  95 .    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
  96 .    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
  97 .    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
  98 .    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
  99 .    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
 100 .    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
 101 .\}
 102 .    \" troff and (daisy-wheel) nroff accents
 103 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
 104 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
 105 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
 106 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
 107 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
 108 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
 109 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
 110 .ds ae a\h'-(\w'a'u*4/10)'e
 111 .ds Ae A\h'-(\w'A'u*4/10)'E
 112 .    \" corrections for vroff
 113 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
 114 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
 115 .    \" for low resolution devices (crt and lpr)
 116 .if \n(.H>23 .if \n(.V>19 \
 117 \{\
 118 .    ds : e
 119 .    ds 8 ss
 120 .    ds o a
 121 .    ds d- d\h'-1'\(ga
 122 .    ds D- D\h'-1'\(hy
 123 .    ds th \o'bp'
 124 .    ds Th \o'LP'
 125 .    ds ae ae
 126 .    ds Ae AE
 127 .\}
 128 .rm #[ #] #H #V #F C
 129 .\" ========================================================================
 130 .\"
 131 .IX Title "logjam 1"
 132 .TH logjam 1 "2003-04-25" "4.1.1" "LiveJournal"
 133 .SH "NAME"
 134 logjam \- GTK+ client for LiveJournal
 135 .SH "SYNOPSIS"
 136 .IX Header "SYNOPSIS"
 137 \&\fBlogjam\fR [\fI\s-1OPTIONS\s0\fR] [\fI\s-1FILE\s0\fR]
 138 .SH "DESCRIPTION"
 139 .IX Header "DESCRIPTION"
 140 \&\fBlogjam\fR is a \s-1GTK+\s0 client for LiveJournal-based sites
 141 such as livejournal.com.
 142 .PP
 143 Aside from writing entries, logjam lets you modify your
 144 friends list, edit your previous entries, and more.
 145 .PP
 146 When run with no arguments (or just username option),
 147 logjam will run in the \s-1GUI\s0 mode.
 148 The user interface is mostly self\-explanatory, and won't be
 149 discussed here in detail, except for a few notes below.
 150 .SH "OPTIONS AND COMMANDS"
 151 .IX Header "OPTIONS AND COMMANDS"
 152 Options can be given in either short or long forms. For help on a
 153 particular commands, type "\fBlogjam\fR \s-1COMMAND\s0 help\*(L". For example,
 154 \&\*(R"\fBlogjam\fR grep help" will supply help about the grep command.
 155 .Sp
 156 .RS 4
 157 Options:
 158   \fB\-v\fR, \fB\-\-version\fR
 159     Show version of program.
 160   \fB\-q\fR, \fB\-\-quiet\fR
 161     Say less.
 162
 163   \fB\-u\fR, \fB\-\-username\fR=\fI\s-1USERNAME\s0\fR
 164     Username to operate as.
 165   \fB\-p\fR, \fB\-\-password\fR=\fI\s-1PASSWORD\s0\fR
 166     Password for the current user.
 167   \fB\-a\fR, \fB\-\-postas\fR=\fI\s-1USERNAME\s0\fR
 168     User/community to post as.
 169
 170   \fB\-f\fR, \fB\-\-file\fR=\fI\s-1FILE\s0\fR
 171     File to load.
 172   \fB\-e\fR, \fB\-\-edit\fR
 173     Use default editor to edit post.
 174 .Sp
 175 Subcommands:
 176   \fBcheckfriends\fR  Efficiently check friends list for updates.
 177   \fBconsole\fR       Run a command on the LiveJournal console.
 178   \fBpost\fR          Post event immediately.
 179   \fBoffline\fR       Manage offline copies of your journal.
 180   \fBuser\fR          Manage user list.
 181 .RE
 182 .PP
 183 Also, \s-1GTK+\s0 command line options (such as \-\-display) can be used.
 184 .SH "GUI"
 185 .IX Header "GUI"
 186 This section describes some of the \s-1GUI\s0 features that aren't immediately
 187 apparent.
 188 .Sh "Check Friends"
 189 .IX Subsection "Check Friends"
 190 logjam can monitor your friends list and notify you when new entries
 191 are posted there. Enable this by right-clicking on the indicator at
 192 the bottom-left corner of the application window and selecting the
 193 appropriate menu item. You may also configure logjam to start doing this
 194 automatically for you when you login. When new entries are detected, the
 195 indicator will turn red to let you know; click it to resume monitoring or
 196 double-click it to open your browser on your friends page. Optionally,
 197 you can have logjam open a small \*(L"floating\*(R" indicator which has some
 198 useful \s-1GUI\s0 settings of its own.
 199 .PP
 200 Owners of large friends lists may prefer to be notified only after they
 201 accumulate several new posts. You may set the threshold for this in the
 202 Check Friends settings tab. The default is 1, that is, logjam will tell
 203 you immediately when it detects new traffic on your friends page. There
 204 is a small limit on the maximum threshold allowed, because this feature
 205 is only useful with small threshold values.
 206 .SH "STARTUP"
 207 .IX Header "STARTUP"
 208 When given a \fI\s-1FILE\s0\fR argument, logjam will start up with an existing
 209 file as the base for the composed entry. If the filename given is \*(L"\-\*(R",
 210 the data will be read from standard input. Several aspects of the entry,
 211 such as its subject field and the journal in which to post it to, can
 212 be controlled by other options. This is useful in conjunction with the
 213 \&\fB\-\-commandline\fR option, which causes logjam to post an entry without
 214 going to \s-1GUI\s0 mode, allowing completely non-interactive posts. If you do
 215 wish to interactively edit the entry, but don't want to load the \s-1GUI\s0,
 216 use the \fB\-\-edit\fR option.
 217 .Sh "Autosave"
 218 .IX Subsection "Autosave"
 219 logjam will periodically save a draft of your currently edited entry
 220 in ~/.logjam/draft if you turn on the draft option in the Preferences
 221 dialog. This feature is intended for crash recovery, not archiving. If
 222 you want to keep a copy of your posts, you should use the
 223 Entry\ >\ Save\ As menu option before submitting them. A future
 224 version of logjam will support archiving of your journal.
 225 .PP
 226 Please note that when you exit the client normally, your draft is
 227 cleared. It does not \*(L"stick\*(R" for the next invocation, as in the behavior
 228 of some other clients.
 229 .Sh "Checking friends from the command line"
 230 .IX Subsection "Checking friends from the command line"
 231 You can use logjam as a backend for a script or another application
 232 that wishes to check the friends view. This may be useful if you
 233 don't want to use the \s-1GUI\s0, or if you have several journals (in
 234 conjunction with \fB\-\-username\fR). To do this, invoke logjam once with
 235 \&\fB\-\-checkfriends=purge\fR (\fB\-rpurge\fR if you're using short options),
 236 and then something like:
 237 .PP
 238 .Vb 1
 239 \&        logjam \-\-checkfriends && new\-entries\-handler
 240 .Ve
 241 .PP
 242 Make sure that your script or application purges the checkfriends
 243 status as described above once the user has acknowledged the new items,
 244 otherwise logjam will always report there's nothing new.  You should also
 245 pay attention to limiting your query rate, despite the fact that logjam
 246 will refuse to flood the server with queries.  For more information,
 247 see the messages on the command line. (To suppress these messages,
 248 use \fB\-\-quiet\fR.)
 249 .SH "SEE ALSO"
 250 .IX Header "SEE ALSO"
 251 <http://logjam.danga.com>
 252 .PP
 253 <http://www.livejournal.com/users/logjam/>
 254 .PP
 255 <http://www.livejournal.com>
 256 .SH "AUTHOR"
 257 .IX Header "AUTHOR"
 258 This manual page was mostly written by Gaal Yahas <gaal@forum2.org>.