← Back to branch summary

~shippo/plank/fix-1248689

« back to all changes in this revision

Viewing changes to docs/plank.1

  • Committer: Rico Tzschichholz
  • Date: 2017-02-05 15:00:11 UTC
  • Revision ID: ricotz@ubuntu.com-20170205150011-cs35k8j7filyr3ci
docs: Generate or update manpage with help2man if available

Show diffs side-by-side

added added

removed removed

Lines of Context:
docs/plank.1
1
 
.TH "plank" 1
 
1
.\" DO NOT MODIFY THIS FILE!  It was generated by help2man 1.47.4.
 
2
.TH PLANK "1" "February 2017" "Plank 0.11.3" "User Commands"
2
3
.SH NAME
3
 
Plank \- Stupidly simple.
4
 
.SH SYNOPSIS
5
 
.B plank [\fIoptions\fR]
 
4
Plank - Stupidly simple.
6
5
.SH DESCRIPTION
7
6
Plank is meant to be the simplest dock on the planet. The goal is to provide
8
7
just what a dock needs and absolutely nothing more. It is, however, a library
10
9
Thus, Plank is the underlying technology for Docky (starting in version 3.0.0)
11
10
and aims to provide all the core features while Docky extends it to add fancier
12
11
things like Docklets, painters, settings dialogs, etc.
13
 
.SH OPTIONS
 
12
.SS "Usage:"
 
13
.IP
 
14
plank [OPTION?]
 
15
.SS "Help Options:"
14
16
.TP
15
 
.B \--help
 
17
\fB\-h\fR, \fB\-\-help\fR
16
18
Show help options
17
19
.TP
18
 
.B \-n \--name
19
 
The name of for dock. Defaults to "dock1".
20
 
.TP
21
 
.B \-d \--debug
22
 
Enable debug level logging
23
 
.TP
24
 
.B \-v \--verbose
25
 
Enable verbose level logging
26
 
.TP
27
 
.B \-V \--version
28
 
Show the version
29
 
.TP
30
 
.B \--preferences
 
20
\fB\-\-help\-all\fR
 
21
Show all help options
 
22
.TP
 
23
\fB\-\-help\-gapplication\fR
 
24
Show GApplication options
 
25
.TP
 
26
\fB\-\-help\-gtk\fR
 
27
Show GTK+ Options
 
28
.SS "Application Options:"
 
29
.TP
 
30
\fB\-d\fR, \fB\-\-debug\fR
 
31
Enable debug logging
 
32
.TP
 
33
\fB\-v\fR, \fB\-\-verbose\fR
 
34
Enable verbose logging
 
35
.TP
 
36
\fB\-n\fR, \fB\-\-name\fR
 
37
The name of this dock. Defaults to "dock1".
 
38
.TP
 
39
\fB\-\-preferences\fR
31
40
Show preferences dialog of the just started or already running instance
 
41
.TP
 
42
\fB\-V\fR, \fB\-\-version\fR
 
43
Show the application's version
 
44
.TP
 
45
\fB\-\-display\fR=\fI\,DISPLAY\/\fR
 
46
X display to use
32
47
.SH BUGS
33
48
Report bugs at http://bugs.launchpad.net/plank
34
 
.SH HOMEPAGE and CONTACT
 
49
.SH "HOMEPAGE OR CONTACT"
35
50
For more information, please visit http://launchpad.net/plank/
36
51
.SH AUTHORS
37
 
Rico Tzschichholz, Robert Dyer, Daniel Foré
 
52
Rico Tzschichholz, Robert Dyer, Daniel Fore