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