summaryrefslogtreecommitdiffstats
path: root/docs/manpages
diff options
context:
space:
mode:
Diffstat (limited to 'docs/manpages')
-rw-r--r--docs/manpages/kodi-TexturePacker.124
-rw-r--r--docs/manpages/kodi-ps3remote.116
-rw-r--r--docs/manpages/kodi-send.126
-rw-r--r--docs/manpages/kodi-standalone.16
-rw-r--r--docs/manpages/kodi-wiiremote.135
-rw-r--r--docs/manpages/kodi.11
-rw-r--r--docs/manpages/kodi.bin.133
7 files changed, 141 insertions, 0 deletions
diff --git a/docs/manpages/kodi-TexturePacker.1 b/docs/manpages/kodi-TexturePacker.1
new file mode 100644
index 0000000..553625b
--- /dev/null
+++ b/docs/manpages/kodi-TexturePacker.1
@@ -0,0 +1,24 @@
+.TH TexturePacker 1
+.SH NAME
+TexturePacker \- Compile all images used in a XBMC / Kodi skin into a single file
+.SH SYNOPSIS
+.B TexturePacker
+[\fB\-dupecheck\fR]
+[\fB\-\-input\fR \fIDIRECTORY\fR]
+[\fB\-\-output\fR \fIFILE.xbt\fR]
+.SH DESCRIPTION
+Kodi uses a tool named TexturePacker to compile all images used in a skin into a single file. The benefit of it is that images inside the Textures.xbt will load faster in the skin. This is done by converting all images into a format that take less processing by Kodi when they need to be rendered onto the screen.
+
+A common misconception is that TexturPacker will just compress the images into a single file. This if far from the truth, so don't be surprised if the Textures.xbt file is much larger than the total size of all the individual images.
+
+The optional -dupecheck option is useful if you have included the same image multiple times in your media folder. For example, if your skin includes a lot of studio logos, most likely a lot of them are included multiple times but with a slightly different filename. The '-dupecheck' option will make sure each unique image is included only once in the Textures.xbt file, thus keeping the size of it as small as possible.
+.SH OPTIONS
+.TP
+.BR \-dupecheck
+Check for image duplicates first
+.TP
+.BR \-input
+fully-qualified name of input directory with images
+.TP
+.BR \-output
+fully-qualified name of resulting compressed XBT file
diff --git a/docs/manpages/kodi-ps3remote.1 b/docs/manpages/kodi-ps3remote.1
new file mode 100644
index 0000000..3b6e6fc
--- /dev/null
+++ b/docs/manpages/kodi-ps3remote.1
@@ -0,0 +1,16 @@
+.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.36.
+.TH KODI-PS3REMOTE "1" "October 2014" "kodi-ps3remote " "User Commands"
+.SH NAME
+kodi-ps3remote \- PS3 Blu\-Ray Remote Control Client for Kodi
+.SH DESCRIPTION
+This script is the Kodi remote control client that will allow Kodi to be
+controlled by a PS3 Blu-Ray Remote.
+.SH USAGE
+Usage for kodi-ps3remote
+.SS "Arguments:"
+.TP
+\fB\-\-address\fR ADDRESS
+(default: localhost)
+.TP
+\fB\-\-port\fR PORT
+(default: 9777)
diff --git a/docs/manpages/kodi-send.1 b/docs/manpages/kodi-send.1
new file mode 100644
index 0000000..03ca685
--- /dev/null
+++ b/docs/manpages/kodi-send.1
@@ -0,0 +1,26 @@
+.TH KODI-SEND "1" "October 2014" "kodi-send"
+.SH NAME
+xbmc\-send \- program to send some action to Kodi
+.SH SYNOPSIS
+xbmc\-send [OPTION] \fB\-\-action\fR=\fIACTION\fR
+.SH DESCRIPTION
+This program is used for sending actions for Kodi.
+.PP
+Example
+.IP
+kodi\-send \fB\-\-host\fR=\fI192\fR.168.0.1 \fB\-\-port\fR=\fI9777\fR \fB\-\-action=\fR"Quit"
+.PP
+Options
+.TP
+\-?, \fB\-\-help\fR
+Display help message
+.TP
+\fB\-\-host\fR=\fIHOST\fR
+Choose what HOST to connect to (default=localhost)
+.TP
+\fB\-\-port\fR=\fIPORT\fR
+Choose what PORT to connect to (default=9777)
+.TP
+\fB\-\-action\fR=\fIACTION\fR
+Sends an action to Kodi, this option can be added multiple times to create a macro.
+
diff --git a/docs/manpages/kodi-standalone.1 b/docs/manpages/kodi-standalone.1
new file mode 100644
index 0000000..54e2fc0
--- /dev/null
+++ b/docs/manpages/kodi-standalone.1
@@ -0,0 +1,6 @@
+.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.36.
+.TH KODI-STANDALONE "1" "October 2014" "kodi-standalone " "User Commands"
+.SH NAME
+kodi-standalone \- Kodi standalone mode
+.SH DESCRIPTION
+This script runs Kodi in standalone mode.
diff --git a/docs/manpages/kodi-wiiremote.1 b/docs/manpages/kodi-wiiremote.1
new file mode 100644
index 0000000..b947c93
--- /dev/null
+++ b/docs/manpages/kodi-wiiremote.1
@@ -0,0 +1,35 @@
+.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.36.
+.TH KODI-WIIREMOTE "1" "October 2014" "kodi-wiiremote " "User Commands"
+.SH NAME
+kodi-wiiremote \- Wiimote Remote Control Client for Kodi
+.SH DESCRIPTION
+This script is the Kodi remote control client that will allow Kodi to be
+controlled by a Wiimote.
+.SS "Arguments:"
+.HP
+\fB\-\-disable\-mouseemulation\fR
+.HP
+\fB\-\-disable\-reconnect\fR
+.HP
+\fB\-\-disable\-nunchuck\fR
+.HP
+\fB\-\-address\fR ADDRESS
+.HP
+\fB\-\-port\fR PORT
+.HP
+\fB\-\-btaddr\fR MACADDRESS
+.TP
+\fB\-\-deadzone\-x\fR DEADX
+| Number between 0 \- 100 (Default: 50)
+.TP
+\fB\-\-deadzone\-y\fR DEADY
+| Number between 0 \- 100 (Default: 30)
+.TP
+\fB\-\-deadzone\fR DEAD
+| Sets both X and Y too the number
+.TP
+\fB\-\-smoothing\-samples\fR SAMPLE
+| Number 1 counts as Off (Default: 16)
+.TP
+\fB\-\-joystick\-map\fR JOYMAP
+| The string ID for the joymap (Default: WiiRemote)
diff --git a/docs/manpages/kodi.1 b/docs/manpages/kodi.1
new file mode 100644
index 0000000..5f55c7a
--- /dev/null
+++ b/docs/manpages/kodi.1
@@ -0,0 +1 @@
+.so man1/kodi.bin.1
diff --git a/docs/manpages/kodi.bin.1 b/docs/manpages/kodi.bin.1
new file mode 100644
index 0000000..35c8702
--- /dev/null
+++ b/docs/manpages/kodi.bin.1
@@ -0,0 +1,33 @@
+.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.36.
+.TH KODI.BIN "1" "October 2014" "kodi.bin " "User Commands"
+.SH NAME
+kodi.bin \- Kodi main executable
+.SH SYNOPSIS
+.B kodi.bin
+[\fIOPTION\fR]... [\fIFILE\fR]...
+.SH DESCRIPTION
+This is the main executable that will run Kodi.
+.SS "Arguments:"
+.TP
+\fB\-fs\fR
+Runs Kodi in full screen
+.TP
+\fB\-\-standalone\fR
+Kodi runs in a stand alone environment without a window
+manager and supporting applications. For example, that
+enables network settings.
+.TP
+\fB\-p\fR or \fB\-\-portable\fR
+Kodi will look for configurations in install folder instead of ~/.kodi
+.TP
+\fB\-\-version\fR
+Print version information.
+.TP
+\fB\-\-test\fR [\fIFILE\fR]
+Enable test mode. \fIFILE\fR must be readable.
+.TP
+\fB\-\-settings=\fR<\fIfilename\fR>
+Loads specified file after advancedsettings.xml replacing any settings specified. The \fIfilename\fR must exist in special://xbmc/system/.
+.TP
+\fB\-\-windowing=\fR<\fIsystem\fR>
+Select which windowing method to use. Available window systems are: x11 wayland gbm