1 |
=head1 Frey Manual |
2 |
|
3 |
This page describes how to use and develop with L<Frey> |
4 |
|
5 |
=head1 Command-line integration |
6 |
|
7 |
One of key points is that L<Frey> runs under your user. This means it has |
8 |
access to your termnial, and ssh keys, so beware! |
9 |
|
10 |
=head1 Install |
11 |
|
12 |
=head2 Firefox |
13 |
|
14 |
Frey is designed to provide close integration between your day-to-day data |
15 |
mungling work in console and Firefox. |
16 |
|
17 |
You might want to open separate Firefox and terminal for Frey sessions. |
18 |
|
19 |
It's also useful to have Firebug extension installed in Firefox to provide |
20 |
quick introspection on html, network traffic and request parameters. |
21 |
|
22 |
If nothing else, L<Frey::Bookmarklet> provides Firebug lite bookmarklet. |
23 |
|
24 |
It's all Text! Firefox extension at |
25 |
L<https://addons.mozilla.org/en-US/firefox/addon/4125> provides integration |
26 |
between form textarea and your editor, so it's also handy. |
27 |
|
28 |
=head2 vim |
29 |
|
30 |
Content on page will be linked to vim using L<Frey::Web/html_links> |
31 |
|
32 |
You might want to install vim plugin C<prel_synwrite.vim> from |
33 |
L<http://www.vim.org/scripts/script.php?script_id=896> |
34 |
to check syntax on every C<:Write> |
35 |
|
36 |
|
37 |
=head2 xdotool |
38 |
|
39 |
Used for switching focus between browser and terminal |
40 |
|
41 |
=head1 Command-line helpers |
42 |
|
43 |
=head2 bin/dev.sh |
44 |
|
45 |
Recommeded way to start development L<Frey> server since it will restart it |
46 |
automatically and kill running instance if existing. |
47 |
|
48 |
=head2 bin/check-syntax.sh |
49 |
|
50 |
Check syntax of modified files. |
51 |
|
52 |
=head2 bin/grep-iselect.sh |
53 |
|
54 |
Helper using C<iselect> to quickly grep, select result and jump to C<vim> |
55 |
|
56 |
=head2 bin/checkout-js.sh |
57 |
|
58 |
Checkout bunch of JavaScript code from all over the net, some of which is |
59 |
used in Frey and rest is kind of TODO list... |
60 |
|
61 |
=head2 bin/clean-var.sh |
62 |
|
63 |
Cleanup C<var/> directory which gets a lot of dumps. Most of useful data |
64 |
is held forever because I belive that trends are most interesting way to |
65 |
look at data. |
66 |
|
67 |
=cut |