mantao/Gnuplot.jl
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Docs updated

Browse Source
This commit is contained in:
Giorgio Calderone 2020-04-15 23:19:30 +02:00
parent 83084913e8
commit 3c06aba985
1 changed files with 6 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
docs/src/options.md
View File

@ -14,7 +14,7 @@ saveas(file) = save(term="pngcairo size 550,350 fontscale 0.8", output="assets/$
## Options
The package options are stored in a global structure available in Julia as `Gnuplot.option` (the type of the structure is [`Gnuplot.Options`](@ref)). The most important settings are as follows:
- `dry::Bool`: if true all new sessions will be started as [Dry sessions](@ref). Default is `false`, but if the package is not able to start a gnuplot it will automatically switch to `true`;
- `dry::Bool`: if true all new sessions will be started as [Dry sessions](@ref). Default is `false`, but if the package is not able to start a gnuplot process it will automatically switch to `true`;
- `init::Vector{String}`: initialization commands to be executed when a new session is created. Default is an empty vector. It can be used to, e.g., set a custom terminal:
```@repl abc
@ -61,8 +61,8 @@ macro gnuplotrc()
return :(
using Gnuplot;
# Uncomment the following if you don't have the gnuplot
# executable installed on your platform
# Uncomment following to true if you don't have the gnuplot
# executable installed on your platform:
#Gnuplot.options.dry = true;
# Uncomment the following and set the proper path if the
@ -70,10 +70,12 @@ macro gnuplotrc()
#Gnuplot.options.cmd = "/path/to/gnuplot";
# Set the default terminal for interacitve use
empty!(Gnuplot.options.init);
push!(Gnuplot.options.init, "set term wxt size 700,400");
# Set the default linetypes
push!(Gnuplot.options.reset, linetypes(:Set1_5, lw=2));
empty!(Gnuplot.options.reset);
push!(Gnuplot.options.reset, linetypes(:Set1_5, lw=1.5, ps=1.5));
# Initialize the gnuplot REPL using the provided `start_key`.
# Comment the following to disable the REPL.