contrib/man/conkeror.1

   1 .\" This man page was created following the guidelines in GROFF_MDOC(7).
   2 .Dd $Mdocdate: Novermber 3, 2013 $
   3 .Dt CONKEROR 1
   4 .Os
   5 .Sh NAME
   6 .Nm Conkeror
   7 .Nd a keyboard-oriented, highly-customizable web browser
   8 .Sh SYNOPSIS
   9 .Nm conkeror
  10 .Op Ar options ...
  11 .Op Ar url
  12 .Sh DESCRIPTION
  13 .Nm
  14 is a keyboard-oriented, highly-customizable, highly-extensible web browser based
  15 on Mozilla XULRunner, written mainly in JavaScript, and inspired by Emacs and
  16 vi.
  17 .Nm
  18 features a sophisticated keyboard system, allowing users to run
  19 commands and interact with content in powerful and novel ways. It is
  20 self-documenting, featuring a powerful interactive help system.
  21 .Pp
  22 The primary documentation is the inline manual.  To read the manual use the key
  23 combination C-h i (CTRL-h i).  The manual includes a tutorial for new users that
  24 can be accessed directly with C-h t (CTRL-h t).  The
  25 .Nm
  26 wiki, found at
  27 http://conkeror.org, is another resource.
  28 .Sh OPTIONS
  29 .Nm
  30 has the same options as all other XULRunner applications plus a few more.
  31 .Pp
  32 X11 options
  33 .Bl -tag -width indent
  34 .It \fB\-\-display=DISPLAY\fR
  35 X display to use
  36 .It \fB\-\-sync\fR
  37 Make X calls synchronous
  38 .It \fB\-\-g\-fatal\-warnings\fR
  39 Make all warnings fatal
  40 .El
  41 .Bl -tag -width indent
  42 .Pp
  43 .Nm
  44 options
  45 .It \fB\-h\fR or \fB\-help\fR
  46 Print this message
  47 .It \fB\-v\fR or \fB\-version\fR
  48 Print conkeror version
  49 .It \fB\-P <profile>\fR
  50 Start with <profile>
  51 .It \fB\-migration\fR
  52 Start with migration wizard
  53 .It \fB\-ProfileManager\fR
  54 Start with ProfileManager
  55 .It \fB\-no\-remote\fR
  56 Do not accept or send remote commands; implies \-new\-instance
  57 .It \fB\-new\-instance\fR
  58 Open new instance, not a new window in running instance
  59 .It \fB\-UILocale <locale>\fR
  60 Start with <locale> resources as UI Locale
  61 .It \fB\-safe\-mode\fR
  62 Disables extensions and themes for this session
  63 .It \fB\-jsconsole\fR
  64 Open the Error console
  65 .It \fB-recording <file>\fR
  66 Record drawing for a given URL
  67 .It \fB\-recording\-output <file>\fR
  68 Specify destination file for a drawing recording
  69 .El
  70 .Sh KNOWN BUGS
  71 See http://bugs.conkeror.org/.
  72 .Sh FILES
  73 The default location of the user configuration file is \fI$HOME/.conkerorrc\fP.
  74 .Pp
  75 This can be changed by setting the preference \fBconkeror.rcfile\fP. The rc can
  76 be an ordinary file or a directory. If it is an ordinary file,
  77 .Nm
  78 will evaluate that file as javascript. If it is a directory,
  79 .Nm
  80 will evaluate all files in that directory that have the \fI.js\fP file
  81 extension.  See \fIhttp://conkeror.org/ConkerorRC\fP for the details.
  82 .Sh SEE ALSO
  83 The
  84 .Nm
  85 manual (C-h i), tutorial (C-h t) and wiki (http://conkeror.org).
  86 .Sh AUTHORS
  87 .Nm
  88 was written by Shawn Betts, John J. Foerch, Jeremy Maitin-Shepard and
  89 others. See the \fBCREDITS\fP file included with
  90 .Nm
  91 for a full list of contributors.
  92 .Pp
  93 The
  94 .Nm
  95 manual page was originally written by Axel Beckert <abe@deuxchevaux.org>
  96 and updated by Joseph Mingrone <jrm@ftfl.ca>.