~ubuntu-branches/ubuntu/wily/apparmor/wily

« back to all changes in this revision

Viewing changes to parser/apparmor.vim.pod

  • Committer: Bazaar Package Importer
  • Author(s): Kees Cook
  • Date: 2011-04-27 10:38:07 UTC
  • mfrom: (5.1.118 natty)
  • Revision ID: james.westby@ubuntu.com-20110427103807-ym3rhwys6o84ith0
Tags: 2.6.1-2
debian/copyright: clarify for some full organization names.

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
# ----------------------------------------------------------------------
 
2
#    Copyright (c) 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007,
 
3
#                  2008, 2009
 
4
#    NOVELL (All rights reserved)
 
5
#
 
6
#    Copyright (c) 2010
 
7
#    Canonical Ltd. (All rights reserved)
 
8
#
 
9
#    This program is free software; you can redistribute it and/or
 
10
#    modify it under the terms of version 2 of the GNU General Public
 
11
#    License published by the Free Software Foundation.
 
12
#
 
13
#    This program is distributed in the hope that it will be useful,
 
14
#    but WITHOUT ANY WARRANTY; without even the implied warranty of
 
15
#    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 
16
#    GNU General Public License for more details.
 
17
#
 
18
#    You should have received a copy of the GNU General Public License
 
19
#    along with this program; if not, contact Novell, Inc.
 
20
# ----------------------------------------------------------------------
 
21
 
 
22
 
 
23
=pod
 
24
 
 
25
=head1 NAME
 
26
 
 
27
apparmor.vim - vim syntax highlighting file for AppArmor profiles
 
28
 
 
29
=head1 SYNOPSIS
 
30
 
 
31
The SUSE vim package is configured to automatically use syntax
 
32
highlighting for AppArmor policies stored in /etc/apparmor.d/ and the
 
33
extra policies stored in /etc/apparmor/profiles/extras/. If you wish to
 
34
use the syntax highlighting in a specific vim session, you may run:
 
35
 
 
36
 :syntax on
 
37
 :setf apparmor
 
38
 
 
39
=head1 DESCRIPTION
 
40
 
 
41
B<apparmor.vim> provides syntax highlighting rules for the vim(1) text
 
42
editor; the rules provide an easy visual method to inspect AppArmor
 
43
profiles for syntax correctness and semantics.
 
44
 
 
45
The colors indicate the relative severity of granting a specific set of
 
46
privileges. Ranking access with colors is necessarily generic and vague,
 
47
but it may help you understand your profiles better.
 
48
 
 
49
=head1 BUGS
 
50
 
 
51
B<apparmor.vim> does not properly detect dark versus light backgrounds.
 
52
Patches accepted. If you find any bugs, please report them at
 
53
L<http://https://bugs.launchpad.net/apparmor/+filebug>.
 
54
 
 
55
=head1 SEE ALSO
 
56
 
 
57
vim(1), apparmor(7), apparmor.d(5), aa_change_hat(2), and
 
58
L<http://wiki.apparmor.net>.
 
59
 
 
60
=cut