lib/Frey/Manual.pod

=head1 Frey Manual

This page describes how to use and develop with L<Frey>

=head1 Install

Frey is designed to provide close integration between your day-to-day data
mungling work in console and Firefox.

You might want to open separate Firefox and terminal for Frey sessions.

It's also useful to have Firebug extension installed in Firefox to provide
quick introspection on html, network traffic and request parameters.

=head1 Command-line integration

One of key points is that L<Frey> runs under your user. This means it has
access to your termnial, and ssh keys, so beware!

On the other hand, this allow nice integration with command-line utlities:

=head2 vim

Content on page will be linked to vim using L<Frey::Web/html_links>

You might want to install vim plugin C<prel_synwrite.vim> from
L<http://www.vim.org/scripts/script.php?script_id=896>
to check syntax on every C<:Write>


=head2 xdotool

Used for switching focus between browser and terminal

=head1 Command-line helpers

=head2 bin/check-syntax.sh

Check syntax of modified files.

=cut
1	dpavlin	693	=head1 Frey Manual
2
3			This page describes how to use and develop with L<Frey>
4
5			=head1 Install
6
7			Frey is designed to provide close integration between your day-to-day data
8			mungling work in console and Firefox.
9
10			You might want to open separate Firefox and terminal for Frey sessions.
11
12			It's also useful to have Firebug extension installed in Firefox to provide
13			quick introspection on html, network traffic and request parameters.
14
15			=head1 Command-line integration
16
17			One of key points is that L<Frey> runs under your user. This means it has
18			access to your termnial, and ssh keys, so beware!
19
20			On the other hand, this allow nice integration with command-line utlities:
21
22			=head2 vim
23
24			Content on page will be linked to vim using L<Frey::Web/html_links>
25
26			You might want to install vim plugin C<prel_synwrite.vim> from
27			L<http://www.vim.org/scripts/script.php?script_id=896>
28			to check syntax on every C<:Write>
29
30
31			=head2 xdotool
32
33			Used for switching focus between browser and terminal
34
35			=head1 Command-line helpers
36
37			=head2 bin/check-syntax.sh
38
39			Check syntax of modified files.
40
41			=cut