summaryrefslogtreecommitdiff
path: root/README.markdown
diff options
context:
space:
mode:
Diffstat (limited to 'README.markdown')
-rw-r--r--README.markdown10
1 files changed, 9 insertions, 1 deletions
diff --git a/README.markdown b/README.markdown
index 74f1feb..065645d 100644
--- a/README.markdown
+++ b/README.markdown
@@ -9,7 +9,7 @@ A simple start page with a background image from [/r/EarthPorn](http://www.reddi
## Configuration
-The startpage configuration is located in the file ~/.startpagerc. It is a list of commands. A command has a name and can optionally have parameters separated by spaces or tabs. A backspace `\\` will interpret the next charcter literally (can be used to escape whitespace, linebreaks and backspaces). Commands are separated by newlines.
+The startpage configuration is located in the file ~/.startpagerc. It is a list of commands. A command has a name and can optionally have parameters separated by spaces or tabs. A backspace `\` will interpret the next charcter literally (can be used to escape whitespace, linebreaks and backspaces). Commands are separated by newlines.
These commands are implemented:
@@ -38,6 +38,14 @@ Example:
set-earthporn-savepath /home/foobar/Pictures/earthporn
+### `set-maxdim`
+
+Sets the maximum width/height of an EarthPorn image. If the image is larger, it will be resized for the background (it will be saved in it's original size).
+
+Example:
+
+ set-maxdim 4000
+
## Running
If `$GOPATH/bin` is in your `$PATH`, you can run startpage with the command `startpage`. By default, startpage listens on port 25145. You can change that with a command line switch: `startpage -laddr :<port>` \ No newline at end of file