.\" Man page generated from reStructuredText. . .TH JSCRIBBLE 1 "2012-04-01" "" "" .SH NAME jscribble \- infinite notepad written in Java . .nr rst2man-indent-level 0 . .de1 rstReportMargin \\$1 \\n[an-margin] level \\n[rst2man-indent-level] level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] - \\n[rst2man-indent0] \\n[rst2man-indent1] \\n[rst2man-indent2] .. .de1 INDENT .\" .rstReportMargin pre: . RS \\$1 . nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin] . nr rst2man-indent-level +1 .\" .rstReportMargin post: .. .de UNINDENT . RE .\" indent \\n[an-margin] .\" old: \\n[rst2man-indent\\n[rst2man-indent-level]] .nr rst2man-indent-level -1 .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] .in \\n[rst2man-indent\\n[rst2man-indent-level]]u .. .\" Copyright © 2011-2012 Martin Ueding . .SH SYNOPSIS .sp \fBjscribble [options]\fP .sp \fBjava \-jar jscribble.jar [options]\fP .sp \fBjavaws http://martin\-ueding.de/download/jscribble/jscribble.jnlp\fP .SH DESCRIPTION .sp jscribble is a graphical notepad with as many pages as you want. You can organize your notes within notepads. Best used with a graphics tablet or touchscreen. .sp You can organize your notes into notebooks, which allow you to have several collections of notesheets. At startup, you can select which notepad you want to use. If you do not want to save your notes, you can go into the \fIscribble\fP mode. All notes that you take there, will be thrown away when you close the program—without any sheet of paper wasted. .sp Taking notes on paper allows you to draw and write whatever you want. Some people are fast enough in LaTeX to set complicated formulas while in a lecture. Some prefer to draw these by hand but do not like carrying lots of paper with them. .sp jscribble offers screen based note taking with as many pages as you want. Xournal offers more features but is paper size oriented which does not make sense on a 10" netbook screen where one wants to use the whole screen for taking notes. .sp Another focus was set to avoid any mouse navigation. All you can do with your mouse (or pen) is draw, therefore you cannot click anything accidentally. Navigation is done with the keyboard. This stance is weakened a little now, there is a mouse only mode which features panels at the left and right side of the screen to flip pages. You can also advance to the next page using the middle click. Both of these options have to be enabled in the configuration file, though. .sp The eraser was implemented later too, it can be disabled in the config if it causes trouble. It is activated by default since it is very handy. .sp You need the Java Runtime Environment (JRE) to run jscribble. .SH OPTIONS .INDENT 0.0 .TP .B \fB\-v\fP Verbose Mode. .TP .B \fB\-\-key value\fP Allows one to overwrite any config key in the default config and the user config. See below for a list of all available config keys .UNINDENT .SH DEFAULT CONTROLS .sp To flip between the pages, you can use the arrows keys, space bar, enter and backspace. .sp When the primary mouse button is pressed, a line is drawn, the secondary mouse button erases. .sp All controls are displayed in the online help screen activated by \fBh\fP or \fBF1\fP. .SH FILES .sp jscribble uses plain PNG images to store your drawings. They are, by default, in the \fB~/.local/share/jscribble\fP directory. On Windows, that is somewhere in the \fBC:\eDocuments & Settings\fP or \fBC:\eUsers\fP directory. .sp The notebooks are plain folders, each containing a heap of images. The folder name corresponds to the notebook name. To avoid strange names, the notebook name is restricted to very few characters by default. .sp The images are numbered, zero padded to 6 digits. The program uses \fB%06d.png\fP to format the number. In case you have more images, the file name will get longer. .INDENT 0.0 .INDENT 3.5 .sp .nf .ft C ~/.jscribble/test_notebook/ 000001.png 000002.png ... 000100.png ... 999999.png 1000000.png ... .ft P .fi .UNINDENT .UNINDENT .sp You can delete images from the folder, the program will still find them. You will get something like \fBPage 15/13\fP if you delete two images in front of the gast one. .sp There is a configuration option that will tell jscribble to automatically compress the file names, that is to renumber them so that they are consecutive. .SS Config File .sp jscribble supports a user config file that overrides values from the default config file. .sp Create a file called \fBconfig.properties\fP in the \fB.config/jscribble\fP directory in your home directory. Then insert key\-value pairs with an equal sign in each line. .sp The format is the standard Java Properties format. .SS Value Types .INDENT 0.0 .TP .B \fBString\fP A string which will get parsed in some way. .TP .B \fBInteger\fP A number, often sizes measured in pixels. .TP .B \fBColor\fP A hexadecimal color with optional alpha part in the front, RRGGBB or AARRGGBB. .TP .B \fBFloat\fP A decimal number. .TP .B \fBKeyboard Char or Code\fP A comma separated list of key key codes and key chars. A single character will be interpreted as a literal character on the keyboard, multiple characters will be interpreted as a key code number. .TP .B \fBMouse Mask\fP A comma separated list of mouse down masks. .TP .B \fBBoolean\fP \fBtrue\fP or \fBfalse\fP. .UNINDENT .SS Example Config .INDENT 0.0 .INDENT 3.5 .sp .nf .ft C memory_usage_show=true rule_line_spacing=20 .ft P .fi .UNINDENT .UNINDENT .SS Available Keys .sp The type is given in brackets, the default value in parentheses. .INDENT 0.0 .TP .B \fBdate_format\fP Date format used for logging. [String] (yyyy\-MM\-dd HH:mm:ss) .TP .B \fBhelp_screen_background_color\fP Background color of the online help screen. This is a translucent black currently. [Color] (C8000000) .TP .B \fBhelp_screen_border_radius\fP Border radius on the backdrop of the online help screen. [Integer] (20) .TP .B \fBhelp_screen_close_key\fP Closes the online help screen. [Key] (27) .TP .B \fBhelp_screen_margin\fP Margin outside the backdrop. [Integer] (50) .TP .B \fBhelp_screen_padding\fP Padding inside the backdrop. [Integer] (70) .TP .B \fBhelp_screen_spacing\fP Spacing between left and right column of the help screen. [Integer] (250) .TP .B \fBhelp_screen_toggle_key\fP Toggles the online help screen. [Key] (h,112) .TP .B \fBhelp_screen_vspacing\fP Spacing between the rows of the help screen. [Integer] (30) .TP .B \fBhelp_splash_background_color\fP Color of the help splash. This is a very translucent black currently. [Color] (64000000) .TP .B \fBhelp_splash_border_radius\fP Corner radius of the help splash screen. [Integer] (20) .TP .B \fBhelp_splash_enable\fP Enables the help splash at startup. [Boolean] (true) .TP .B \fBhelp_splash_height\fP Height of the help splash box. [Integer] (50) .TP .B \fBhelp_splash_margin\fP Margin around the help splash. [Integer] (15) .TP .B \fBmemory_usage_position_bottom\fP Distance of the memory usage from the bottom. [Integer] (10) .TP .B \fBmemory_usage_position_left\fP Distance of the memory usage from the left. [Integer] (10) .TP .B \fBmemory_usage_show\fP Enables the memory usage display. [Boolean] (false) .TP .B \fBnotebook_auto_compress\fP Enables automatic renaming of files. [Boolean] (false) .TP .B \fBnotebook_background_color\fP Color of the paper. [Color] (FFFFFF) .TP .B \fBnotebook_cache_width\fP Number of notesheets that are to be cached when moving back and forward in the notebook. [Integer] (10) .TP .B \fBnotebook_close_key\fP Closes the current notebook. [Key] (q) .TP .B \fBnotebook_default_height\fP Height of new notebooks if the user does not use his native resolution. [Integer] (600) .TP .B \fBnotebook_default_width\fP Width of new notebooks if the user does not use his native resolution [Integer] (1024) .TP .B \fBnotebook_draw_mouse_button\fP Mouse button to use for drawing. [Mouse] (0,1024) .TP .B \fBnotebook_draw_stroke_width\fP Width of the pen. [Integer] (1) .TP .B \fBnotebook_erase_enable\fP Enables the eraser. [Boolean] (true) .TP .B \fBnotebook_erase_mouse_button\fP Mouse button to use for erasing. [Mouse] (256,4096) .TP .B \fBnotebook_erase_stroke_width\fP Width of the eraser. It should be way larger than the pen to make erasing easy. [Integer] (8) .TP .B \fBnotebook_erase_timeout\fP Time in milliseconds to wait after last erasing to repaint the onion layers and ruling. [Integer] (100) .TP .B \fBnotebook_foreground_color\fP Color of the pen. [Color] (000000) .TP .B \fBnotebook_go_back_key\fP Key to go back a page. [Key] (k,38,37,08) .TP .B \fBnotebook_go_back_mouse_button\fP Mouse button to go back a page. [Mouse] () .TP .B \fBnotebook_go_forward_key\fP Key to go forward a page. [Key] (j,40,39,32,10) .TP .B \fBnotebook_go_forward_mouse_button\fP Mouse button to go forward a page. [Mouse] () .TP .B \fBnotebook_goto_first_key\fP Key to go to first page. [Key] (f,36) .TP .B \fBnotebook_goto_last_key\fP Key to go to last page. [Key] (l,35) .TP .B \fBnotebook_name_validation_pattern\fP The name of every new notebook is validated against this. This prevents anything cumbersome in file names. [String] ([A\-Za\-z0\-9\-_]+) .TP .B \fBnotebook_selection_window_height\fP Height of the initial selection window. [Integer] (300) .TP .B \fBnotebook_selection_window_width\fP Width of the initial selection window. [Integer] (400) .TP .B \fBonion_info_position_left\fP Position of the onion layer info from the left. [Integer] (10) .TP .B \fBonion_info_position_top\fP Position of the onion layer info from the top. [Integer] (15) .TP .B \fBonion_layer_decrease_key\fP Removes one onion layer. [Key] (\-) .TP .B \fBonion_layer_increase_key\fP Adds one onion layer. [Key] (+) .TP .B \fBonion_mode_opacity\fP Opacity of the individual onion layers. If this is set high, one can see the other layers pretty well, if one sets it low, a better separation is achieved. [Float] (0.8) .TP .B \fBpage_number_position_top\fP Position of the page number from the top. [Integer] (15) .TP .B \fBprogram_name\fP The name is used for the settings directory. If this is changed, all previously made notebooks are still on the disk, but cannot be accessed through the program any more. [String] (jscribble) .TP .B \fBruling_graph_toggle_key\fP Key to toggle graph ruling. [Key] (g) .TP .B \fBruling_line_color\fP Color of the ruling. It is drawn with the same opaqueness as the onion layers. [Color] (646464) .TP .B \fBruling_line_spacing\fP Spacing between the lines or squares. [Integer] (40) .TP .B \fBruling_toggle_key\fP Key to toggle line ruling. [Key] (r) .TP .B \fBscroll_panel_color\fP Color of the mouse only mode scroll panels. [Color] (64000000) .TP .B \fBscroll_panel_padding\fP Padding top and bottom of the scroll panels. [Integer] (5) .TP .B \fBscroll_panel_width\fP Width of the scroll panels. [Integer] (20) .TP .B \fBscroll_panels_show\fP Enables panels at the side of the screen to navigate without a keyboard. Useful for tablet computers. [Boolean] (false) .TP .B \fBuser_config_filename\fP It does not make much sense to overwrite this since this property is always looked up in the default config. [String] (config.properties) .UNINDENT .SH SECURITY CONSIDERATIONS .sp Named notebooks are saved in a folder in the user\(aqs home directory. Notebooks that are in the scribble mode are not saved to the user\(aqs home directory but in the temporary directory of the system. On Linux, this is usually \fB/tmp\fP. The files are not readable to anyone but the user. .sp If the user\(aqs home directory is encrypted, but the temporary folder is not, an attacker might be able to recover images drawn in the scribble mode. .SH BUGS .sp Please report bugs in English or German via email to me. Include the version number which is displayed at the bottom of the help screen within the program. .SH SEE ALSO .sp \fI\%Xournal\fP .SH AUTHOR Martin Ueding .\" Generated by docutils manpage writer. .