Merge lp:~bregma/unity/lp-1059275 into lp:unity

Proposed by Stephen M. Webb on 2014-08-09
Status: Merged
Approved by: Christopher Townsend on 2014-09-04
Approved revision: 3853
Merged at revision: 3869
Proposed branch: lp:~bregma/unity/lp-1059275
Merge into: lp:unity
Diff against target: 61 lines (+35/-10)
1 file modified
doc/unity.1 (+35/-10)
To merge this branch: bzr merge lp:~bregma/unity/lp-1059275
Reviewer Review Type Date Requested Status
PS Jenkins bot (community) continuous-integration Approve on 2014-09-04
Christopher Townsend 2014-08-09 Approve on 2014-09-04
Review via email: mp+230204@code.launchpad.net

Commit message

update the unity manpage

Description of the change

Updates the manpage for the unity command. Lists all the currently supported options.

To post a comment you must log in.
PS Jenkins bot (ps-jenkins) wrote :
review: Needs Fixing (continuous-integration)
PS Jenkins bot (ps-jenkins) wrote :
review: Approve (continuous-integration)
Christopher Townsend (townsend) wrote :

Inline comments added. Just some little nitpicks:)

review: Needs Fixing
lp:~bregma/unity/lp-1059275 updated on 2014-09-04
3853. By Stephen M. Webb on 2014-09-04

fixed typo

Christopher Townsend (townsend) wrote :

LGTM

review: Approve
PS Jenkins bot (ps-jenkins) wrote :
review: Approve (continuous-integration)

Preview Diff

[H/L] Next/Prev Comment, [J/K] Next/Prev File, [N/P] Next/Prev Hunk
1=== modified file 'doc/unity.1'
2--- doc/unity.1 2010-12-24 20:05:57 +0000
3+++ doc/unity.1 2014-09-04 12:13:36 +0000
4@@ -1,4 +1,4 @@
5-.TH unity "1" "9 December 2010" "" "Linux User's Manual"
6+.TH unity "1" "09 August 2014" "" "Linux User's Manual"
7
8 .SH NAME
9 unity \- wrapper for starting the unity shell and handling fallback
10@@ -12,17 +12,42 @@
11 The \fBunity\fP program can be used to start the Unity shell as a compiz module, and to specify how to handle logging, debugging, as well as how to deal with the user's profile.
12
13 .SH OPTIONS
14-.IP \fB\-\-advanced\-debug\fP
15-Runs unity under debugging (using GDB or another debugger tool) to help tracking issues. Should only be used on request from a developper following a bug report.
16-
17-.IP \fB\-\-log\fP\ \fIfilename\fP
18+.TP
19+.BR \-\-advanced\-debug
20+Runs unity under debugging (using \fBgdb\fR or another debugger tool) to help tracking issues. Should only be used on request from a developer following a bug report.
21+
22+.TP
23+.BR "-\-compiz-path \fICOMPIZ_PATH\fR"
24+Runs the compositor from a non-standard location.
25+
26+.TP
27+.BR \-\-debug
28+Runs Unity under
29+.B gdb
30+and prints a stack trace on crash.
31+
32+.TP
33+.BR \-h ", " \-\-help
34+Prints a usage message and exits.
35+
36+.TP
37+.BR "\-\-log \fIfilename\fR"
38 This parameter, followed by a path or filename, tells the Unity shell to store logs in the specified file.
39
40-.IP \fB\-\-reset\fP
41-This option allows the user to reset profile parameters in compiz and restart the Unity shell with default settings.
42-
43-.IP \fB\-\-verbose\fP
44-This option turns on displaying additional debugging output for the Unity shell. It can be used by the user to debug configuration issues. This option is often used along with the \fB\-\-log\fP option to save output to a file.
45+.TP
46+.BR \-\-replace
47+Deprecated option for backwards compatibility. Has no effect.
48+
49+.TP
50+.BR \-\-reset\-icons
51+Resets the default Launcher icons.
52+
53+.TP
54+.BR \-v ", " \-\-version
55+Shows the program version number and exits.
56+
57+.TP
58+.BR \-\-verbose
59
60 .SH "SEE ALSO"
61 .B unity-panel-service