Skip to content

Commit

Permalink
Add man page, fixes #518
Browse files Browse the repository at this point in the history
  • Loading branch information
Emdek committed Jan 5, 2015
1 parent 839127a commit 0316647
Show file tree
Hide file tree
Showing 2 changed files with 57 additions and 1 deletion.
3 changes: 2 additions & 1 deletion CMakeLists.txt
Expand Up @@ -235,4 +235,5 @@ install(FILES resources/icons/otter-browser-64.png DESTINATION /usr/share/icons/
install(FILES resources/icons/otter-browser-128.png DESTINATION /usr/share/icons/hicolor/128x128/apps/ RENAME otter-browser.png)
install(FILES resources/icons/otter-browser-256.png DESTINATION /usr/share/icons/hicolor/256x256/apps/ RENAME otter-browser.png)
install(FILES otter-browser.desktop DESTINATION ${XDG_APPS_INSTALL_DIR})
install(TARGETS otter-browser DESTINATION bin)
install(FILES man/otter-browser.1 DESTINATION man/man1/)
install(TARGETS otter-browser DESTINATION bin/)
55 changes: 55 additions & 0 deletions man/otter-browser.1
@@ -0,0 +1,55 @@
.TH OTTER-BROWSER 1 "January 2015" "" "USER COMMANDS"
.SH NAME
otter-browser \- the web browser controlled by the user, not vice-versa
.SH SYNOPSIS
.B otter-browser
[\fIOPTIONS\fR] [\fIPATH\fR|\fIURL\fR|\fITERM\fR...]
.SH DESCRIPTION
See the Otter Browser wiki for help on using the browser:
.IP
<https://github.com/Emdek/otter/wiki/>
.SH OPTIONS
.TP
\fB\-\-profile\fR=\fIPATH\fR
Specifies the directory that profile (user data) is kept in.
Defaults to \fI~/.config/otter\fR.
.TP
\fB\-\-cache\fR=\fIPATH\fR
Specifies the directory that cache data is kept in.
Defaults to \fI~/.cache/otter\fR.
.TP
\fB\-\-session\fR=\fIIDENTIFIER\fR
Tries to load session specified by \fIIDENTIFIER\fR.
.TP
\fB\-\-privatesession\fR
Starts private session.
.TP
\fB\-\-portable\fR
Sets profile and cache paths to directories inside
the same directory as that of application binary.
.TP
\fB\-h\fR, \fB\-\-help\fR
Show list of supported command line options.
.TP
\fB\-v\fR, \fB\-\-version\fR
Show version information.
.PP
As a Qt application, Otter also obeys Qt command-line flags, see the Qt
documentation for complete list:
.IP
<http://doc.qt.io/qt-5/qguiapplication.html#QGuiApplication>
.SH FILES
.TP
.I ~/.config/otter
Default directory for configuration data.
.TP
.I ~/.cache/otter
Default directory for cache data.
.SH BUGS
Bug tracker:
.IP
https://github.com/Emdek/otter/issues
.PP
Be sure to do your search within open and closed issues before submitting reports.
.SH AUTHOR
The Otter Browser team \- <http://otter-browser.org>

0 comments on commit 0316647

Please sign in to comment.