1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
|
.TH NOTIONFLUX 1
.SH NAME
Notionflux - lua remote control for Notion.
.SH SYNOPSIS
.B notionflux
.I "[-e code]"
.SH "DESCRIPTION"
.B notionflux
allows you to access the notion lua scripting interface from the
command\-line. It either takes a script from stdin or through the \'\-e\'
parameter.
The lua script will be executed by the Lua engine running in Notion, which
means it has access to the Notion lua api (notioncore.* et al). Calls to
\'print\' will print values to Notion\'s stdout (e.g. ~/.xsession\-errors).
The scripts\' return value will be printed by
.B notionflux
.
.SH "OPTIONS"
.TP
.B \-e code
Lua code to execute.
.SH "ENVIRONMENT"
.B notionflux
talks to
.BR notion (1)
through a socket, which is determined by the
.B _NOTION_MOD_NOTIONFLUX_SOCKET
property on the root of the display on which
.BR notion (1)
is running.
.SH "SECURITY"
The
.B notionflux
socket is created with read/write permissions only for the user who started
.BR notion (1).
Neither
.BR notion (1)
nor
.B notionflux
are
.BR setuid (2),
so
.B notionflux
should not pose any security threat.
.SH "EXAMPLES"
Write \'foo\' to
.BR notion (1)\'s
stdout and \'bar\' to the terminal, specifying the script on the commandline:
.PP
.nf
.RS
$ notionflux \-e "print('foo'); return 'bar'"
"bar"
.RE
.fi
.PP
Or the same, but now via STDIN:
.PP
.nf
.RS
$ echo "print('foo'); return 'bar'" | notionflux
"bar"
.RE
.fi
.PP
.SH SEE ALSO
The Notion home page, \fIhttp://notion.sf.net/\fP
.PP
The document "Configuring and extending Notion with Lua" found on the
Notion home page.
.PP
.I DOCDIR/
.PP
\fIX(7x)\fP, \fInotionflux(1)\fP
.SH AUTHOR
Notionflux was written by the Notion team, based on ionflux which was written by Tuomo Valkonen <tuomov at iki.fi>.
|
