man/notionflux.in

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